mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions 1

Merge pull request #10251 from electron/new-update-docs

Browse source 
New guide for implementing updates
This commit is contained in:
Zeke Sikelianos 2017-08-21 15:22:43 -07:00 • committed by GitHub
commit b1011768e5
3 changed files with 103 additions and 24 deletions
Download patch file Download diff file Expand all files Collapse all files

30
docs/api/auto-updater.md
View file

@ -4,24 +4,15 @@
Process: [Main](../glossary.md#main-process)
The `autoUpdater` module provides an interface for the
[Squirrel](https://github.com/Squirrel) framework.
**You can find a detailed guide about how to implement updates into your application [here](../tutorial/updates.md).**
You can quickly launch a multi-platform release server for distributing your
application by using one of these projects:
## Platform Notices
- [nuts][nuts]: *A smart release server for your applications, using GitHub as a backend. Auto-updates with Squirrel (Mac & Windows)*
- [electron-release-server][electron-release-server]: *A fully featured,
self-hosted release server for electron applications, compatible with
auto-updater*
- [squirrel-updates-server][squirrel-updates-server]: *A simple node.js server
for Squirrel.Mac and Squirrel.Windows which uses GitHub releases*
- [squirrel-release-server][squirrel-release-server]: *A simple PHP application for Squirrel.Windows which reads updates from a folder. Supports delta updates.*
Currently, only macOS and Windows are supported. There is no built-in support
for auto-updater on Linux, so it is recommended to use the
distribution's package manager to update your app.
## Platform notices
Though `autoUpdater` provides a uniform API for different platforms, there are
still some subtle differences on each platform.
In addition, there are some subtle differences on each platform:
### macOS
@ -54,11 +45,6 @@ Unlike Squirrel.Mac, Windows can host updates on S3 or any other static file hos
You can read the documents of [Squirrel.Windows][squirrel-windows] to get more details
about how Squirrel.Windows works.
### Linux
There is no built-in support for auto-updater on Linux, so it is recommended to
use the distribution's package manager to update your app.
## Events
The `autoUpdater` object emits the following events:
@ -134,7 +120,3 @@ from the normal quit event sequence.
[installer-lib]: https://github.com/electron/windows-installer
[electron-forge-lib]: https://github.com/electron-userland/electron-forge
[app-user-model-id]: https://msdn.microsoft.com/en-us/library/windows/desktop/dd378459(v=vs.85).aspx
[electron-release-server]: https://github.com/ArekSredzki/electron-release-server
[squirrel-updates-server]: https://github.com/Aluxian/squirrel-updates-server
[nuts]: https://github.com/GitbookIO/nuts
[squirrel-release-server]: https://github.com/Arcath/squirrel-release-server