https://github.com/felixrieseberg/electron-forge-maker-nsis
An electron-forge maker for NSIS that supports electron-forge v6 and can be used as a replacement for electron-builder. Supports code-signing and basic updates with electron-updater.
https://github.com/felixrieseberg/electron-forge-maker-nsis
electron electron-forge nsis windows
Last synced: about 1 year ago
JSON representation
An electron-forge maker for NSIS that supports electron-forge v6 and can be used as a replacement for electron-builder. Supports code-signing and basic updates with electron-updater.
- Host: GitHub
- URL: https://github.com/felixrieseberg/electron-forge-maker-nsis
- Owner: felixrieseberg
- License: mit
- Created: 2023-05-31T23:27:31.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-14T01:41:48.000Z (almost 2 years ago)
- Last Synced: 2024-10-14T14:34:28.424Z (over 1 year ago)
- Topics: electron, electron-forge, nsis, windows
- Language: TypeScript
- Homepage:
- Size: 538 KB
- Stars: 4
- Watchers: 3
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# electron-forge-maker-nsis [![npm][npm_img]][npm_url]
An `electron-forge` maker for NSIS that supports `electron-forge` v6 and can be used as a
replacement for `electron-builder`. Supports code-signing and basic updates with `electron-updater`.
This maker takes two configuration objects: `codesigning` for codesigning and `updater` for `electron-updater` support. Both of them are optional, the feature in question will simply be turned off if not provided.
- `codesigning` is passed directly to [@electron/windows-sign](https://github.com/electron/windows-sign) and supports all its options (except for `appDirectory`, which is provided directly by this maker).
- `updater`
- `url`: URL to the location of yml files.
- `updaterCacheDirName`: Name of the local cache. By default `${name}-updater`.
- `channel`: Name of the update channel. By default `latest`.
- `publisherName`: Used to verify the code signature.
```ts
// forge.config.js with minimal configuration
makers: [
{
name: "@felixrieseberg/electron-forge-maker-nsis",
config: {},
}
]
```
```ts
// forge.config.js with example configuration
makers: [
{
name: "@felixrieseberg/electron-forge-maker-nsis",
config: {
codesigning: {
certificateFile?: string;
certificatePassword?: string;
},
updater: {
url: "https://s3-us-west-2.amazonaws.com/my-bucket",
updaterCacheDirName: "my-updater",
channel: "latest",
publisherName: "My Company, Inc."
},
getAdditionalConfig: () => {
return {
artifactName: "${productName} Setup ${version} ${arch}.${ext}"
}
}
},
}
]
```
## Updating
This tool supports ["generic" updates][https://www.electron.build/configuration/publish.html#publishers] with `electron-updater`.
# License
MIT. Please see LICENSE for details.
[electron]: https://github.com/electron/electron
[npm_img]: https://img.shields.io/npm/v/@felixrieseberg/electron-forge-maker-nsis.svg
[npm_url]: https://npmjs.org/package/@felixrieseberg/electron-forge-maker-nsis