Electron Forge

https://www.electronforge.io/
Admin
Electron Forge is an all-in-one tool for packaging and distributing Electron applications, providing...
Tokens:25,316
Snippets:429
Trust Score:9.4
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install Snapcraft Publisher

Source: https://www.electronforge.io/config/publishers/snapcraft.md

Install the Snapcraft publisher package as a development dependency.

```bash
npm install --save-dev @electron-forge/publisher-snapcraft
```

--------------------------------

### Install MSIX Maker

Source: https://www.electronforge.io/config/makers/msix.md

Install the maker package as a development dependency.

```bash
npm install --save-dev @electron-forge/maker-msix
```

--------------------------------

### Install Squirrel.Windows Maker

Source: https://www.electronforge.io/config/makers/squirrel.windows

Install the maker package as a development dependency.

```bash
npm install --save-dev @electron-forge/maker-squirrel
```

--------------------------------

### Install Bitbucket Publisher

Source: https://www.electronforge.io/config/publishers/bitbucket.md

Install the publisher package as a development dependency in your project.

```bash
npm install --save-dev @electron-forge/publisher-bitbucket
```

--------------------------------

### Install GitHub Publisher

Source: https://www.electronforge.io/config/publishers/github.md

Install the GitHub publisher package as a development dependency.

```bash
npm install --save-dev @electron-forge/publisher-github
```

--------------------------------

### Install Squirrel.Windows startup dependency

Source: https://www.electronforge.io/import-existing-project.md

Install the runtime dependency required to handle Squirrel events on Windows.

```bash
cd my-app
npm install electron-squirrel-startup
```

--------------------------------

### Install AppX Maker

Source: https://www.electronforge.io/config/makers/appx.md

Install the maker package as a development dependency in your project.

```bash
npm install --save-dev @electron-forge/maker-appx
```

--------------------------------

### Install GCS Publisher

Source: https://www.electronforge.io/config/publishers/gcs.md

Install the publisher package as a development dependency.

```bash
npm install --save-dev @electron-forge/publisher-gcs
```

--------------------------------

### Install ZIP Maker

Source: https://www.electronforge.io/config/makers/zip.md

Install the package as a development dependency.

```bash
npm install --save-dev @electron-forge/maker-zip
```

--------------------------------

### Start the development application

Source: https://www.electronforge.io/

Navigate to the project directory and launch the application in development mode.

```bash
cd my-app
npm start
```

--------------------------------

### Starting Development Mode

Source: https://www.electronforge.io/cli.md

Launches the application in development mode with logging enabled.

```bash
# By default, the start command corresponds to a start npm script:
npm start --enable-logging
# if there is no start script
npx electron-forge start --enable-logging
```

--------------------------------

### Install DMG Maker

Source: https://www.electronforge.io/config/makers/dmg.md

Install the maker package as a development dependency.

```sh
npm install --save-dev @electron-forge/maker-dmg
```

--------------------------------

### Install Nucleus Publisher

Source: https://www.electronforge.io/config/publishers/nucleus.md

Install the Nucleus publisher package as a development dependency.

```bash
npm install --save-dev @electron-forge/publisher-nucleus
```

--------------------------------

### Install S3 Publisher

Source: https://www.electronforge.io/config/publishers/s3.md

Install the S3 publisher package as a development dependency.

```bash
npm install --save-dev @electron-forge/publisher-s3
```

--------------------------------

### Install Electron Release Server Publisher

Source: https://www.electronforge.io/config/publishers/electron-release-server.md

Install the publisher package as a development dependency.

```bash
npm install --save-dev @electron-forge/publisher-electron-release-server
```

--------------------------------

### Install Vite Plugin

Source: https://www.electronforge.io/config/plugins/vite.md

Install the Vite plugin as a development dependency.

```shell
npm install --save-dev @electron-forge/plugin-vite
```

--------------------------------

### Configure installation scripts

Source: https://www.electronforge.io/config/makers/pkg.md

Point the scripts property to a directory containing executable preinstall and postinstall files.

```javascript
const path = require('node:path');

module.exports = {
  makers: [
    {
      name: '@electron-forge/maker-pkg',
      config: {
        scripts: path.join(__dirname, 'scripts')
      }
    }
  ]
};
```

--------------------------------

### Install React runtime dependencies

Source: https://www.electronforge.io/guides/framework-integration/react.md

Install the core React and React DOM packages for your application.

```bash
npm install --save react react-dom
```

--------------------------------

### Build distributables

Source: https://www.electronforge.io/

Generate platform-specific installers and packages for the application.

```bash
npm run make
```

--------------------------------

### RELEASES.json Manifest Example

Source: https://www.electronforge.io/config/makers/zip.md

Example structure of the architecture-specific manifest generated for auto-updates.

```json
{
  "currentRelease": "1.2.1",
  "releases": [
    {
      "version": "1.2.1",
      "updateTo": {
        "version": "1.2.1",
        "pub_date": "2013-09-18T12:29:53+01:00",
        "name": "my-app v1.2.1",
        "url": "https://my-bucket.s3.amazonaws.com/my-app-updates/darwin/arm64/my-app-1.2.1-darwin-arm64.zip"
      }
    }
  ]
}
```

--------------------------------

### Install Flatpak maker

Source: https://www.electronforge.io/config/makers/flatpak.md

Installs the Flatpak maker package as a development dependency.

```sh
npm install --save-dev @electron-forge/maker-flatpak
```

--------------------------------

### Install Snapcraft Maker

Source: https://www.electronforge.io/config/makers/snapcraft.md

Add the Snapcraft maker package to your project as a development dependency.

```bash
npm install --save-dev @electron-forge/maker-snap
```

--------------------------------

### Install React dependencies

Source: https://www.electronforge.io/guides/framework-integration/react-with-typescript.md

Install the core React libraries and their corresponding TypeScript type definitions.

```bash
npm install --save react react-dom
npm install --save-dev @types/react @types/react-dom
```

--------------------------------

### Install the RPM maker package

Source: https://www.electronforge.io/config/makers/rpm.md

Add the maker to your project as a development dependency.

```shell
npm install --save-dev @electron-forge/maker-rpm
```

--------------------------------

### postStart

Source: https://www.electronforge.io/config/hooks.md

Called after Forge's start command launches the app in dev mode.

```APIDOC
## postStart(config, appProcess)

### Description
Called after Forge's start command launches the app in dev mode. Use this to attach listeners to the spawned child process.

### Parameters
- **config** (ResolvedForgeConfig) - Required - Forge configuration object
- **appProcess** (ChildProcess) - Required - Node.js child process instance

### Returns
- **Promise<void>**
```

--------------------------------

### Install Maker PKG dependency

Source: https://www.electronforge.io/config/makers/pkg.md

Install the maker package as a development dependency.

```bash
npm install --save-dev @electron-forge/maker-pkg
```

--------------------------------

### Install Electronegativity Plugin

Source: https://www.electronforge.io/config/plugins/electronegativity.md

Add the plugin as a development dependency to your project.

```shell
npm install --save-dev @electron-forge/plugin-electronegativity
```

--------------------------------

### preStart

Source: https://www.electronforge.io/config/hooks.md

Invoked before Forge's start command launches the app in dev mode.

```APIDOC
## preStart(config)

### Description
Invoked before Forge's start command launches the app in dev mode. Use this to run preparatory logic.

### Parameters
- **config** (ResolvedForgeConfig) - Required - Forge configuration object

### Returns
- **Promise<void>**
```

--------------------------------

### Install React development dependencies

Source: https://www.electronforge.io/guides/framework-integration/react.md

Install the required Babel packages to enable JSX support in the Webpack template.

```bash
npm install --save-dev @babel/core @babel/preset-react babel-loader
```

--------------------------------

### Install Local Electron Plugin

Source: https://www.electronforge.io/config/plugins/local-electron.md

Add the plugin as a development dependency to your project.

```bash
npm install --save-dev @electron-forge/plugin-local-electron
```

--------------------------------

### Install WiX Toolset via Chocolatey

Source: https://www.electronforge.io/config/makers/wix-msi.md

Install the required WiX Toolset v3 on Windows using the Chocolatey package manager.

```bash
choco install wixtoolset  --version=3.14.0
```

--------------------------------

### Install native module loaders

Source: https://www.electronforge.io/config/plugins/webpack.md

Install the required loaders for native Node module support as development dependencies.

```bash
npm install --save-dev node-loader @vercel/webpack-asset-relocator-loader@1.7.3
```

--------------------------------

### Install Electron Forge CLI

Source: https://www.electronforge.io/cli.md

Add the CLI as a development dependency to your project.

```bash
npm install --save-dev @electron-forge/cli
```

--------------------------------

### Install Auto Unpack Natives Plugin

Source: https://www.electronforge.io/config/plugins/auto-unpack-natives.md

Install the plugin as a development dependency using npm.

```shell
npm install --save-dev @electron-forge/plugin-auto-unpack-natives
```

--------------------------------

### Verify installed code signing certificates

Source: https://www.electronforge.io/guides/code-signing/code-signing-macos.md

Use this command in the terminal to list all available code signing certificates installed on your machine.

```shell
security find-identity -p codesigning -v
```

--------------------------------

### Install Fuses Plugin and Dependencies

Source: https://www.electronforge.io/config/plugins/fuses.md

Install the plugin and the required @electron/fuses peer dependency via npm.

```shell
npm install --save-dev @electron-forge/plugin-fuses @electron/fuses
```

--------------------------------

### Query Documentation API

Source: https://www.electronforge.io/configuration

Use this GET request to ask specific questions about the documentation. The 'ask' parameter is required for your question, and the optional 'goal' parameter helps tailor the response.

```http
GET https://www.electronforge.io/config/configuration.md?ask=<question>&goal=<end_goal>
```

--------------------------------

### Install Forge dependencies manually

Source: https://www.electronforge.io/import-existing-project.md

Install the Forge CLI and required Maker packages as development dependencies.

```bash
cd my-app
npm install --save-dev @electron-forge/cli @electron-forge/maker-squirrel @electron-forge/maker-deb @electron-forge/maker-zip
```

--------------------------------

### Install RPM build dependencies on Fedora

Source: https://www.electronforge.io/config/makers/rpm.md

Install the necessary rpm-build package on Fedora-based systems.

```shell
sudo dnf install rpm-build
```

--------------------------------

### Install Vue 3 dependencies

Source: https://www.electronforge.io/guides/framework-integration/vue-3.md

Add the Vue framework and the Vite plugin for Vue to the project.

```bash
npm install vue
npm install --save-dev @vitejs/plugin-vue
```

--------------------------------

### Handle Squirrel Startup Events

Source: https://www.electronforge.io/config/makers/squirrel.windows

Use the electron-squirrel-startup module to prevent multiple app launches during installation or update events.

```javascript
const { app } = require('electron');

// run this as early in the main process as possible
if (require('electron-squirrel-startup')) app.quit();
```

--------------------------------

### Install Webpack Plugin

Source: https://www.electronforge.io/config/plugins/webpack.md

Use this command to add the Webpack plugin as a development dependency to your project.

```shell
npm install --save-dev @electron-forge/plugin-webpack
```

--------------------------------

### Configure S3 Publisher in forge.config.js

Source: https://www.electronforge.io/config/publishers.md

Example configuration for the S3 publisher, specifying the target platforms and bucket details.

```javascript
module.exports = {
  publishers: [
    {
      name: '@electron-forge/publisher-s3',
      platforms: ['darwin', 'linux'],
      config: {
        bucket: 'my-bucket',
        folder: 'my/key/prefix'
      }
    }
  ]
};
```

--------------------------------

### Install RPM build dependencies on Debian or Ubuntu

Source: https://www.electronforge.io/config/makers/rpm.md

Install the necessary rpm package on Debian or Ubuntu-based systems.

```shell
sudo apt-get install rpm
```

--------------------------------

### Implementing startLogic in a Plugin

Source: https://www.electronforge.io/advanced/extending-electron-forge/writing-plugins.md

Overrides or supplements the default start logic during development by implementing the startLogic method.

```javascript
export default class MyPlugin extends Pluginbase {
  async startLogic (opts) {
    await this.compileMainProcess();
    return null;
  }

  compileMainProcess () { /* ... */ }
}
```

--------------------------------

### High-DPI Image Directory Structure

Source: https://www.electronforge.io/guides/create-and-add-icons.md

Example directory structure for supporting multiple DPI densities using standard filename suffixes.

```text
images/
├── icon.png
├── icon@2x.png
└── icon@3x.png
```

--------------------------------

### Install WiX Maker Dependency

Source: https://www.electronforge.io/config/makers/wix-msi.md

Add the WiX maker package to your project's development dependencies.

```bash
npm install --save-dev @electron-forge/maker-wix
```

--------------------------------

### Initialize a new Electron project

Source: https://www.electronforge.io/

Scaffold a new project using the create-electron-app wrapper.

```bash
npx create-electron-app@latest my-app
```

--------------------------------

### Initialize a new project with a template

Source: https://www.electronforge.io/cli.md

Initialize a new Forge-powered application using a specific template.

```bash
npx electron-forge init --template=webpack
```

--------------------------------

### Initialize a project with a template

Source: https://www.electronforge.io/

Use the --template flag to scaffold a project with specific build tools like Webpack or Vite.

```bash
npx create-electron-app@latest my-app --template=webpack
```

--------------------------------

### Initialize Electron Forge project with Vite template

Source: https://www.electronforge.io/guides/framework-integration/vue-3.md

Use the create-electron-app command to scaffold a new project configured for Vite.

```bash
npx create-electron-app@latest my-vue-app --template=vite
```

--------------------------------

### Initialize React component and renderer entry

Source: https://www.electronforge.io/guides/framework-integration/react.md

Create a React root in your app file and import it into your renderer entry point.

```jsx
import * as React from 'react';
import { createRoot } from 'react-dom/client';

const root = createRoot(document.body);
root.render(<h2>Hello from React!</h2>);
```

```javascript
// Add this to the end of the existing file
import './app.jsx';
```

--------------------------------

### Initialize Electron project with Webpack template

Source: https://www.electronforge.io/templates/webpack-template.md

Use this command to create a new Electron application pre-configured with the Webpack bundler.

```bash
npx create-electron-app@latest my-new-app --template=webpack
```

--------------------------------

### Publish the application

Source: https://www.electronforge.io/

Upload the generated distributables using the configured publishing method.

```bash
npm run publish
```

--------------------------------

### Import an existing project

Source: https://www.electronforge.io/cli.md

Make an existing Electron application compatible with Forge.

```bash
npx electron-forge import
```

--------------------------------

### Building Windows distributables from WSL

Source: https://www.electronforge.io/guides/developing-with-wsl.md

Specify the target platform when running the make command to generate Windows bundles.

```bash
npm run make -- --platform=win32
```

--------------------------------

### Initialize Electron App with Webpack and TypeScript

Source: https://www.electronforge.io/templates/typescript-%2B-webpack-template.md

Use this command to scaffold a new Electron project with the webpack-typescript template.

```bash
npx create-electron-app@latest my-new-app --template=webpack-typescript
```

--------------------------------

### Configure a basic preload script

Source: https://www.electronforge.io/config/plugins/webpack.md

Attach a preload script to a window entry point by defining the preload key within the entry configuration.

```javascript
{
  name: 'main_window',
  html: './src/renderer/index.html',
  js: './src/renderer/index.js',
  preload: {
    js: './src/preload.js'
  }
}
```

--------------------------------

### Initialize Squirrel.Windows in main process

Source: https://www.electronforge.io/import-existing-project.md

Add this check to your main process file before the app.ready event to handle Squirrel lifecycle events.

```javascript
if (require('electron-squirrel-startup')) app.quit();
```

--------------------------------

### Initialize React component and renderer entry

Source: https://www.electronforge.io/guides/framework-integration/react-with-typescript.md

Create a React root component and import it into the main renderer entry file.

```tsx
import React from 'react';
import { createRoot } from 'react-dom/client';

const root = createRoot(document.body);
root.render(<h2>Hello from React!</h2>);
```

```typescript
// Add this to the end of the existing file
import './app';
```

--------------------------------

### Bootstrap with specific package manager

Source: https://www.electronforge.io/cli.md

Use the NODE_INSTALLER environment variable to specify the package manager during bootstrapping.

```sh
NODE_INSTALLER=npm npx create-electron-app my-app-dir
```

--------------------------------

### Install deb maker dependency

Source: https://www.electronforge.io/config/makers/deb.md

Add the maker package to your project's development dependencies.

```bash
npm install --save-dev @electron-forge/maker-deb
```

--------------------------------

### generateAssets

Source: https://www.electronforge.io/config/hooks.md

Invoked before Forge's start or package commands to generate static files or resources.

```APIDOC
## generateAssets(config, platform, arch)

### Description
Invoked before Forge's start or package commands. Use this to generate static files or resources required at runtime.

### Parameters
- **config** (ResolvedForgeConfig) - Required - Forge configuration object
- **platform** (string) - Required - Operating system platform
- **arch** (string) - Required - CPU architecture

### Returns
- **Promise<void>**
```

--------------------------------

### Package an Electron application

Source: https://www.electronforge.io/cli.md

Use these commands to package the application into a platform-specific bundle. Ensure node_modules are present on disk as symlinks and PnP are not supported.

```bash
# By default, the package command corresponds to a package npm script:
npm run package -- --arch="ia32"
# If there is no package script:
npx electron-forge package --arch="ia32"
```

--------------------------------

### Create windowsSign configuration file

Source: https://www.electronforge.io/guides/code-signing/code-signing-windows.md

Define the signing options using environment variables. This file is imported into the Forge configuration.

```typescript
import type { WindowsSignOptions } from "@electron/packager";
import type { HASHES } from "@electron/windows-sign/dist/esm/types";

export const windowsSign: WindowsSignOptions = {
  ...(process.env.SIGNTOOL_PATH
    ? { signToolPath: process.env.SIGNTOOL_PATH }
    : {}),
  signWithParams: `/v /debug /dlib ${process.env.AZURE_CODE_SIGNING_DLIB} /dmdf ${process.env.AZURE_METADATA_JSON}`,
  timestampServer: "http://timestamp.acs.microsoft.com",
  hashes: ["sha256" as HASHES],
};
```

--------------------------------

### Implementing the make method

Source: https://www.electronforge.io/advanced/extending-electron-forge/writing-makers.md

Defines the artifact generation logic, returning an array of absolute paths to the created files.

```javascript
export default class MyMaker extends MakerBase {
  async make (opts) {
    const pathToMagicInstaller = await makeMagicInstaller(opts.dir);
    return [pathToMagicInstaller];
  }
}
```

--------------------------------

### Import an existing project using the CLI

Source: https://www.electronforge.io/import-existing-project.md

Use the Forge import command to automatically migrate an existing Electron project to the Forge workflow.

```shell
cd my-app
npm install --save-dev @electron-forge/cli
npm exec --package=@electron-forge/cli -c "electron-forge import"
```

--------------------------------

### Programmatic API Usage

Source: https://www.electronforge.io/cli.md

Demonstrates how to use the @electron-forge/core package to execute commands programmatically.

```javascript
const { api } = require('@electron-forge/core');

const main = async () => {
  await api.package({
    // add package command options here
  });
};

main();
```

--------------------------------

### Mount Vue application in renderer

Source: https://www.electronforge.io/guides/framework-integration/vue-3.md

Initialize the Vue application and mount it to the DOM element with the id 'app'.

```javascript
import { createApp } from 'vue';
import App from './App.vue';

createApp(App).mount('#app');
```

--------------------------------

### Configure Squirrel.Windows Maker

Source: https://www.electronforge.io/config/makers/squirrel.windows

Add the maker to the Forge configuration file with required certificate settings.

```javascript
module.exports = {
  makers: [
    {
      name: '@electron-forge/maker-squirrel',
      config: {
        certificateFile: './cert.pfx',
        certificatePassword: process.env.CERTIFICATE_PASSWORD
      }
    }
  ]
};
```

--------------------------------

### Configure HTML entry point

Source: https://www.electronforge.io/guides/framework-integration/vue-3.md

Update the main HTML file to include a root element for the Vue application.

```html
<!DOCTYPE html>
<html>
  <head>
    <meta charset="UTF-8" />
    <title>Hello World!</title>
  </head>
  <body>
    <div id="app"></div>
    <script type="module" src="/src/renderer.js"></script>
  </body>
</html>
```

--------------------------------

### Make distributables for an Electron application

Source: https://www.electronforge.io/cli.md

Use these commands to generate distributable formats based on the Forge configuration. The --skip-package flag can be used to avoid redundant packaging steps.

```bash
# By default, the make command corresponds to a make npm script:
npm run make -- --arch="ia32"
# If there is no make script:
npx electron-forge make --arch="ia32"
```

```bash
npm run make -- --arch="ia32,x64"
```

--------------------------------

### Initialize AutoUpdater in Main Process

Source: https://www.electronforge.io/config/publishers/s3.md

Configure the update-electron-app module in the main process to point to the S3 bucket.

```javascript
const { updateElectronApp, UpdateSourceType } = require('update-electron-app');

updateElectronApp({
  updateSource: {
    type: UpdateSourceType.StaticStorage,
    baseUrl: `https://my-bucket.s3.amazonaws.com/my-app-updates/${process.platform}/${process.arch}`
  }
});
```

--------------------------------

### Enable Node Integration in Main Process

Source: https://www.electronforge.io/config/plugins/webpack.md

Configure the BrowserWindow to allow Node.js access in the renderer process by setting contextIsolation and nodeIntegration.

```javascript
const win = new BrowserWindow({
  webPreferences: {
    contextIsolation: false,
    nodeIntegration: true
  }
});
```

--------------------------------

### prePackage

Source: https://www.electronforge.io/config/hooks.md

Called before Forge runs Electron Packager in the package step.

```APIDOC
## prePackage(config, platform, arch)

### Description
Called before Forge runs Electron Packager in the package step.

### Parameters
- **config** (ResolvedForgeConfig) - Required - Forge configuration object
- **platform** (string) - Required - Operating system platform
- **arch** (string) - Required - CPU architecture

### Returns
- **Promise<void>**
```

--------------------------------

### Define Azure Trusted Signing environment variables

Source: https://www.electronforge.io/guides/code-signing/code-signing-windows.md

Create this file in the project root to store credentials and paths. Ensure paths do not contain spaces to avoid signing failures.

```text
AZURE_CLIENT_ID='xxx'
AZURE_CLIENT_SECRET='xxx'
AZURE_TENANT_ID='xxx'
AZURE_METADATA_JSON='C:\path\to\metadata.json'
AZURE_CODE_SIGNING_DLIB='C:\path\to\bin\x64\Azure.CodeSigning.Dlib.dll'
SIGNTOOL_PATH='C:\Program Files (x86)\Windows Kits\10\bin\10.0.26100.0\x64\signtool.exe'
```

--------------------------------

### Configure Electron Packager settings

Source: https://www.electronforge.io/config/configuration.md

Customizing the bundling process by mapping options directly to the Electron Packager API.

```javascript
module.exports = {
  packagerConfig: {
    name: 'My Electron App',
    asar: true,
    osxSign: {},
    appCategoryType: 'public.app-category.developer-tools'
  }
};
```

--------------------------------

### Define postStart hook in forge.config.js

Source: https://www.electronforge.io/config/hooks.md

Executes logic after the application has launched, providing access to the child process instance.

```javascript
module.exports = {
  hooks: {
    postStart: async (forgeConfig, appProcess) => {
      console.log(`Spawned child pid: ${appProcess.pid}`);
    }
  }
};
```

--------------------------------

### Access notarytool documentation

Source: https://www.electronforge.io/guides/code-signing/code-signing-macos.md

View the manual page for the notarytool command-line utility.

```bash
man notarytool
```

--------------------------------

### Update npm scripts for environment loading

Source: https://www.electronforge.io/guides/code-signing/code-signing-windows.md

Prefix build and publish commands with dotenv to load the signing configuration.

```json
{
  "scripts": {
    "make": "dotenv -e .env.trustedsigning -- electron-forge make",
    "publish": "dotenv -e .env.trustedsigning -- electron-forge publish"
  }
}
```

--------------------------------

### Reinstalling Electron for Windows platform in WSL

Source: https://www.electronforge.io/guides/developing-with-wsl.md

Remove existing Linux-based node_modules and reinstall dependencies targeting the Windows platform.

```bash
# If node_modules exists already that was installed in WSL:

rm -r node_modules

# then:

npm install --platform=win32

# or:

npm_config_platform=win32 npm install
```

--------------------------------

### Configure package.json scripts

Source: https://www.electronforge.io/import-existing-project.md

Add the standard Forge lifecycle scripts to your package.json file.

```json
{
  // ...
  "scripts": {
    "start": "electron-forge start",
    "package": "electron-forge package",
    "make": "electron-forge make",
    "publish": "electron-forge publish"
  }
  // ... 
}
```

--------------------------------

### Configure Auto-Updating from S3

Source: https://www.electronforge.io/config/publishers/s3.md

Configure makers and publishers to support auto-updates via S3 static storage.

```javascript
module.exports = {
  // ...
  makers: [
    {
      name: '@electron-forge/maker-zip',
      config: (arch) => ({
        // Note that we must provide this S3 URL here
        // in order to support smooth version transitions
        // especially when using a CDN to front your updates
        macUpdateManifestBaseUrl: `https://my-bucket.s3.amazonaws.com/my-app-updates/darwin/${arch}`
      })
    },
    {
      name: '@electron-forge/maker-squirrel',
      config: (arch) => ({
        // Note that we must provide this S3 URL here
        // in order to generate delta updates
        remoteReleases: `https://my-bucket.s3.amazonaws.com/my-app-updates/win32/${arch}`
      })
    }
  ],
  publishers: [
    {
      name: '@electron-forge/publisher-s3',
      config: {
        bucket: 'my-bucket',
        public: true
      }
    }
  ]
};
```

--------------------------------

### Configure Local Electron Plugin

Source: https://www.electronforge.io/config/plugins/local-electron.md

Define the plugin in your forge configuration with an absolute path to the local Electron binary.

```javascript
{
  plugins: [
    {
      name: '@electron-forge/plugin-local-electron',
      config: {
        electronPath: '/Users/me/projects/electron/out/Testing'
      }
    }
  ]
}
```

--------------------------------

### Implement a Custom Publisher Class

Source: https://www.electronforge.io/advanced/extending-electron-forge/writing-publishers.md

Define a custom publisher by extending PublisherBase and implementing the publish method to iterate through make results.

```javascript
export default class MyPublisher extends PublisherBase {
  async publish (opts) {
    for (const result of opts.makeResults) {
      await createVersionIfNotExists();
      await uploadDistributable(result);
    }
  }
}
```

--------------------------------

### Configure a preload-only entry point

Source: https://www.electronforge.io/config/plugins/webpack.md

Define a standalone entry point with nodeIntegration enabled to provide full Node.js access specifically for a preload script.

```javascript
{
  name: 'main_window_preload',
  nodeIntegration: true,
  preload: {
    js: './src/preload.js'
  }
}
```

--------------------------------

### Configure Windows icon path

Source: https://www.electronforge.io/guides/create-and-add-icons.md

Set the icon path in packagerConfig without a file extension, as Electron Packager appends the correct platform extension automatically.

```javascript
module.exports = {
  // ...
  packagerConfig: {
    icon: '/path/to/icon' // no file extension required
  }
  // ...
};
```

--------------------------------

### Define full Electron Forge configuration options

Source: https://www.electronforge.io/config/configuration.md

Comprehensive configuration object showing available top-level properties for customizing the build process.

```javascript
module.exports = {
  packagerConfig: { /* ... */ },
  rebuildConfig: { /* ... */ },
  makers: [],
  publishers: [],
  plugins: [],
  hooks: { /* ... */ },
  buildIdentifier: 'my-build',
  outDir: 'desired/outpath'
};
```

```json
// Only the relevant section of package.json is shown, for brevity.
{
  "config": {
    "forge": {
      "packagerConfig": { ... },
      "rebuildConfig": { ... },
      "makers": [ ... ],
      "publishers": [ ... ],
      "plugins": [ ... ],
      "hooks": { ... },
      "buildIdentifier": "my-build",
      "outDir": "desired/outpath"
    }
  }
}
```

--------------------------------

### Enable macOS Code Signing

Source: https://www.electronforge.io/guides/code-signing/code-signing-macos.md

Initialize the osxSign configuration object within the packagerConfig to enable code signing.

```javascript
module.exports = {
  packagerConfig: {
    osxSign: {} // object must exist even if empty
  }
};
```

--------------------------------

### Configure Bitbucket Publisher

Source: https://www.electronforge.io/config/publishers/bitbucket.md

Add the publisher to the publishers array in your Forge configuration file, providing repository details and authentication credentials.

```javascript
module.exports = {
  // ...
  publishers: [
    {
      name: '@electron-forge/publisher-bitbucket',
      config: {
        repository: {
          owner: 'myusername',
          name: 'myreponame'
        },
        auth: {
          username: process.env.BITBUCKET_USERNAME, // string
          appPassword: process.env.BITBUCKET_APP_PASSWORD // string
        }
      }
    }
  ]
};
```

--------------------------------

### Define preStart hook in forge.config.js

Source: https://www.electronforge.io/config/hooks.md

Executes logic before the application launches in development mode.

```javascript
module.exports = {
  hooks: {
    preStart: async (forgeConfig) => {
      console.log(`Starting up app on platform: ${process.platform}`);
    }
  }
};
```

--------------------------------

### Configure Linux icon paths

Source: https://www.electronforge.io/guides/create-and-add-icons.md

Define the icon path in the Forge configuration makers and load it within the BrowserWindow options in the main process.

```javascript
module.exports = {
  // ...
  makers: [
    {
      name: '@electron-forge/maker-deb',
        config: {
          options: {
            icon: '/path/to/icon.png'
          }
      }
    }
  ]
  // ...
}
```

```javascript
const { BrowserWindow } = require('electron')

const win = new BrowserWindow({
  // ...
  icon: '/path/to/icon.png'
})
```

--------------------------------

### Configure S3 publisher in package.json

Source: https://www.electronforge.io/import-existing-project.md

Add the publisher configuration to the Forge settings in package.json.

```json
{
  // ...
  "config": {
    "forge": {
      "packagerConfig": {},
      "makers": [ /* ... */],
      "publishers": [
        {
        "name": "@electron-forge/publisher-s3",
        "platforms": ["darwin", "linux"],
          "config": {
            "bucket": "my-bucket",
            "folder": "my/key/prefix"
          }
        }
      ]
    }
  }
  // ...
}
```

--------------------------------

### Implementing isSupportedOnCurrentPlatform

Source: https://www.electronforge.io/advanced/extending-electron-forge/writing-makers.md

Defines the platform compatibility check for a custom maker.

```javascript
export default class MyMaker extends MakerBase {
  isSupportedOnCurrentPlatform () {
    return process.platform === 'linux' && this.isFakeRootInstalled();
  }

  isFakeRootInstalled () { /* ... */ }
}
```

--------------------------------

### Define Mandatory Metadata in package.json

Source: https://www.electronforge.io/config/makers/squirrel.windows

Specify author and description fields in package.json for the Squirrel.Windows maker.

```jsonc
{
  // ...
  "author": "Alice and Bob",
  "description": "An example Electron app"
  // ...
}
```

--------------------------------

### Configure VS Code Debugging

Source: https://www.electronforge.io/advanced/debugging.md

Add this configuration to .vscode/launch.json to enable debugging the main process within VS Code.

```json5
{
  "configurations": [
    {
      "type": "node",
      "request": "launch",
      "name": "Electron Main",
      "runtimeExecutable": "${workspaceFolder}/node_modules/@electron-forge/cli/script/vscode.sh",
      "windows": {
        "runtimeExecutable": "${workspaceFolder}/node_modules/@electron-forge/cli/script/vscode.cmd"
      },
      // runtimeArgs will be passed directly to your Electron application
      "runtimeArgs": [
        "foo",
        "bar"
      ],
      "cwd": "${workspaceFolder}",
      "console": "integratedTerminal"
    }
  ]
}
```

--------------------------------

### Configure App Name with Spaces

Source: https://www.electronforge.io/config/makers/squirrel.windows

Handle application names with spaces by using a hyphenated name in package.json and a camel-cased name in the maker config.

```json5
{
  // Hyphenated version
  "name": "app-name",
  // The app name with spaces (will be shown to your users)
  "productName": "App Name",
  // ...
}
```

--------------------------------

### Configure Electron Release Server in Forge

Source: https://www.electronforge.io/config/publishers/electron-release-server.md

Add the publisher to the publishers array in your forge.config.js file.

```javascript
module.exports = {
  // ...
  publishers: [
    {
      name: '@electron-forge/publisher-electron-release-server',
      config: {
        baseUrl: 'https://update.server.com',
        username: 'admin',
        password: process.env.PASSWORD // string
      }
    }
  ]
};
```

--------------------------------

### Enable Auto-Updating from GitHub

Source: https://www.electronforge.io/config/publishers/github.md

Initialize the update-electron-app module in your application's main process.

```javascript
const { updateElectronApp } = require('update-electron-app');
updateElectronApp(); // additional configuration options available
```

--------------------------------

### Publishing with Dry Run

Source: https://www.electronforge.io/cli.md

Executes the publish command using previously saved dry run artifacts.

```bash
# By default, the publish command corresponds to a publish npm script:
npm run publish -- --from-dry-run
# If there is no publish script:
npx electron-forge publish -- --from-dry-run
```

--------------------------------

### Configure Maker PKG in Forge

Source: https://www.electronforge.io/config/makers/pkg.md

Add the maker to the makers array in the Forge configuration file.

```javascript
module.exports = {
  makers: [
    {
      name: '@electron-forge/maker-pkg',
      config: {
        keychain: 'my-secret-ci-keychain'
        // other configuration options
      }
    }
  ]
};
```

--------------------------------

### Configure Snapcraft Publisher

Source: https://www.electronforge.io/config/publishers/snapcraft.md

Add the Snapcraft publisher to the publishers array in the Forge configuration file.

```javascript
module.exports = {
  // ...
  publishers: [
    {
      name: '@electron-forge/publisher-snapcraft',
      config: {
        release: '[latest/edge, insider/stable]'
      }
    }
  ]
};
```

--------------------------------

### Configure MSIX Maker

Source: https://www.electronforge.io/config/makers/msix.md

Add the maker to the makers array in forge.config.js with required manifest and signing options.

```javascript
module.exports = {
  makers: [
    {
      name: '@electron-forge/maker-msix',
      config: {
        manifestVariables: {
          publisher: 'Electron Dev'
        },
        windowsSignOptions: {
          certificateFile: 'C:\\devcert.pfx',
          certificatePassword: '122345'
        }
      }
    }
  ]
};
```
Tokens:
Raw