Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/karaggeorge/electron-builder-notarize
Notarize Electron applications using electron-builder
https://github.com/karaggeorge/electron-builder-notarize
Last synced: 14 days ago
JSON representation
Notarize Electron applications using electron-builder
- Host: GitHub
- URL: https://github.com/karaggeorge/electron-builder-notarize
- Owner: karaggeorge
- License: mit
- Created: 2019-11-22T14:31:48.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-04-18T17:08:55.000Z (7 months ago)
- Last Synced: 2024-10-23T11:42:54.377Z (21 days ago)
- Language: JavaScript
- Size: 40 KB
- Stars: 80
- Watchers: 4
- Forks: 20
- Open Issues: 8
-
Metadata Files:
- Readme: readme.md
- Funding: .github/FUNDING.yml
- License: license
Awesome Lists containing this project
README
# electron-builder-notarize [](https://travis-ci.com/karaggeorge/electron-builder-notarize)
> Notarize Electron applications using electron-builder
For more details regarding the options and functionality: https://github.com/electron/electron-notarize
## Install
```
# npm
npm i electron-builder-notarize --save-dev
# yarn
yarn add electron-builder-notarize --dev
```
## Usage
In your electron-builder config:
```json
{
...
"afterSign": "electron-builder-notarize",
"mac": {
...
"hardenedRuntime": true,
"entitlements": "./node_modules/electron-builder-notarize/entitlements.mac.inherit.plist",
}
}
```
You can replace the entitlements file with your own, as long as those properties are included as well.
You will also need to authenticate yourself, either with your Apple ID or using an API key. This is done by setting the corresponding environment variables.
If for some reason the script can't locate your project's `appId`, you can specify it using the `APP_ID` environment variable.
### Using `notarytool`
In order to use `notarytool` for notarization, XCode 13 or later is required
Authentication methods:
- username and password
- `APPLE_ID` String - The username of your apple developer account
- `APPLE_ID_PASSWORD` String - The [app-specific password](https://support.apple.com/HT204397) (not your Apple ID password).
- `APPLE_TEAM_ID` String - The team ID you want to notarize under.
- apiKey with apiIssuer:
- `APPLE_API_KEY` String - Required for JWT authentication. See Note on JWT authentication below.
- `APPLE_API_KEY_ID` String - Required for JWT authentication. See Note on JWT authentication below.
- `APPLE_API_KEY_ISSUER` String - Issuer ID. Required if `APPLE_API_KEY` is specified.
- keychain with keychainProfile:
- `APPLE_KEYCHAIN` String - The name of the keychain or path to the keychain you stored notarization credentials in.
- `APPLE_KEYCHAIN_PROFILE` String - The name of the profile you provided when storing notarization credentials.
### Using Legacy
General options:
- `TEAM_SHORT_NAME` String - Your [Team Short Name](#notes-on-your-team-short-name).
Authentication methods:
- username and password
- `APPLE_ID` String - The username of your apple developer account
- `APPLE_ID_PASSWORD` String - The [app-specific password](https://support.apple.com/HT204397) (not your Apple ID password).
- apiKey with apiIssuer
- `APPLE_API_KEY` String - Required for JWT authentication. See Note on JWT authentication below.
- `APPLE_API_KEY_ISSUER` String - Issuer ID. Required if `APPLE_API_KEY` is specified.
### Multiple Teams
If your developer account is a member of multiple teams or organizations, you might see an error. In this case, you need to provide your [Team Short Name](https://github.com/electron/electron-notarize#notes-on-your-team-short-name) as an environment variable:
```sh
export TEAM_SHORT_NAME=XXXXXXXXX
```
## Credits
This package is inspired by this [article](https://medium.com/@TwitterArchiveEraser/notarize-electron-apps-7a5f988406db)
The library used for notarization: https://github.com/electron/electron-notarize
## License
MIT