electron/docs/tutorial/updates.md

49 lines
2.5 KiB
Markdown
Raw Normal View History

2017-08-11 23:04:25 +00:00
# Updating Applications
There are several ways to update an Electron application. The easiest and officially supported one is taking advantage of the built-in [Squirrel](https://github.com/Squirrel) framework and the [autoUpdater](../api/auto-updater.md) module that comes with it.
## Deploying an Update Server
To get started, you firstly need to deploy an update server (that's where the [autoUpdater](../api/auto-updater.md) module will download new updates from).
Depending on your needs, you can choose from one of these:
- [Hazel](https://github.com/zeit/hazel) Pulls new releases from [GitHub Releases](https://help.github.com/articles/creating-releases/) and is **perfect for getting started**
- [Nuts](https://github.com/GitbookIO/nuts) Also uses [GitHub Releases](https://help.github.com/articles/creating-releases/), but caches app updates on disk and supports private repositories
2017-08-11 23:04:25 +00:00
- [electron-release-server](https://github.com/ArekSredzki/electron-release-server) Provides you with a dashboard for handling releases
2017-08-11 23:18:34 +00:00
## Implementing Updates into Your App
2017-08-11 23:04:25 +00:00
2017-08-11 23:24:56 +00:00
Once you've deployed your update server, continue with importing the required modules in your code (the following code might vary for different server software, but it works like described when using [Hazel](https://github.com/zeit/hazel)).
2017-08-11 23:23:54 +00:00
**Important:** Please ensure that the code below will only be executed in production - you can use [electron-is-dev](https://github.com/sindresorhus/electron-is-dev) to check for the environment).
2017-08-11 23:04:25 +00:00
```js
const { app, autoUpdater } = require('electron')
```
Next, put together the URL of the update server and tell [autoUpdater](../api/auto-updater.md) about it:
2017-08-11 23:04:25 +00:00
```js
const server = <your-deployment-url>
const feed = `${server}/update/${process.platform}/${app.getVersion()}`
autoUpdater.setFeedURL(feed)
2017-08-11 23:04:25 +00:00
```
As the final step, check for updates (the example below will check every minute):
2017-08-11 23:04:25 +00:00
```js
setInterval(() => {
autoUpdater.checkForUpdates()
}, 60000)
2017-08-11 23:04:25 +00:00
```
That's all. Once [built](../tutorial/application-distribution.md), your application will receive an update for each new [GitHub Release](https://help.github.com/articles/creating-releases/) that you create.
## Further Steps
Now that you've configured the basic update mechanism for your application, you need to ensure that the user will get notified when there's an update (this can be achieved using [events](../api/auto-updater.md#events)).
Also make sure that potential errors are [being handled](../api/auto-updater.md#event-error).