Text of github.com › electron › update.electronjs.org as Styx crawled it on Nov 19, 2026. The page may have changed since. Only its words are kept, without pictures or layout.

Open the live page

GitHub - electron/update.electronjs.org: 📡 A free service that makes it easy for open-source Electron apps to update themselves. · GitHub

Skip to content You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session. Dismiss alert Branches Tags Open more actions menu Latest commit History 315 Commits 315 Commits Folders and files Name Name Last commit message Last commit date .github .github .husky .husky .yarn/ releases .yarn/ releases bin bin example example src src test test .env.example .env.example .gitignore .gitignore .nvmrc .nvmrc .oxfmtrc.json .oxfmtrc.json .oxlintrc.json .oxlintrc.json .yarnrc.yml .yarnrc.yml Procfile Procfile README.md README.md package.json package.json tsconfig.json tsconfig.json vitest.config.ts vitest.config.ts yarn.lock yarn.lock Repository files navigation 📡 update.electronjs.org A free service that makes it easy for open-source Electron apps to update themselves.

Requirements Before using this service, make sure your Electron app meets these criteria: Your app runs on macOS or Windows Your app has a public GitHub repository Your builds are published to GitHub Releases Your builds are code signed (macOS and MSIX only) Quick Setup We provide update-electron-app as a zero-config runtime dependency to use update.electronjs.org with your Electron app. npm install update-electron-app Call it from in your main process file: require ( 'update-electron-app' ) ( ) And that's all it takes!

To customize, see the update-electron-app API . Once your application is packaged , it will update itself for each new GitHub Release that you publish. Manual Setup Use something like the following setup to add automatic updates to your application: Important Please ensure that the code below will only be executed in your packaged app, and not in development. You can use the app.isPackaged API to check for the environment. const { app , autoUpdater } = require ( 'electron' ) Next, construct the URL of the update server and tell autoUpdater about it: const server = 'https://update.electronjs.org' const feed = ` ${ server } /OWNER/REPO/ ${ process . platform } - ${ process . arch } / ${ app . getVersion ( ) } ` autoUpdater . setFeedURL ( feed ) As the final step, check for updates.

The example below will check every 10 minutes: setInterval ( ( ) => { autoUpdater . checkForUpdates ( ) } , 10 * 60 * 1000 ) Once your application is packaged , it will update itself for each new GitHub Release that you publish. Routes The following API endpoints are available: /:owner/:repo/:platform/:version /:owner/:repo/:platform-:arch/:version /:owner/:repo/:platform/:format/:version /:owner/:repo/:platform-:arch/:format/:version /:owner/:repo/:platform/:version/RELEASES These API endpoints support the query path arguments as defined below: :owner - GitHub repository owner (organization or user) :repo - GitHub repository name :platform - Platform type Windows: win32 macOS: darwin :arch - Architecture type Windows: x64 , ia32 , arm64 macOS: x64 , arm64 , universal :format - (Optional) Update format type squirrel - Squirrel.Windows (default for Windows when omitted) msix - MSIX auto-update (available on Electron 41+) :version - Semantic Versioning (SemVer) compatible application version number Asset Naming Convention This project supports specific naming conventions for GitHub Releases assets.

The following heuristics are used to identify update availability for a specific platform and architecture: macOS Assets Asset must be a .zip file. Asset name must include one of the following platform identifiers: -mac , -darwin , or -osx . Asset name may specify the architecture (if not specified, will default to -x64 ): -arm64 for Apple Silicon. -x64 for Intel-based macOS. -universal for Universal binaries. Example asset names: app-mac-arm64-0.0.1.zip app-mac-arm64.zip app-0.0.1-osx-x64.zip app-osx-x64.zip app-darwin-universal.zip app-mac.zip (no architecture specified - treated as -x64 ) Windows Assets (Squirrel) Asset must be a .zip or .exe file.

Asset name must include the -win32 platform identifier. Asset name may specify the architecture (if not specified, will default to -x64 ): -ia32 for 32-bit Windows. -x64 for 64-bit Windows. -arm64 for ARM-based Windows. .exe files without specific architecture tags or the -win32 platform identifier are assumed to be -x64 by default. Example asset names: app-win32-ia32-0.0.1.zip app-win32-ia32.zip app-0.0.1-win32-x64.zip app-win32-x64.zip app-win32-arm64.zip app-win32-arm64.exe app-win32-arm64-v1.2.3.exe app-win32.exe (no architecture specified - treated as -x64 ) app-installer.exe (generic .exe file with no architecture or platform identifier specified - treated as -x64 ) Windows Assets (MSIX) Asset must be a .msix file.

Asset name must include the -win32 platform identifier. Asset name may specify the architecture (if not specified, will default to -x64 ): -x64 for 64-bit Windows. -arm64 for ARM-based Windows. .msix files without specific architecture tags or the -win32 platform identifier are assumed to be -x64 by default. Example asset names: app-win32-x64.msix app-1.0.0-win32-x64.msix app-win32-arm64.msix app-win32.msix (no architecture specified - treated as -x64 ) app-installer.msix (generic .msix file with no architecture or platform identifier specified - treated as -x64 ) To use MSIX updates, include the msix format segment in the update feed URL: const server = 'https://update.electronjs.org' const feed = ` ${ server } /OWNER/REPO/ ${ process . platform } - ${ process . arch } /msix/ ${ app . getVersion ( ) } ` autoUpdater . setFeedURL ( feed ) The MSIX updater returns the same JSON format as macOS ( { name, notes, url } ) and does not use the RELEASES endpoint.

Development There are two development servers available: Production server This runs the full server with Redis caching and GitHub API integration. You'll first need to have a running Redis server. There are two options: Locally: Install Redis locally and run it directly with redis-server . Learn how to install Redis on the Redis website . Docker: Install and run Redis with docker run -p 6379:6379 -it redis/redis-stack-server:latest .

Then run the server: yarn GH_TOKEN=TOKEN yarn start Test server This runs a lightweight server with an in-memory cache and no external dependencies (no Redis or GH_TOKEN required). Useful for local development and testing. yarn yarn start-test-server Sample app To try with an actual electron app, run: yarn start & cd example yarn On Darwin: yarn build ./out/test-darwin-x64/test.app/Contents/MacOS/test On Windows: yarn run build " example\out\make\squirrel.windows\x64\test-0.0.0 Setup.exe " About 📡 A free service that makes it easy for open-source Electron apps to update themselves.

Resources Readme Code of conduct Code of conduct Activity Custom properties Stars 705 stars Watchers 52 watching Forks 85 forks Report repository Releases Packages Used by Contributors Languages You can’t perform that action at this time.