{"id":16643397,"url":"https://github.com/xandemon/in-app-electron-auto-update-example","last_synced_at":"2026-04-17T19:31:09.138Z","repository":{"id":225272039,"uuid":"765517483","full_name":"xandemon/In-app-electron-auto-update-example","owner":"xandemon","description":"An Electron application example that supports in-app auto updating for both private and public projects","archived":false,"fork":false,"pushed_at":"2024-03-01T09:21:36.000Z","size":286,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-12T07:15:35.659Z","etag":null,"topics":["autoupdate","desktop-app","electron","electron-builder","electron-updater","electron-vite","example","template","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/xandemon.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-03-01T04:23:37.000Z","updated_at":"2024-03-01T09:18:58.000Z","dependencies_parsed_at":"2024-11-17T22:25:44.070Z","dependency_job_id":"cc869795-4d88-4873-a4fd-a9e0dac8b8f7","html_url":"https://github.com/xandemon/In-app-electron-auto-update-example","commit_stats":null,"previous_names":["xandemon/in-app-electron-auto-update-example"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/xandemon/In-app-electron-auto-update-example","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xandemon%2FIn-app-electron-auto-update-example","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xandemon%2FIn-app-electron-auto-update-example/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xandemon%2FIn-app-electron-auto-update-example/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xandemon%2FIn-app-electron-auto-update-example/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/xandemon","download_url":"https://codeload.github.com/xandemon/In-app-electron-auto-update-example/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xandemon%2FIn-app-electron-auto-update-example/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31943163,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-17T17:29:20.459Z","status":"ssl_error","status_checked_at":"2026-04-17T17:28:47.801Z","response_time":62,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["autoupdate","desktop-app","electron","electron-builder","electron-updater","electron-vite","example","template","typescript"],"created_at":"2024-10-12T08:08:20.993Z","updated_at":"2026-04-17T19:31:09.123Z","avatar_url":"https://github.com/xandemon.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# In-app Electron Auto-update Example\n\nThis repo contains the **bare minimum code** to have an auto-updating Electron app using [`electron-updater`](https://github.com/electron-userland/electron-builder/tree/master/packages/electron-updater) with releases stored on GitHub.\n\nIf you can't use GitHub, you can use other providers:\n\n- [Complete electron-updater HTTP example](https://gist.github.com/iffy/0ff845e8e3f59dbe7eaf2bf24443f104)\n- [Complete electron-updater from gitlab.com private repo example](https://gist.github.com/Slauta/5b2bcf9fa1f6f6a9443aa6b447bcae05)\n\n**NOTE:** If you want to run through this whole process, either fork this repo or [start your own from a template](https://github.com/iffy/electron-updater-example/generate). Then replace all instances of `iffy` with your GitHub username before doing the following steps.\n\n1. For macOS, you will need a code-signing certificate.\n\n   Install Xcode (from the App Store), then follow [these instructions](https://developer.apple.com/library/content/documentation/IDEs/Conceptual/AppDistributionGuide/MaintainingCertificates/MaintainingCertificates.html#//apple_ref/doc/uid/TP40012582-CH31-SW6) to make sure you have a \"Developer ID Application\" certificate. If you'd like to export the certificate (for automated building, for instance) [you can](https://developer.apple.com/library/content/documentation/IDEs/Conceptual/AppDistributionGuide/MaintainingCertificates/MaintainingCertificates.html#//apple_ref/doc/uid/TP40012582-CH31-SW7). You would then follow [these instructions](https://www.electron.build/code-signing).\n\n   This example application is set up to perform code-signing and notarization on Mac OS provided that a `Developer ID Application` certificate is installed in the default keychain. The following environment variables are important for the signing process:\n\n   - `CSC_IDENTITY_AUTO_DISCOVERY` - controls whether `electron-builder` tries to sign the application; default is `true`, set to `false` to skip signing\n   - `APPLE_ID` - the Apple ID to use for notarization (required for signing).\n   - `APPLE_ID_PASSWORD` - the password to use with the specified Apple ID for notarization (required for signing). Apple recommends setting up an app-specific password to safeguard the Apple ID password (see [Apple Support](https://support.apple.com/en-us/HT204397)) for more information.\n\n   To enable code-signing and notarization:\n\n   export CSC_IDENTITY_AUTO_DISCOVERY=\"true\"\n   export APPLE_ID=\"`\u003cyour Apple ID\u003e`\"\n   export APPLE_ID_PASSWORD=\"`\u003cyour Apple Password\u003e`\"\n\n2. Adjust `package.json` if needed.\n\n   By default, `electron-updater` will try to detect the GitHub settings (such as the repo name and owner) from reading the `.git/config` or from reading other attributes within `package.json`. If the auto-detected settings are not what you want, configure the [`publish`](https://github.com/electron-userland/electron-builder/wiki/Publishing-Artifacts#PublishConfiguration) property as follows:\n\n   {\n   ...\n   \"build\": {\n   \"publish\": [{\n   \"provider\": \"github\",\n   \"owner\": \"iffy\",\n   \"repo\": \"electron-updater-example\"\n   }],\n   ...\n   }\n   }\n\n3. Install necessary dependencies with:\n\n   yarn\n\n   or\n\n   npm install\n\n4. Generate a GitHub access token by going to [https://github.com/settings/tokens/new](https://github.com/settings/tokens/new). The access token should have the `repo` scope/permission. Once you have the token, assign it to an environment variable\n\n   On macOS/linux:\n\n   export GH_TOKEN=\"\u003cYOUR_TOKEN_HERE\u003e\"\n\n   On Windows, run in powershell:\n\n   [Environment]: :SetEnvironmentVariable(\"GH_TOKEN\",\"Make sure to restart your IDE/Terminal to inherit latest env variable.\n\n5. Publish for your platform with:\n\n   electron-builder -p always\n\n   or\n\n   npm run publish\n\n   If you want to publish for more platforms, edit the `publish` script in `package.json`. For instance, to build for Windows and macOS:\n\n   ...\n   \"scripts\": {\n   \"publish\": \"electron-builder --mac --win -p always\"\n   },\n   ...\n\n   NOTE: The Mac OS signing/notarization process must be run on Mac OS.\n\n6. Release the release on GitHub by going to [https://github.com/YOUR_GIT_HUB_USERNAME/electron-updater-example/releases](https://github.com/YOUR_GIT_HUB_USERNAME/electron-updater-example/releases), editing the release and clicking \"Publish release.\"\n7. Download and install the app from [https://github.com/YOUR_GIT_HUB_USERNAME/electron-updater-example/releases](https://github.com/YOUR_GIT_HUB_USERNAME/electron-updater-example/releases).\n8. Update the version in `package.json`, commit and push to GitHub.\n9. Do steps 5 and 6 again.\n10. Open the installed version of the app and see that it updates itself.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxandemon%2Fin-app-electron-auto-update-example","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fxandemon%2Fin-app-electron-auto-update-example","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxandemon%2Fin-app-electron-auto-update-example/lists"}