| description |
|---|
Set up automatic updates for your Electron application |
Setting up Auto Updates in your app with Electron Forge is mostly the same process as described in the Electron docs. Forge enhances your workflow by publishing your app to the right place for you. There are three main ways you can do auto updates.
{% hint style="warning" %} Note that having a signed application is a pre-requisite for using auto updates on macOS. {% endhint %}
Open source apps hosted on GitHub can use a free auto update service from the Electron team, update.electronjs.org. To use this module with Forge, set up the GitHub Publisher and add the update-electron-app module to your app.
This setup is going to be around 2 lines of code and a few lines of configuration. It is by far the easiest way to set up auto updates if you're an open source app.
If you are using any of Forge's built-in Publishers that upload your artifacts to static storage, they each have a documentation section on how to configure your app to auto update using those uploaded artifacts. Check out each of the options:
- Amazon S3
- Google Cloud Storage (Coming Soon)
If you're not open source or you want slightly more control over your update service (like percentage based rollouts, or more release channels) you can host your own update server such as nucleus or nuts. See the full list of known Electron update servers in the Electron's Updating Applications docs.
Each update server will have their own configuration for your actual app, but publishing should be done from Forge for most of them:
nucleus- Use the Nucleus publish targetnuts- Use the GitHub publish targetelectron-release-server- Use the Electron Release Server publish targethazel- Use the GitHub publish target