https://github.com/GitbookIO/nuts

:chestnut: Releases/downloads server with auto-updater and GitHub as a backend
https://github.com/GitbookIO/nuts

Last synced: 4 months ago
JSON representation

:chestnut: Releases/downloads server with auto-updater and GitHub as a backend

• Host: GitHub
• URL: https://github.com/GitbookIO/nuts
• Owner: GitbookIO
• License: apache-2.0
• Created: 2015-08-13T06:26:22.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2023-10-04T11:07:55.000Z (over 1 year ago)
• Last Synced: 2024-04-14T10:57:05.346Z (10 months ago)
• Language: JavaScript
• Homepage: http://nuts.gitbook.com
• Size: 174 KB
• Stars: 1,233
• Watchers: 23
• Forks: 297
• Open Issues: 84
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-electron - nuts - Releases/downloads server with auto-updater and GitHub as a backend.  (Library / Auto Updater/Release Server)
• awesome-electron-zh - nuts - Releases server with auto-updater and GitHub as a backend. (Tools / For Electron)

README

        
# Nuts

Nuts is a simple (and smart) application to serve desktop-application releases.

![Schema](./docs/schema.png)

It uses GitHub as a backend to store assets, and it can easily be deployed to Heroku as a stateless service. It supports GitHub private repositories (useful to store releases of a closed-source application available on GitHub).

[![Deploy](https://www.herokucdn.com/deploy/button.png)](https://heroku.com/deploy)

#### Features

- :sparkles: Store assets on GitHub releases

- :sparkles: Proxy releases from private repositories to your users

- :sparkles: Simple but powerful download urls

    - `/download/latest`

    - `/download/latest/:os`

    - `/download/:version`

    - `/download/:version/:os`

    - `/download/channel/:channel`

    - `/download/channel/:channel/:os`

- :sparkles: Support pre-release channels (`beta`, `alpha`, ...)

- :sparkles: Auto-updates with [Squirrel](https://github.com/Squirrel)

    - For Mac using `/update?version=&platform=osx`

    - For Windows using Squirrel.Windows and Nugets packages

- :sparkles: Private API

- :sparkles: Use it as a middleware: add custom analytics, authentication

- :sparkles: Serve the perfect type of assets: `.zip` for Squirrel.Mac, `.nupkg` for Squirrel.Windows, `.dmg` for Mac users, ...

- :sparkles: Release notes endpoint

    - `/notes/:version`

- :sparkles: Up-to-date releases (GitHub webhooks)

- :sparkles: Atom/RSS feeds for versions/channels

#### Deploy it / Start it

[Follow our guide to deploy Nuts](https://nuts.gitbook.com/deploy.html).

#### Auto-updater / Squirrel

This 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](https://nuts.gitbook.com/update-osx.html) and [Windows](https://nuts.gitbook.com/update-windows.html).

#### Documentation

[Check out the documentation](https://nuts.gitbook.com) for more details.