schema
stringclasses 471
values | key
stringlengths 0
203
| description
stringlengths 0
4.37k
| object
stringlengths 2
322k
|
|---|---|---|---|
electron-builder.json | displayLanguageSelector | Whether to display a language selection dialog. Not recommended (by default will be detected using OS language). | {"default": false, "type": "boolean"} |
electron-builder.json | guid | See [GUID vs Application Name](../configuration/nsis#guid-vs-application-name). | {"type": ["null", "string"]} |
electron-builder.json | include | The path to NSIS include script to customize installer. Defaults to `build/installer.nsh`. See [Custom NSIS script](#custom-nsis-script). | {"type": ["null", "string"]} |
electron-builder.json | installerHeader | *assisted installer only.* `MUI_HEADERIMAGE`, relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory. | {"default": "build/installerHeader.bmp", "type": ["null", "string"]} |
electron-builder.json | installerHeaderIcon | *one-click installer only.* The path to header icon (above the progress bar), relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory.
Defaults to `build/installerHeaderIcon.ico` or application icon. | {"type": ["null", "string"]} |
electron-builder.json | installerIcon | The path to installer icon, relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory.
Defaults to `build/installerIcon.ico` or application icon. | {"type": ["null", "string"]} |
electron-builder.json | installerLanguages | The installer languages (e.g. `en_US`, `de_DE`). Change only if you understand what do you do and for what. | {"anyOf": [{"items": {"type": "string"}, "type": "array"}, {"type": ["null", "string"]}]} |
electron-builder.json | installerSidebar | *assisted installer only.* `MUI_WELCOMEFINISHPAGE_BITMAP`, relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory.
Defaults to `build/installerSidebar.bmp` or `${NSISDIR}\\Contrib\\Graphics\\Wizard\\nsis3-metro.bmp`. Image size 164 × 314 pixels. | {"type": ["null", "string"]} |
electron-builder.json | language | [LCID Dec](https://msdn.microsoft.com/en-au/goglobal/bb964664.aspx), defaults to `1033`(`English - United States`). | {"type": ["null", "string"]} |
electron-builder.json | license | The path to EULA license file. Defaults to `license.txt` or `eula.txt` (or uppercase variants). In addition to `txt, `rtf` and `html` supported (don't forget to use `target="_blank"` for links).
Multiple license files in different languages are supported — use lang postfix (e.g. `_de`, `_ru`)). For example, create files `license_de.txt` and `license_en.txt` in the build resources.
If OS language is german, `license_de.txt` will be displayed. See map of [language code to name](https://github.com/meikidd/iso-639-1/blob/master/src/data.js).
Appropriate license file will be selected by user OS language. | {"type": ["null", "string"]} |
electron-builder.json | menuCategory | Whether to create submenu for start menu shortcut and program files directory. If `true`, company name will be used. Or string value. | {"default": false, "type": ["string", "boolean"]} |
electron-builder.json | multiLanguageInstaller | Whether to create multi-language installer. Defaults to `unicode` option value. | {"type": "boolean"} |
electron-builder.json | oneClick | Whether to create one-click installer or assisted. | {"default": true, "type": "boolean"} |
electron-builder.json | packElevateHelper | Whether to pack the elevate executable (required for electron-updater if per-machine installer used or can be used in the future). Ignored if `perMachine` is set to `true`. | {"default": true, "type": "boolean"} |
electron-builder.json | perMachine | Whether to show install mode installer page (choice per-machine or per-user) for assisted installer. Or whether installation always per all users (per-machine).
If `oneClick` is `true` (default): Whether to install per all users (per-machine).
If `oneClick` is `false` and `perMachine` is `true`: no install mode installer page, always install per-machine.
If `oneClick` is `false` and `perMachine` is `false` (default): install mode installer page. | {"default": false, "type": "boolean"} |
electron-builder.json | preCompressedFileExtensions | The file extension of files that will be not compressed. Applicable only for `extraResources` and `extraFiles` files. | {"anyOf": [{"items": {"type": "string"}, "type": "array"}, {"type": ["null", "string"]}], "default": [".avi", ".mov", ".m4v", ".mp4", ".m4p", ".qt", ".mkv", ".webm", ".vmdk"]} |
electron-builder.json | runAfterFinish | Whether to run the installed application after finish. For assisted installer corresponding checkbox will be removed. | {"default": true, "type": "boolean"} |
electron-builder.json | script | The path to NSIS script to customize installer. Defaults to `build/installer.nsi`. See [Custom NSIS script](#custom-nsis-script). | {"type": ["null", "string"]} |
electron-builder.json | shortcutName | The name that will be used for all shortcuts. Defaults to the application name. | {"type": ["null", "string"]} |
electron-builder.json | unicode | Whether to create [Unicode installer](http://nsis.sourceforge.net/Docs/Chapter1.html#intro-unicode). | {"default": true, "type": "boolean"} |
electron-builder.json | uninstallDisplayName | The uninstaller display name in the control panel. | {"default": "${productName} ${version}", "type": "string"} |
electron-builder.json | uninstallerIcon | The path to uninstaller icon, relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory.
Defaults to `build/uninstallerIcon.ico` or application icon. | {"type": ["null", "string"]} |
electron-builder.json | uninstallerSidebar | *assisted installer only.* `MUI_UNWELCOMEFINISHPAGE_BITMAP`, relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory.
Defaults to `installerSidebar` option or `build/uninstallerSidebar.bmp` or `build/installerSidebar.bmp` or `${NSISDIR}\\Contrib\\Graphics\\Wizard\\nsis3-metro.bmp` | {"type": ["null", "string"]} |
electron-builder.json | warningsAsErrors | If `warningsAsErrors` is `true` (default): NSIS will treat warnings as errors. If `warningsAsErrors` is `false`: NSIS will allow warnings. | {"default": true, "type": "boolean"} |
electron-builder.json | NsisWebOptions | Web Installer options. | {"additionalProperties": false, "properties": {"allowElevation": {"default": true, "type": "boolean"}, "allowToChangeInstallationDirectory": {"default": false, "type": "boolean"}, "appPackageUrl": {"type": ["null", "string"]}, "artifactName": {"type": ["null", "string"]}, "createDesktopShortcut": {"default": true, "enum": ["always", false, true]}, "createStartMenuShortcut": {"default": true, "type": "boolean"}, "deleteAppDataOnUninstall": {"default": false, "type": "boolean"}, "differentialPackage": {"type": "boolean"}, "displayLanguageSelector": {"default": false, "type": "boolean"}, "guid": {"type": ["null", "string"]}, "include": {"type": ["null", "string"]}, "installerHeader": {"default": "build/installerHeader.bmp", "type": ["null", "string"]}, "installerHeaderIcon": {"type": ["null", "string"]}, "installerIcon": {"type": ["null", "string"]}, "installerLanguages": {"anyOf": [{"items": {"type": "string"}, "type": "array"}, {"type": ["null", "string"]}]}, "installerSidebar": {"type": ["null", "string"]}, "language": {"type": ["null", "string"]}, "license": {"type": ["null", "string"]}, "menuCategory": {"default": false, "type": ["string", "boolean"]}, "multiLanguageInstaller": {"type": "boolean"}, "oneClick": {"default": true, "type": "boolean"}, "packElevateHelper": {"default": true, "type": "boolean"}, "perMachine": {"default": false, "type": "boolean"}, "preCompressedFileExtensions": {"anyOf": [{"items": {"type": "string"}, "type": "array"}, {"type": ["null", "string"]}], "default": [".avi", ".mov", ".m4v", ".mp4", ".m4p", ".qt", ".mkv", ".webm", ".vmdk"]}, "publish": {"anyOf": [{}, {}, {}, {}, {}, {}, {"items": {"anyOf": [{}, {}, {}, {}, {}, {}, {"type": "string"}]}, "type": "array"}, {"type": ["null", "string"]}]}, "runAfterFinish": {"default": true, "type": "boolean"}, "script": {"type": ["null", "string"]}, "shortcutName": {"type": ["null", "string"]}, "unicode": {"default": true, "type": "boolean"}, "uninstallDisplayName": {"default": "${productName} ${version}", "type": "string"}, "uninstallerIcon": {"type": ["null", "string"]}, "uninstallerSidebar": {"type": ["null", "string"]}, "useZip": {"default": false, "type": "boolean"}, "warningsAsErrors": {"default": true, "type": "boolean"}}, "type": "object"} |
electron-builder.json | allowElevation | *assisted installer only.* Allow requesting for elevation. If false, user will have to restart installer with elevated permissions. | {"default": true, "type": "boolean"} |
electron-builder.json | allowToChangeInstallationDirectory | *assisted installer only.* Whether to allow user to change installation directory. | {"default": false, "type": "boolean"} |
electron-builder.json | appPackageUrl | The application package download URL. Optional — by default computed using publish configuration.
URL like `https://example.com/download/latest` allows web installer to be version independent (installer will download latest application package).
Please note — it is [full URL](https://github.com/electron-userland/electron-builder/issues/1810#issuecomment-317650878).
Custom `X-Arch` http header is set to `32` or `64`. | {"type": ["null", "string"]} |
electron-builder.json | artifactName | The [artifact file name template](/configuration/configuration#artifact-file-name-template). Defaults to `${productName} Web Setup ${version}.${ext}`. | {"type": ["null", "string"]} |
electron-builder.json | createDesktopShortcut | Whether to create desktop shortcut. Set to `always` if to recreate also on reinstall (even if removed by user). | {"default": true, "enum": ["always", false, true]} |
electron-builder.json | createStartMenuShortcut | Whether to create start menu shortcut. | {"default": true, "type": "boolean"} |
electron-builder.json | deleteAppDataOnUninstall | *one-click installer only.* Whether to delete app data on uninstall. | {"default": false, "type": "boolean"} |
electron-builder.json | differentialPackage | Defaults to `true` for web installer (`nsis-web`) | {"type": "boolean"} |
electron-builder.json | displayLanguageSelector | Whether to display a language selection dialog. Not recommended (by default will be detected using OS language). | {"default": false, "type": "boolean"} |
electron-builder.json | guid | See [GUID vs Application Name](../configuration/nsis#guid-vs-application-name). | {"type": ["null", "string"]} |
electron-builder.json | include | The path to NSIS include script to customize installer. Defaults to `build/installer.nsh`. See [Custom NSIS script](#custom-nsis-script). | {"type": ["null", "string"]} |
electron-builder.json | installerHeader | *assisted installer only.* `MUI_HEADERIMAGE`, relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory. | {"default": "build/installerHeader.bmp", "type": ["null", "string"]} |
electron-builder.json | installerHeaderIcon | *one-click installer only.* The path to header icon (above the progress bar), relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory.
Defaults to `build/installerHeaderIcon.ico` or application icon. | {"type": ["null", "string"]} |
electron-builder.json | installerIcon | The path to installer icon, relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory.
Defaults to `build/installerIcon.ico` or application icon. | {"type": ["null", "string"]} |
electron-builder.json | installerLanguages | The installer languages (e.g. `en_US`, `de_DE`). Change only if you understand what do you do and for what. | {"anyOf": [{"items": {"type": "string"}, "type": "array"}, {"type": ["null", "string"]}]} |
electron-builder.json | installerSidebar | *assisted installer only.* `MUI_WELCOMEFINISHPAGE_BITMAP`, relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory.
Defaults to `build/installerSidebar.bmp` or `${NSISDIR}\\Contrib\\Graphics\\Wizard\\nsis3-metro.bmp`. Image size 164 × 314 pixels. | {"type": ["null", "string"]} |
electron-builder.json | language | [LCID Dec](https://msdn.microsoft.com/en-au/goglobal/bb964664.aspx), defaults to `1033`(`English - United States`). | {"type": ["null", "string"]} |
electron-builder.json | license | The path to EULA license file. Defaults to `license.txt` or `eula.txt` (or uppercase variants). In addition to `txt, `rtf` and `html` supported (don't forget to use `target="_blank"` for links).
Multiple license files in different languages are supported — use lang postfix (e.g. `_de`, `_ru`)). For example, create files `license_de.txt` and `license_en.txt` in the build resources.
If OS language is german, `license_de.txt` will be displayed. See map of [language code to name](https://github.com/meikidd/iso-639-1/blob/master/src/data.js).
Appropriate license file will be selected by user OS language. | {"type": ["null", "string"]} |
electron-builder.json | menuCategory | Whether to create submenu for start menu shortcut and program files directory. If `true`, company name will be used. Or string value. | {"default": false, "type": ["string", "boolean"]} |
electron-builder.json | multiLanguageInstaller | Whether to create multi-language installer. Defaults to `unicode` option value. | {"type": "boolean"} |
electron-builder.json | oneClick | Whether to create one-click installer or assisted. | {"default": true, "type": "boolean"} |
electron-builder.json | packElevateHelper | Whether to pack the elevate executable (required for electron-updater if per-machine installer used or can be used in the future). Ignored if `perMachine` is set to `true`. | {"default": true, "type": "boolean"} |
electron-builder.json | perMachine | Whether to show install mode installer page (choice per-machine or per-user) for assisted installer. Or whether installation always per all users (per-machine).
If `oneClick` is `true` (default): Whether to install per all users (per-machine).
If `oneClick` is `false` and `perMachine` is `true`: no install mode installer page, always install per-machine.
If `oneClick` is `false` and `perMachine` is `false` (default): install mode installer page. | {"default": false, "type": "boolean"} |
electron-builder.json | preCompressedFileExtensions | The file extension of files that will be not compressed. Applicable only for `extraResources` and `extraFiles` files. | {"anyOf": [{"items": {"type": "string"}, "type": "array"}, {"type": ["null", "string"]}], "default": [".avi", ".mov", ".m4v", ".mp4", ".m4p", ".qt", ".mkv", ".webm", ".vmdk"]} |
electron-builder.json | runAfterFinish | Whether to run the installed application after finish. For assisted installer corresponding checkbox will be removed. | {"default": true, "type": "boolean"} |
electron-builder.json | script | The path to NSIS script to customize installer. Defaults to `build/installer.nsi`. See [Custom NSIS script](#custom-nsis-script). | {"type": ["null", "string"]} |
electron-builder.json | shortcutName | The name that will be used for all shortcuts. Defaults to the application name. | {"type": ["null", "string"]} |
electron-builder.json | unicode | Whether to create [Unicode installer](http://nsis.sourceforge.net/Docs/Chapter1.html#intro-unicode). | {"default": true, "type": "boolean"} |
electron-builder.json | uninstallDisplayName | The uninstaller display name in the control panel. | {"default": "${productName} ${version}", "type": "string"} |
electron-builder.json | uninstallerIcon | The path to uninstaller icon, relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory.
Defaults to `build/uninstallerIcon.ico` or application icon. | {"type": ["null", "string"]} |
electron-builder.json | uninstallerSidebar | *assisted installer only.* `MUI_UNWELCOMEFINISHPAGE_BITMAP`, relative to the [build resources](/configuration/configuration#MetadataDirectories-buildResources) or to the project directory.
Defaults to `installerSidebar` option or `build/uninstallerSidebar.bmp` or `build/installerSidebar.bmp` or `${NSISDIR}\\Contrib\\Graphics\\Wizard\\nsis3-metro.bmp` | {"type": ["null", "string"]} |
electron-builder.json | warningsAsErrors | If `warningsAsErrors` is `true` (default): NSIS will treat warnings as errors. If `warningsAsErrors` is `false`: NSIS will allow warnings. | {"default": true, "type": "boolean"} |
electron-builder.json | PkgBackgroundOptions | Options for the background image in a PKG installer | {"additionalProperties": false, "properties": {"alignment": {"anyOf": [{"enum": ["bottom", "bottomleft", "bottomright", "center", "left", "right", "top", "topleft", "topright"], "type": "string"}, {"type": "null"}], "default": "center"}, "file": {"type": "string"}, "scaling": {"anyOf": [{"enum": ["none", "proportional", "tofit"], "type": "string"}, {"type": "null"}], "default": "tofit"}}, "type": "object"} |
electron-builder.json | alignment | Alignment of the background image.
Options are: center, left, right, top, bottom, topleft, topright, bottomleft, bottomright | {"anyOf": [{"enum": ["bottom", "bottomleft", "bottomright", "center", "left", "right", "top", "topleft", "topright"], "type": "string"}, {"type": "null"}], "default": "center"} |
electron-builder.json | file | Path to the image to use as an installer background. | {"type": "string"} |
electron-builder.json | scaling | Scaling of the background image.
Options are: tofit, none, proportional | {"anyOf": [{"enum": ["none", "proportional", "tofit"], "type": "string"}, {"type": "null"}], "default": "tofit"} |
electron-builder.json | PkgOptions | macOS product archive options. | {"additionalProperties": false, "properties": {"allowAnywhere": {"default": true, "type": ["null", "boolean"]}, "allowCurrentUserHome": {"default": true, "type": ["null", "boolean"]}, "allowRootDirectory": {"default": true, "type": ["null", "boolean"]}, "artifactName": {"type": ["null", "string"]}, "background": {"anyOf": [{}, {"type": "null"}]}, "conclusion": {"type": ["null", "string"]}, "hasStrictIdentifier": {"default": true, "type": ["null", "boolean"]}, "identity": {"type": ["null", "string"]}, "installLocation": {"default": "/Applications", "type": ["null", "string"]}, "isRelocatable": {"default": true, "type": ["null", "boolean"]}, "isVersionChecked": {"default": true, "type": ["null", "boolean"]}, "license": {"type": ["null", "string"]}, "overwriteAction": {"anyOf": [{"enum": ["update", "upgrade"], "type": "string"}, {"type": "null"}], "default": "upgrade"}, "productbuild": {"anyOf": [{"items": {"type": "string"}, "type": "array"}, {"type": "null"}]}, "publish": {"anyOf": [{}, {}, {}, {}, {}, {}, {"items": {"anyOf": [{}, {}, {}, {}, {}, {}, {"type": "string"}]}, "type": "array"}, {"type": ["null", "string"]}]}, "scripts": {"default": "build/pkg-scripts", "type": ["null", "string"]}, "welcome": {"type": ["null", "string"]}}, "type": "object"} |
electron-builder.json | allowAnywhere | Whether can be installed at the root of any volume, including non-system volumes. Otherwise, it cannot be installed at the root of a volume.
Corresponds to [enable_anywhere](https://developer.apple.com/library/content/documentation/DeveloperTools/Reference/DistributionDefinitionRef/Chapters/Distribution_XML_Ref.html#//apple_ref/doc/uid/TP40005370-CH100-SW70). | {"default": true, "type": ["null", "boolean"]} |
electron-builder.json | allowCurrentUserHome | Whether can be installed into the current user's home directory.
A home directory installation is done as the current user (not as root), and it cannot write outside of the home directory.
If the product cannot be installed in the user's home directory and be not completely functional from user's home directory.
Corresponds to [enable_currentUserHome](https://developer.apple.com/library/content/documentation/DeveloperTools/Reference/DistributionDefinitionRef/Chapters/Distribution_XML_Ref.html#//apple_ref/doc/uid/TP40005370-CH100-SW70). | {"default": true, "type": ["null", "boolean"]} |
electron-builder.json | allowRootDirectory | Whether can be installed into the root directory. Should usually be `true` unless the product can be installed only to the user's home directory.
Corresponds to [enable_localSystem](https://developer.apple.com/library/content/documentation/DeveloperTools/Reference/DistributionDefinitionRef/Chapters/Distribution_XML_Ref.html#//apple_ref/doc/uid/TP40005370-CH100-SW70). | {"default": true, "type": ["null", "boolean"]} |
electron-builder.json | artifactName | The [artifact file name template](/configuration/configuration#artifact-file-name-template). | {"type": ["null", "string"]} |
electron-builder.json | background | Options for the background image for the installer. | {"anyOf": [{}, {"type": "null"}]} |
electron-builder.json | conclusion | The path to the conclusion file. This may be used to customize the text on the final "Summary" page of the installer. | {"type": ["null", "string"]} |
electron-builder.json | hasStrictIdentifier | Require identical bundle identifiers at install path? | {"default": true, "type": ["null", "boolean"]} |
electron-builder.json | identity | The name of certificate to use when signing. Consider using environment variables [CSC_LINK or CSC_NAME](/code-signing) instead of specifying this option. | {"type": ["null", "string"]} |
electron-builder.json | installLocation | The install location. [Do not use it](https://stackoverflow.com/questions/12863944/how-do-you-specify-a-default-install-location-to-home-with-pkgbuild) to create per-user package.
Mostly never you will need to change this option. `/Applications` would install it as expected into `/Applications` if the local system domain is chosen, or into `$HOME/Applications` if the home installation is chosen. | {"default": "/Applications", "type": ["null", "string"]} |
electron-builder.json | isRelocatable | Install bundle over previous version if moved by user? | {"default": true, "type": ["null", "boolean"]} |
electron-builder.json | isVersionChecked | Don't install bundle if newer version on disk? | {"default": true, "type": ["null", "boolean"]} |
electron-builder.json | license | The path to EULA license file. Defaults to `license.txt` or `eula.txt` (or uppercase variants). In addition to `txt, `rtf` and `html` supported (don't forget to use `target="_blank"` for links). | {"type": ["null", "string"]} |
electron-builder.json | overwriteAction | Specifies how an existing version of the bundle on disk should be handled when the version in
the package is installed.
If you specify upgrade, the bundle in the package atomi-cally replaces any version on disk;
this has the effect of deleting old paths that no longer exist in the new version of
the bundle.
If you specify update, the bundle in the package overwrites the version on disk, and any files
not contained in the package will be left intact; this is appropriate when you are delivering
an update-only package.
Another effect of update is that the package bundle will not be installed at all if there is
not already a version on disk; this allows a package to deliver an update for an app that
the user might have deleted. | {"anyOf": [{"enum": ["update", "upgrade"], "type": "string"}, {"type": "null"}], "default": "upgrade"} |
electron-builder.json | productbuild | should be not documented, only to experiment | {"anyOf": [{"items": {"type": "string"}, "type": "array"}, {"type": "null"}]} |
electron-builder.json | scripts | The scripts directory, relative to `build` (build resources directory).
The scripts can be in any language so long as the files are marked executable and have the appropriate shebang indicating the path to the interpreter.
Scripts are required to be executable (`chmod +x file`). | {"default": "build/pkg-scripts", "type": ["null", "string"]} |
electron-builder.json | welcome | The path to the welcome file. This may be used to customize the text on the Introduction page of the installer. | {"type": ["null", "string"]} |
electron-builder.json | PortableOptions | Portable options. | {"additionalProperties": false, "properties": {"artifactName": {"type": ["null", "string"]}, "guid": {"type": ["null", "string"]}, "publish": {"anyOf": [{}, {}, {}, {}, {}, {}, {"items": {"anyOf": [{}, {}, {}, {}, {}, {}, {"type": "string"}]}, "type": "array"}, {"type": ["null", "string"]}]}, "requestExecutionLevel": {"default": "user", "enum": ["admin", "highest", "user"], "type": "string"}, "unicode": {"default": true, "type": "boolean"}, "useZip": {"default": false, "type": "boolean"}, "warningsAsErrors": {"default": true, "type": "boolean"}, "unpackDirName": {"type": "string"}}, "type": "object"} |
electron-builder.json | artifactName | The [artifact file name template](/configuration/configuration#artifact-file-name-template). | {"type": ["null", "string"]} |
electron-builder.json | guid | See [GUID vs Application Name](../configuration/nsis#guid-vs-application-name). | {"type": ["null", "string"]} |
electron-builder.json | requestExecutionLevel | The [requested execution level](http://nsis.sourceforge.net/Reference/RequestExecutionLevel) for Windows. | {"default": "user", "enum": ["admin", "highest", "user"], "type": "string"} |
electron-builder.json | unicode | Whether to create [Unicode installer](http://nsis.sourceforge.net/Docs/Chapter1.html#intro-unicode). | {"default": true, "type": "boolean"} |
electron-builder.json | warningsAsErrors | If `warningsAsErrors` is `true` (default): NSIS will treat warnings as errors. If `warningsAsErrors` is `false`: NSIS will allow warnings. | {"default": true, "type": "boolean"} |
electron-builder.json | unpackDirName | The unpack directory name in [TEMP](https://www.askvg.com/where-does-windows-store-temporary-files-and-how-to-change-temp-folder-location/) directory.
Defaults to [uuid](https://github.com/segmentio/ksuid) of build (changed on each build of portable executable). | {"type": "string"} |
electron-builder.json | Protocol | URL Protocol Schemes. Protocols to associate the app with. macOS only.
Please note — on macOS [you need to register an `open-url` event handler](http://electron.atom.io/docs/api/app/#event-open-url-macos). | {"additionalProperties": false, "properties": {"name": {"type": "string"}, "role": {"default": "Editor", "enum": ["Editor", "None", "Shell", "Viewer"], "type": "string"}, "schemes": {"items": {"type": "string"}, "type": "array"}}, "required": ["name", "schemes"], "type": "object"} |
electron-builder.json | name | The name. e.g. `IRC server URL`. | {"type": "string"} |
electron-builder.json | role | *macOS-only* The app's role with respect to the type. | {"default": "Editor", "enum": ["Editor", "None", "Shell", "Viewer"], "type": "string"} |
electron-builder.json | schemes | The schemes. e.g. `["irc", "ircs"]`. | {"items": {"type": "string"}, "type": "array"} |
electron-builder.json | releaseDate | The release date. | {"type": "string"} |
electron-builder.json | releaseName | The release name. | {"type": ["null", "string"]} |
electron-builder.json | releaseNotes | The release notes. | {"type": ["null", "string"]} |
electron-builder.json | releaseNotesFile | The path to release notes file. Defaults to `release-notes-${platform}.md` (where `platform` it is current platform — `mac`, `linux` or `windows`) or `release-notes.md` in the [build resources](#MetadataDirectories-buildResources). | {"type": ["null", "string"]} |
electron-builder.json | acl | The ACL. Set to `null` to not [add](https://github.com/electron-userland/electron-builder/issues/1822).
Please see [required permissions for the S3 provider](https://github.com/electron-userland/electron-builder/issues/1618#issuecomment-314679128). | {"anyOf": [{"enum": ["private", "public-read"], "type": "string"}, {"type": "null"}], "default": "public-read"} |
electron-builder.json | bucket | The bucket name. | {"type": "string"} |
electron-builder.json | channel | The update channel. | {"default": "latest", "type": ["null", "string"]} |
electron-builder.json | encryption | Server-side encryption algorithm to use for the object. | {"anyOf": [{"enum": ["AES256", "aws:kms"], "type": "string"}, {"type": "null"}]} |
electron-builder.json | endpoint | The endpoint URI to send requests to. The default endpoint is built from the configured region.
The endpoint should be a string like `https://{service}.{region}.amazonaws.com`. | {"type": ["null", "string"]} |
electron-builder.json | path | The directory path. | {"default": "/", "type": ["null", "string"]} |
electron-builder.json | provider | The provider. Must be `s3`. | {"enum": ["s3"], "type": "string"} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.