Skip to content

Latest commit

 

History

History
101 lines (97 loc) · 7.81 KB

mac.md

File metadata and controls

101 lines (97 loc) · 7.81 KB

The top-level mac key contains set of options instructing electron-builder on how it should build macOS targets. These options applicable for any macOS target.

  • category String | “undefined” - The application category type, as shown in the Finder via View -> Arrange by Application Category when viewing the Applications directory.

    For example, "category": "public.app-category.developer-tools" will set the application category to Developer Tools.

    Valid values are listed in Apple’s documentation.

  • target String | TargetConfiguration - The target package type: list of default, dmg, mas, mas-dev, pkg, 7z, zip, tar.xz, tar.lz, tar.gz, tar.bz2, dir. Defaults to default (dmg and zip for Squirrel.Mac).

  • identity String | “undefined” - The name of certificate to use when signing. Consider using environment variables CSC_LINK or CSC_NAME instead of specifying this option. MAS installer identity is specified in the mas.

  • icon = build/icon.icns String | “undefined” - The path to application icon.

  • entitlements String | “undefined” - The path to entitlements file for signing the app. build/entitlements.mac.plist will be used if exists (it is a recommended way to set). MAS entitlements is specified in the mas.

  • entitlementsInherit String | “undefined” - The path to child entitlements which inherit the security settings for signing frameworks and bundles of a distribution. build/entitlements.mac.inherit.plist will be used if exists (it is a recommended way to set). Otherwise default.

    This option only applies when signing with entitlements provided.

  • entitlementsLoginHelper String | “undefined” - Path to login helper entitlement file. When using App Sandbox, the the com.apple.security.inherit key that is normally in the inherited entitlements cannot be inherited since the login helper is a standalone executable. Defaults to the value provided for entitlements. This option only applies when signing with entitlements provided.

  • provisioningProfile String | “undefined” - The path to the provisioning profile to use when signing, absolute or relative to the app root.

  • bundleVersion String | “undefined” - The CFBundleVersion. Do not use it unless you need to.

  • bundleShortVersion String | “undefined” - The CFBundleShortVersionString. Do not use it unless you need to.

  • darkModeSupport = false Boolean - Whether a dark mode is supported. If your app does have a dark mode, you can make your app follow the system-wide dark mode setting.

  • helperBundleId = ${appBundleIdentifier}.helper String | “undefined” - The bundle identifier to use in the application helper’s plist.

  • helperRendererBundleId = ${appBundleIdentifier}.helper.Renderer String | “undefined” - The bundle identifier to use in the Renderer helper’s plist.

  • helperPluginBundleId = ${appBundleIdentifier}.helper.Plugin String | “undefined” - The bundle identifier to use in the Plugin helper’s plist.

  • helperGPUBundleId = ${appBundleIdentifier}.helper.GPU String | “undefined” - The bundle identifier to use in the GPU helper’s plist.

  • helperEHBundleId = ${appBundleIdentifier}.helper.EH String | “undefined” - The bundle identifier to use in the EH helper’s plist.

  • helperNPBundleId = ${appBundleIdentifier}.helper.NP String | “undefined” - The bundle identifier to use in the NP helper’s plist.

  • type = distribution “distribution” | “development” | “undefined” - Whether to sign app for development or for distribution.

  • extendInfo any - The extra entries for Info.plist.

  • binaries Array<String> | “undefined” - Paths of any extra binaries that need to be signed.

  • minimumSystemVersion String | “undefined” - The minimum version of macOS required for the app to run. Corresponds to LSMinimumSystemVersion.

  • requirements String | “undefined” - Path of requirements file used in signing. Not applicable for MAS.

  • electronLanguages Array<String> | String - The electron locales. By default Electron locales used as is.

  • extraDistFiles Array<String> | String | “undefined” - Extra files to put in archive. Not applicable for tar.*.

  • hardenedRuntime = true Boolean - Whether your app has to be signed with hardened runtime.

  • gatekeeperAssess = false Boolean - Whether to let electron-osx-sign validate the signing or not.

  • strictVerify = true Array<String> | String | Boolean - Whether to let electron-osx-sign verify the contents or not.

  • signIgnore Array<String> | String | “undefined” - Regex or an array of regex’s that signal skipping signing a file.

  • timestamp String | “undefined” - Specify the URL of the timestamp authority server

{!includes/platform-specific-configuration-note.md!}