Skip to content

electron builder.Interface.WindowsConfiguration

Electron-Builder / electron-builder / WindowsConfiguration

Extends

Properties

appId?

readonly optional appId: null | string

The application id. Used as CFBundleIdentifier for MacOS and as Application User Model ID for Windows (NSIS target only, Squirrel.Windows not supported). It is strongly recommended that an explicit ID is set.

Default

com.electron.${name}

Inherited from

PlatformSpecificBuildOptions.appId

artifactName?

readonly optional artifactName: null | string

The artifact file name template. Defaults to ${productName}-${version}.${ext} (some target can have other defaults, see corresponding options).

Inherited from

PlatformSpecificBuildOptions.artifactName

asar?

readonly optional asar: null | boolean | AsarOptions

Whether to package the application’s source code into an archive, using Electron’s archive format.

Node modules, that must be unpacked, will be detected automatically, you don’t need to explicitly set asarUnpack - please file an issue if this doesn’t work.

Default

true

Inherited from

PlatformSpecificBuildOptions.asar

asarUnpack?

readonly optional asarUnpack: null | string | string[]

A glob patterns relative to the app directory, which specifies which files to unpack when creating the asar archive.

Inherited from

PlatformSpecificBuildOptions.asarUnpack

azureSignOptions?

readonly optional azureSignOptions: null | WindowsAzureSigningConfiguration

Options for usage of Azure Trusted Signing (beta) Cannot be used in conjunction with signtoolOptions, signing will default to Azure Trusted Signing

compression?

readonly optional compression: null | CompressionLevel

The compression level. If you want to rapidly test build, store can reduce build time significantly. maximum doesn’t lead to noticeable size difference, but increase build time.

Default

normal

Inherited from

PlatformSpecificBuildOptions.compression

cscKeyPassword?

optional cscKeyPassword: null | string

Inherited from

PlatformSpecificBuildOptions.cscKeyPassword

optional cscLink: null | string

Inherited from

PlatformSpecificBuildOptions.cscLink

defaultArch?

readonly optional defaultArch: string

Inherited from

PlatformSpecificBuildOptions.defaultArch

detectUpdateChannel?

readonly optional detectUpdateChannel: boolean

Whether to infer update channel from application version pre-release components. e.g. if version 0.12.1-alpha.1, channel will be set to alpha. Otherwise to latest. This does not apply to github publishing, which will never auto-detect the update channel.

Default

true

Inherited from

PlatformSpecificBuildOptions.detectUpdateChannel

disableDefaultIgnoredFiles?

optional disableDefaultIgnoredFiles: null | boolean

Whether to exclude all default ignored files(https://www.electron.build/contents#files) and options. Defaults to false.

Default

false

Inherited from

PlatformSpecificBuildOptions.disableDefaultIgnoredFiles

electronLanguages?

readonly optional electronLanguages: string | string[]

The electron locales to keep. By default, all Electron locales used as-is.

Inherited from

PlatformSpecificBuildOptions.electronLanguages

electronUpdaterCompatibility?

readonly optional electronUpdaterCompatibility: null | string

The electron-updater compatibility semver range.

Inherited from

PlatformSpecificBuildOptions.electronUpdaterCompatibility

executableName?

readonly optional executableName: null | string

The executable name. Defaults to productName.

Inherited from

PlatformSpecificBuildOptions.executableName

extraFiles?

optional extraFiles: null | string | FileSet | (string | FileSet)[]

The same as extraResources but copy into the app’s content directory (Contents for MacOS, root directory for Linux and Windows).

Inherited from

PlatformSpecificBuildOptions.extraFiles

extraResources?

optional extraResources: null | string | FileSet | (string | FileSet)[]

A glob patterns relative to the project directory, when specified, copy the file or directory with matching names directly into the app’s resources directory (Contents/Resources for MacOS, resources for Linux and Windows).

File patterns (and support for from and to fields) the same as for files.

Inherited from

PlatformSpecificBuildOptions.extraResources

fileAssociations?

readonly optional fileAssociations: FileAssociation | FileAssociation[]

The file associations.

Inherited from

PlatformSpecificBuildOptions.fileAssociations

files?

optional files: null | string | FileSet | (string | FileSet)[]

A glob patterns relative to the app directory, which specifies which files to include when copying files to create the package.

Defaults to: 

[
"**/*",
"!**/node_modules/*/{CHANGELOG.md,README.md,README,readme.md,readme}",
"!**/node_modules/*/{test,__tests__,tests,powered-test,example,examples}",
"!**/node_modules/*.d.ts",
"!**/node_modules/.bin",
"!**/*.{iml,o,hprof,orig,pyc,pyo,rbc,swp,csproj,sln,xproj}",
"!.editorconfig",
"!**/._*",
"!**/{.DS_Store,.git,.hg,.svn,CVS,RCS,SCCS,.gitignore,.gitattributes}",
"!**/{__pycache__,thumbs.db,.flowconfig,.idea,.vs,.nyc_output}",
"!**/{appveyor.yml,.travis.yml,circle.yml}",
"!**/{npm-debug.log,yarn.lock,.yarn-integrity,.yarn-metadata.json}"
]

Development dependencies are never copied in any case. You don’t need to ignore it explicitly. Hidden files are not ignored by default, but all files that should be ignored, are ignored by default.

Default pattern **/* is not added to your custom if some of your patterns is not ignore (i.e. not starts with !). package.json and **/node_modules/**/* (only production dependencies will be copied) is added to your custom in any case. All default ignores are added in any case — you don’t need to repeat it if you configure own patterns.

May be specified in the platform options (e.g. in the mac).

You may also specify custom source and destination directories by using FileSet objects instead of simple glob patterns.

[
{
 "from": "path/to/source",
 "to": "path/to/destination",
 "filter": ["**/*", "!foo/*.js"]
}
]

You can use file macros in the from and to fields as well. from and to can be files and you can use this to rename a file while packaging.

Inherited from

PlatformSpecificBuildOptions.files

forceCodeSigning?

readonly optional forceCodeSigning: boolean

Whether to fail if app will be not code signed.

Inherited from

PlatformSpecificBuildOptions.forceCodeSigning

generateUpdatesFilesForAllChannels?

readonly optional generateUpdatesFilesForAllChannels: boolean

Please see Building and Releasing using Channels.

Default

false

Inherited from

PlatformSpecificBuildOptions.generateUpdatesFilesForAllChannels

icon?

readonly optional icon: null | string

The path to application icon.

Default

build/icon.ico

Overrides

PlatformSpecificBuildOptions.icon

legalTrademarks?

readonly optional legalTrademarks: null | string

The trademarks and registered trademarks.

protocols?

readonly optional protocols: Protocol | Protocol[]

The URL protocol schemes.

Inherited from

PlatformSpecificBuildOptions.protocols

publish?

optional publish: Publish

Publisher configuration. See Auto Update for more information.

Inherited from

PlatformSpecificBuildOptions.publish

releaseInfo?

readonly optional releaseInfo: ReleaseInfo

The release info. Intended for command line usage:

-c.releaseInfo.releaseNotes="new features"

Inherited from

PlatformSpecificBuildOptions.releaseInfo

requestedExecutionLevel?

readonly optional requestedExecutionLevel: null | RequestedExecutionLevel

The security level at which the application requests to be executed. Cannot be specified per target, allowed only in the win.

Default

asInvoker

signAndEditExecutable?

readonly optional signAndEditExecutable: boolean

Whether to sign and add metadata to executable. Metadata includes information about the app name/description/version, publisher, copyright, etc. This property also is responsible for adding the app icon and setting execution level. (Advanced option leveraging rcedit)

Default

true

signExts?

readonly optional signExts: null | string[]

Explicit file extensions to also sign. Advanced option.

See

https://github.com/electron-userland/electron-builder/issues/7329

Default

null

signtoolOptions?

readonly optional signtoolOptions: null | WindowsSigntoolConfiguration

Options for usage with signtool.exe Cannot be used in conjunction with azureSignOptions, signing will default to Azure Trusted Signing

target?

readonly optional target: TargetConfigType

The target package type: list of nsis, nsis-web (Web installer), portable ([portable]./nsis.md#portable) app without installation), appx, msi, msi-wrapped, squirrel, 7z, zip, tar.xz, tar.lz, tar.gz, tar.bz2, dir. AppX package can be built only on Windows 10.

To use Squirrel.Windows please install electron-builder-squirrel-windows dependency.

Default

nsis

Overrides

PlatformSpecificBuildOptions.target

verifyUpdateCodeSignature?

readonly optional verifyUpdateCodeSignature: boolean

Whether to verify the signature of an available update before installation. The publisher name will be used for the signature verification.

Default

true