electron/docs/tutorial/updates.md

71 lines
2.5 KiB
Markdown
Raw Normal View History

2017-08-11 23:04:25 +00:00
# Updating Applications
2017-08-14 20:26:33 +00:00
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
Electron's [autoUpdater](../api/auto-updater.md) module.
2017-08-11 23:04:25 +00:00
2017-08-14 20:26:33 +00:00
## Deploying an update server
2017-08-11 23:04:25 +00:00
2017-08-14 20:26:33 +00:00
To get started, you first need to deploy a server that the
[autoUpdater](../api/auto-updater.md) module will download new updates from.
2017-08-11 23:04:25 +00:00
Depending on your needs, you can choose from one of these:
2017-08-14 20:26:33 +00:00
- [Hazel](https://github.com/zeit/hazel) Pulls new releases from
[GitHub Releases](https://help.github.com/articles/creating-releases/) and can
be deployed for free on the [Now](https://zeit.co/now) hosting platform.
- [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.
- [electron-release-server](https://github.com/ArekSredzki/electron-release-server)
Provides a dashboard for handling releases
2017-08-11 23:04:25 +00:00
2017-08-14 20:26:33 +00:00
## Implementing updates in your app
2017-08-11 23:04:25 +00:00
2017-08-14 20:26:33 +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
2017-08-14 20:26:33 +00:00
**Important:** Please ensure that the code below will only be executed in
your packaged app. 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')
```
2017-08-14 20:26:33 +00:00
Next, construct the URL of the update server and tell
[autoUpdater](../api/auto-updater.md) about it:
2017-08-11 23:04:25 +00:00
```js
2017-08-14 20:26:33 +00:00
const server = 'https://your-deployment-url.com'
2017-08-11 23:04:25 +00:00
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
```
2017-08-14 20:26:33 +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.
2017-08-11 23:04:25 +00:00
2017-08-14 20:26:33 +00:00
## Further steps
2017-08-11 23:04:25 +00:00
2017-08-14 20:26:33 +00:00
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)).
2017-08-11 23:04:25 +00:00
2017-08-14 20:26:33 +00:00
Also make sure that potential errors are
[being handled](../api/auto-updater.md#event-error).