-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
03fb495
commit 72f5e03
Showing
1 changed file
with
2 additions
and
107 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,108 +1,3 @@ | ||
| # Hazel | ||
| # ChecklistsPro Releases Repository | ||
|
|
||
| [](https://circleci.com/gh/vercel/hazel/tree/master) | ||
| [](https://github.com/sindresorhus/xo) | ||
|
|
||
| This project lets you deploy an update server for [Electron](https://www.electronjs.org) apps with ease: You only need to click a button. | ||
|
|
||
| The result will be faster and more lightweight than any other solution out there! :rocket: | ||
|
|
||
| - Recommended by Electron [here](https://www.electronjs.org/docs/tutorial/updates#deploying-an-update-server) | ||
| - Built on top of [micro](https://github.com/zeit/micro), the tiniest HTTP framework for Node.js | ||
| - Pulls the latest release data from [GitHub Releases](https://help.github.com/articles/creating-releases/) and caches it in memory | ||
| - Refreshes the cache every **15 minutes** (custom interval [possible](#options)) | ||
| - When asked for an update, it returns the link to the GitHub asset directly (saves bandwidth) | ||
| - Supports **macOS** and **Windows** apps | ||
| - Scales infinitely on [Vercel](https://vercel.com) Serverless Functions | ||
|
|
||
| ## Usage | ||
|
|
||
| Open this link in a new tab to deploy Hazel on [Vercel](https://vercel.com): | ||
|
|
||
| [](https://vercel.com/new/git/external?repository-url=https%3A%2F%2Fgithub.com%2Fvercel%2Fhazel&env=ACCOUNT,REPOSITORY&envDescription=Enter%20your%20GitHub%20user%2Forg%20slug%20and%20the%20name%20of%20the%20repository%20that%20contains%20your%20Electron%20app.&envLink=https%3A%2F%2Fgithub.com%2Fvercel%2Fhazel%23usage&repo-name=hazel-update-server) | ||
|
|
||
| Once it's deployed, paste the deployment address into your code (please keep in mind that updates should only occur in the production version of the app, not while developing): | ||
|
|
||
| ```js | ||
| const { app, autoUpdater } = require('electron') | ||
|
|
||
| const server = <your-deployment-url> | ||
| const url = `${server}/update/${process.platform}/${app.getVersion()}` | ||
|
|
||
| autoUpdater.setFeedURL({ url }) | ||
| ``` | ||
|
|
||
| That's it! :white_check_mark: | ||
|
|
||
| From now on, the auto updater will ask your Hazel deployment for updates! | ||
|
|
||
| ## Options | ||
|
|
||
| The following environment variables can be used optionally: | ||
|
|
||
| - `INTERVAL`: Refreshes the cache every x minutes ([restrictions](https://developer.github.com/changes/2012-10-14-rate-limit-changes/)) (defaults to 15 minutes) | ||
| - `PRE`: When defined with a value of `1`, only pre-releases will be cached | ||
| - `TOKEN`: Your GitHub token (for private repos) | ||
| - `URL`: The server's URL (for private repos - when running on [Vercel](https://vercel.com), this field is filled with the URL of the deployment automatically) | ||
|
|
||
| ## Statistics | ||
|
|
||
| Since Hazel routes all the traffic for downloading the actual application files to [GitHub Releases](https://help.github.com/articles/creating-releases/), you can use their API to determine the download count for a certain release. | ||
|
|
||
| As an example, check out the [latest Hyper release](https://api.github.com/repos/vercel/hyper/releases/latest) and search for `mac.zip`. You'll find a release containing a sub property named `download_count` with the amount of downloads as its value. | ||
|
|
||
| ## Routes | ||
|
|
||
| ### / | ||
|
|
||
| Displays an overview page showing the cached repository with the different available platforms and file sizes. Links to the repo, releases, specific cached version and direct downloads for each platform are present. | ||
|
|
||
| ### /download | ||
|
|
||
| Automatically detects the platform/OS of the visitor by parsing the user agent and then downloads the appropriate copy of your application. | ||
|
|
||
| If the latest version of the application wasn't yet pulled from [GitHub Releases](https://help.github.com/articles/creating-releases/), it will return a message and the status code `404`. The same happens if the latest release doesn't contain a file for the detected platform. | ||
|
|
||
| ### /download/:platform | ||
|
|
||
| Accepts a platform (like "darwin" or "win32") to download the appropriate copy your app for. I generally suggest using either `process.platform` ([more](https://nodejs.org/api/process.html#process_process_platform)) or `os.platform()` ([more](https://nodejs.org/api/os.html#os_os_platform)) to retrieve this string. | ||
|
|
||
| If the cache isn't filled yet or doesn't contain a download link for the specified platform, it will respond like `/`. | ||
|
|
||
| ### /update/:platform/:version | ||
|
|
||
| Checks if there is an update available by reading from the cache. | ||
|
|
||
| If the latest version of the application wasn't yet pulled from [GitHub Releases](https://help.github.com/articles/creating-releases/), it will return the `204` status code. The same happens if the latest release doesn't contain a file for the specified platform. | ||
|
|
||
| ### /update/win32/:version/RELEASES | ||
|
|
||
| This endpoint was specifically crafted for the Windows platform (called "win32" [in Node.js](https://nodejs.org/api/process.html#process_process_platform)). | ||
|
|
||
| Since the [Windows version](https://github.com/Squirrel/Squirrel.Windows) of Squirrel (the software that powers auto updates inside [Electron](https://www.electronjs.org)) requires access to a file named "RELEASES" when checking for updates, this endpoint will respond with a cached version of the file that contains a download link to a `.nupkg` file (the application update). | ||
|
|
||
| ## Programmatic Usage | ||
|
|
||
| You can add Hazel to an existing HTTP server, if you want. For example, this will allow you to implement custom analytics on certain paths. | ||
|
|
||
| ```js | ||
| const hazel = require('hazel-server') | ||
|
|
||
| http.createServer((req, res) => { | ||
| hazel(req, res) | ||
| }) | ||
| ``` | ||
|
|
||
| ## Contributing | ||
|
|
||
| 1. [Fork](https://help.github.com/articles/fork-a-repo/) this repository to your own GitHub account and then [clone](https://help.github.com/articles/cloning-a-repository/) it to your local device | ||
| 2. Move into the directory of your clone: `cd hazel` | ||
| 3. Install [Vercel CLI](https://vercel.com/cli) and run the development server: `vercel dev` | ||
|
|
||
| ## Credits | ||
|
|
||
| Huge thanks to my ([@leo](https://github.com/leo)'s) friend [Andy](http://twitter.com/andybitz_), who suggested the name "Hazel" (since the auto updater software inside [Electron](https://www.electronjs.org) is called "Squirrel") and [Matheus](https://twitter.com/matheusfrndes) for collecting ideas with me. | ||
|
|
||
| ## Author | ||
|
|
||
| Leo Lamprecht ([@notquiteleo](https://twitter.com/notquiteleo)) - [Vercel](https://vercel.com) | ||
| ChecklistsPro releases can be found in the releases section of this repo |
72f5e03There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Successfully deployed to the following URLs: