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.

Development package.json

Name	Description
build	See .build.
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.
directories	See .directories

.build

Name	Description
app-bundle-id	OS X-only. The bundle identifier to use in the application's plist.
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.
iconUrl	windows-only. 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://raw.githubusercontent.com/${user}/${project}/master/build/icon.ico by default.
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.
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.

.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).

.build.win

See all windows-installer options.

Name	Description
loadingGif	The path to a .gif file to display during install. build/install-spinner.gif will be used if exists (otherwise default).
noMsi	Whether to create an MSI installer. Defaults to true (MSI is not created).

.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).

.directories

Name	Description
buildResources	The path to build resources, default build.
output	The output directory, default dist.