A complete solution to package and build a ready for distribution Electron app with “auto update” support out of the box
Permalink
Failed to load latest commit information.
.circleci fix(electron-updater): Updater crash on windows, fails on MacOS X Nov 7, 2018
.github fix: TypeError: Cannot read property 'Z_BEST_COMPRESSION' of undefined Sep 21, 2017
.idea feat(proton-native): package proton-native for Windows Nov 15, 2018
docker chore: update docker to nodejs 10.12.0, rcedit to 1.1.1 Oct 29, 2018
packages fix(electron-updater): Electron updater 4.x problem with quitAndInstall Nov 16, 2018
scripts fix(electron-updater): Electron updater 4.x problem with quitAndInstall Nov 16, 2018
test fix(electron-updater): nsis one-click per-machine auto-updating fails… Nov 16, 2018
typings fix(electron-updater): Updater crash on windows, fails on MacOS X Nov 7, 2018
.editorconfig feat: support finding electron version in build.electronVersion or el… May 26, 2016
.gitignore refactor: rename electron-builder-lib to app-builder-lib Jul 19, 2018
.mention-bot chore: rc-producer.yml for IDEA, mention bot config, update deps Dec 5, 2016
.travis.yml fix(proton-native): macOS default icon missing Nov 15, 2018
.yarnclean feat(deployment): DigitalOcean Spaces support (publish & auto update) Sep 23, 2017
CHANGELOG.md feat(nsis): app requestedExecutionLevel Aug 11, 2017
CONTRIBUTING.md docs: use mkdocs Jul 12, 2018
LICENSE Initial commit May 21, 2015
README.md docs: add note that all tools pre-bundled Nov 8, 2018
appveyor.yml fix(win): SignTool Error Aug 14, 2018
babel.config.js feat(squirrel.windows): update Squirrel.Windows to 1.9.0 Oct 31, 2018
mkdocs.yml docs: fix links Oct 28, 2018
netlify.toml fix(linux): Include main category for inferred DEB desktop entries Jul 22, 2018
package.json fix(electron-updater): Electron updater 4.x problem with quitAndInstall Nov 16, 2018
yarn.lock feat(proton-native): package proton-native for Windows Nov 15, 2018

README.md

electron-builder npm version downloads per month donate

A complete solution to package and build a ready for distribution Electron, Proton Native or Muon app for macOS, Windows and Linux with “auto update” support out of the box.

See documentation on electron.build.

  • NPM packages management:
  • Code Signing on a CI server or development machine.
  • Auto Update ready application packaging.
  • Numerous target formats:
    • All platforms: 7z, zip, tar.xz, tar.7z, tar.lz, tar.gz, tar.bz2, dir (unpacked directory).
    • macOS: dmg, pkg, mas.
    • Linux: AppImage, snap, debian package (deb), rpm, freebsd, pacman, p5p, apk.
    • Windows: nsis (Installer), nsis-web (Web installer), portable (portable app without installation), AppX (Windows Store), MSI, Squirrel.Windows.
  • Publishing artifacts to GitHub Releases, Amazon S3, DigitalOcean Spaces and Bintray.
  • Advanced building:
    • Pack in a distributable format already packaged app.
    • Separate build steps.
    • Build and publish in parallel, using hard links on CI server to reduce IO and disk space usage.
    • electron-compile support (compile for release-time on the fly on build).
  • Docker images to build Electron app for Linux or Windows on any platform.
  • Proton Native and Muon support.
  • Downloads all required tools files on demand automatically (e.g. to code sign windows application, to make AppX), no need to setup.
Question Answer
“I want to configure electron-builder” See options
“I have a question” Open an issue or join the chat
“I found a bug” Open an issue
“I want to support development” Donate

Real project example — onshape-desktop-shell.

Installation

Yarn is strongly recommended instead of npm.

yarn add electron-builder --dev

Quick Setup Guide

electron-webpack-quick-start is a recommended way to create a new Electron application. See Boilerplates.

  1. Specify the standard fields in the application package.jsonname, description, version and author.

  2. Specify the build configuration in the package.json as follows:

    "build": {
      "appId": "your.id",
      "mac": {
        "category": "your.app.category.type"
      }
    }

    See all options. Option files to indicate which files should be packed in the final application, including the entry file, maybe required.

  3. Add icons.

  4. Add the scripts key to the development package.json:

    "scripts": {
      "pack": "electron-builder --dir",
      "dist": "electron-builder"
    }

    Then you can run yarn dist (to package in a distributable format (e.g. dmg, windows installer, deb package)) or yarn pack (only generates the package directory without really packaging it. This is useful for testing purposes).

    To ensure your native dependencies are always matched electron version, simply add script "postinstall": "electron-builder install-app-deps" to your package.json.

  5. If you have native addons of your own that are part of the application (not as a dependency), set nodeGypRebuild to true.

Please note that everything is packaged into an asar archive by default.

For an app that will be shipped to production, you should sign your application. See Where to buy code signing certificates.

Donate

We do this open source work in our free time. If you'd like us to invest more time on it, please donate. Donation can be used to increase some issue priority.

Sponsors

WorkFlowy Tidepool