Options

Options

In the development package.json custom build field can be specified to customize format:

"build": {
  "osx": {
    "contents": [
      {
        "x": 410,
        "y": 220,
        "type": "link",
        "path": "/Applications"
      },
      {
        "x": 130,
        "y": 220,
        "type": "file",
        "path": "computed path to artifact, do not specify it - will be overwritten"
      }
    ]
  }
}

As you can see, you need to customize OS X options only if you want to provide custom x, y. Don't customize paths to background and icon, — just follow conventions.

Here documented only electron-builder specific options:

Application package.json

Name	Description
name	The application name.
productName	As name, but allows you to specify a product name for your executable which contains spaces and other special characters not allowed in the name property.
description	The application description.
homepage	The url to the project homepage (NuGet Package projectUrl (optional) or Linux Package URL (required)). If not specified and your project repository is public on GitHub, it will be https://github.com/${user}/${project} by default.
license	linux-only. The license name.

Development package.json

Name	Description
build	See .build.
directories	See .directories

.build

Name	Description
app-bundle-id	OS X-only. The app bundle ID. See CFBundleIdentifier.
app-category-type	OS X-only. The application category type, as shown in the Finder via View -> Arrange by Application Category when viewing the Applications directory. For example, app-category-type=public.app-category.developer-tools will set the application category to Developer Tools. Valid values are listed in Apple’s documentation.
asar	Whether to package the application’s source code into an archive, using Electron’s archive format. Defaults to true. Reasons why you may want to disable this feature are described in an application packaging tutorial in Electron’s documentation.
productName	See AppMetadata.productName.
extraResources	A glob expression, when specified, copy the file or directory with matching names directly into the app’s directory (Contents/Resources for OS X). You can use ${os} (expanded to osx, linux or win according to current platform) and ${arch} in the pattern. If directory matched, all contents are copied. So, you can just specify foo to copy <project_dir>/foo directory. May be specified in the platform options (i.e. in the build.osx).
osx	See .build.osx.
mas	See .build.mas.
win	See .build.win.
linux	See .build.linux.
compression	The compression level, one of store, normal, maximum (default: normal). If you want to rapidly test build, store can reduce build time significantly.
afterPack	programmatic API only The function to be run after pack (but before pack into distributable format and sign). Promise must be returned.

.build.osx

See all appdmg options.

Name	Description
icon	The path to icon, which will be shown when mounted (default: build/icon.icns).
background	The path to background (default: build/background.png if exists). The resolution of this file determines the resolution of the installer window. If background is not specified, use window.size, see specification.
target	Target package type: list of default, dmg, zip, mas, 7z, tar.xz, tar.gz, tar.bz2, tar.7z. Defaults to default (dmg and zip for Squirrel.Mac).
identity	The name of certificate to use when signing. Consider using environment variables CSC_LINK or CSC_NAME. MAS installer identity is specified in the .build.mas.
entitlements	The path to entitlements file for signing the app. build/osx.entitlements will be used if exists (it is a recommended way to set). MAS entitlements is specified in the .build.mas.
entitlementsInherit	The path to child entitlements which inherit the security settings for signing frameworks and bundles of a distribution. build/osx.inherit.entitlements will be used if exists (it is a recommended way to set). Otherwise default. This option only applies when signing with entitlements provided.

.build.mas

MAS (Mac Application Store) specific options (in addition to build.osx).

Name	Description
identity	The name of certificate to use when signing. Consider using environment variables CSC_INSTALLER_LINK or CSC_INSTALLER_NAME.
entitlements	The path to entitlements file for signing the app. build/mas.entitlements will be used if exists (it is a recommended way to set). Otherwise default.
entitlementsInherit	The path to child entitlements which inherit the security settings for signing frameworks and bundles of a distribution. build/mas.inherit.entitlements will be used if exists (it is a recommended way to set). Otherwise default.

.build.win

Name	Description
iconUrl	A URL to an ICO file to use as the application icon (displayed in Control Panel > Programs and Features). Defaults to the Electron icon. Please note — local icon file url is not accepted, must be https/http. If you don’t plan to build windows installer, you can omit it. If your project repository is public on GitHub, it will be https://github.com/${u}/${p}/blob/master/build/icon.ico?raw=true by default.
loadingGif	The path to a .gif file to display during install. build/install-spinner.gif will be used if exists (it is a recommended way to set) (otherwise default).
msi	Whether to create an MSI installer. Defaults to false (MSI is not created).
remoteReleases	A URL to your existing updates. If given, these will be downloaded to create delta updates.
remoteToken	Authentication token for remote updates

.build.linux

Name	Description
description	As description from application package.json, but allows you to specify different for Linux.
synopsis	deb-only. The short description.
maintainer	The maintainer. Defaults to author.
vendor	The vendor. Defaults to author.
compression	deb-only. The compression type, one of gz, bzip2, xz (default: xz).
depends	Package dependencies. Defaults to ["libappindicator1", "libnotify-bin"].
target	Target package type: list of default, deb, rpm, freebsd, pacman, p5p, apk, 7z, zip, tar.xz, tar.lz, tar.gz, tar.bz2. Defaults to default (deb). Only deb is tested. Feel free to file issues for rpm and other package formats.

.directories

Name	Description
buildResources	The path to build resources, default build.
output	The output directory, default dist.
app	The application directory (containing the application package.json), default app, www or working directory.