{"id":15184505,"url":"https://github.com/areksredzki/electron-release-server","last_synced_at":"2025-04-13T22:28:21.658Z","repository":{"id":38184832,"uuid":"52715121","full_name":"ArekSredzki/electron-release-server","owner":"ArekSredzki","description":"A fully featured, self-hosted release server for electron applications, compatible with auto-updater.","archived":false,"fork":false,"pushed_at":"2024-04-22T04:21:09.000Z","size":553,"stargazers_count":2148,"open_issues_count":66,"forks_count":556,"subscribers_count":34,"default_branch":"master","last_synced_at":"2025-04-06T18:14:10.820Z","etag":null,"topics":["angularjs","electron","electron-application","nodejs","squirrel","update-server","updater"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ArekSredzki.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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":"2016-02-28T10:06:53.000Z","updated_at":"2025-04-04T15:52:35.000Z","dependencies_parsed_at":"2023-02-17T07:15:31.126Z","dependency_job_id":"4c3c906e-1c58-40b1-9c4c-924870f3a007","html_url":"https://github.com/ArekSredzki/electron-release-server","commit_stats":null,"previous_names":[],"tags_count":29,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ArekSredzki%2Felectron-release-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ArekSredzki%2Felectron-release-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ArekSredzki%2Felectron-release-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ArekSredzki%2Felectron-release-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ArekSredzki","download_url":"https://codeload.github.com/ArekSredzki/electron-release-server/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248790379,"owners_count":21162000,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["angularjs","electron","electron-application","nodejs","squirrel","update-server","updater"],"created_at":"2024-09-27T17:03:11.924Z","updated_at":"2025-04-13T22:28:21.025Z","avatar_url":"https://github.com/ArekSredzki.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Electron Release Server\n[![GitHub stars](https://img.shields.io/github/stars/ArekSredzki/electron-release-server.svg)](https://github.com/ArekSredzki/electron-release-server/stargazers)\n[![GitHub forks](https://img.shields.io/github/forks/ArekSredzki/electron-release-server.svg)](https://github.com/ArekSredzki/electron-release-server/network)\n[![Join the chat at https://gitter.im/ArekSredzki/electron-release-server](https://badges.gitter.im/ArekSredzki/electron-release-server.svg)](https://gitter.im/ArekSredzki/electron-release-server?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge\u0026utm_content=badge)\n\u003eA node web server which serves \u0026 manages releases of your [Electron](http://electron.atom.io) App, and is fully compatible with [Squirrel](https://github.com/Squirrel) Auto-updater (which is built into Electron).\n\n[![Electron Release Server Demo](https://j.gifs.com/wpyY1X.gif)](https://youtu.be/lvT7rfB01iA)\n\n_Note: Despite being advertised as a release server for Electron applications, it would work for **any application using Squirrel**._\n\nIf you host your project on your Github **and** do not need a UI for your app, then [Nuts](https://github.com/GitbookIO/nuts) is probably what you're looking for. Otherwise, you're in the same boat as I was, and you've found the right place!\n\n## Advisory Notices\n**IMPORTANT:**\n- Version `2.0.0` updates many packages, most importantly to SailsJS 1.x.x. At a bare minimum, you must rename `connections` to `datastores` in your `config/local.js` file. You may need to make further changes depending on how significantly you have customized the project.\n- The release of Angular `1.6.0` has broken all `electron-release-server` versions prior to `1.4.2`. Please use the instructions under the `Maintenance` heading below to update your fork! Sorry for the inconvenience.\n- Since release `1.5.0` several models have changed to accommodate new features. Please use the instructions under [Migration](docs/database.md#migration) to update your database! Sorry for the inconvenience.\n\n## Features\n- :sparkles: Docker :whale: support (thanks to EvgeneOskin)!\n- :sparkles: Awesome release management interface powered by [AngularJS](https://angularjs.org)\n    - Authenticates with LDAP, easy to modify to another authentication method if needed\n- :sparkles: Store assets on server disk, or Amazon S3 (with minor modifications)\n    - Use pretty much any database for persistence, thanks to [Sails](http://sailsjs.org) \u0026 [Waterline](http://waterlinejs.org)\n- :sparkles: Code-less [app customization through env variables](docs/customization.md)\n- :sparkles: Simple but powerful download urls (**NOTE:** when no assets are uploaded, server returns `404` by default):\n    - `/download/latest`\n    - `/download/latest/:platform`\n    - `/download/:version`\n    - `/download/:version/:platform`\n    - `/download/:version/:platform/:filename`\n    - `/download/channel/:channel`\n    - `/download/channel/:channel/:platform`\n    - `/download/flavor/:flavor/latest`\n    - `/download/flavor/:flavor/latest/:platform`\n    - `/download/flavor/:flavor/:version`\n    - `/download/flavor/:flavor/:version/:platform`\n    - `/download/flavor/:flavor/:version/:platform/:filename`\n    - `/download/flavor/:flavor/channel/:channel`\n    - `/download/flavor/:flavor/channel/:channel/:platform`\n- :sparkles: Support pre-release channels (`beta`, `alpha`, ...)\n- :sparkles: Support multiple flavors of your app\n- :sparkles: Auto-updates with [Squirrel](https://github.com/Squirrel):\n    - Update URLs provided:\n        - `/update/:platform/:version[/:channel]`\n        - `/update/flavor/:flavor/:platform/:version[/:channel]`\n    - Mac uses `*.dmg` and `*.zip`\n    - Windows uses `*.exe` and `*.nupkg`\n- :sparkles: Auto-updates with [NSIS differential updates for Windows](docs/update-windows.md#NSIS-differential-updates)\n- :sparkles: Serve the perfect type of assets: `.zip` for Squirrel.Mac, `.nupkg` for Squirrel.Windows, `.dmg` for Mac users, ...\n- :sparkles: Specify date of availability for releases\n- :sparkles: Release notes endpoint\n    - `/notes/:version/:flavor?`\n\n**NOTE:** if you don't provide the appropriate type of file for Squirrel you won't be able to update your app since the update endpoint will not return a JSON. (`.zip` for Squirrel.Mac, `.nupkg` for Squirrel.Windows).\n\n## Deploy it / Start it\n\n[Follow our guide to deploy Electron Release Server](docs/deploy.md).\n\n## Auto-updater / Squirrel\n\nThis server provides an endpoint for [Squirrel auto-updater](https://github.com/atom/electron/blob/master/docs/api/auto-updater.md), it supports both [OS X](docs/update-osx.md) and [Windows](docs/update-windows.md).\n\n## Documentation\n[Check out the documentation](docs/) for more details.\n\n## Building Releases\nI highly recommend using [electron-builder](https://github.com/loopline-systems/electron-builder) for packaging \u0026 releasing your applications. Once you have built your app with that, you can upload the artifacts for your users right away!\n\n## Maintenance\nYou should keep your fork up to date with the electron-release-server master.\n\nDoing so is simple, rebase your repo using the commands below.\n```bash\ngit remote add upstream https://github.com/ArekSredzki/electron-release-server.git\ngit fetch upstream\ngit rebase upstream/master\n```\n\n## Credit\nThis project has been built from Sails.js up by Arek Sredzki, with inspiration from [nuts](https://github.com/GitbookIO/nuts).\n\n## License\n[MIT License](LICENSE.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fareksredzki%2Felectron-release-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fareksredzki%2Felectron-release-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fareksredzki%2Felectron-release-server/lists"}