Hazel Documentation

Once Hazel is deployed, integrate it into your Electron application by setting the feed URL using the deployment address. Use process.platform and app.getVersion() to construct the update URL.

Note: Only perform this configuration in the production version of your app, not during development.

const { app, autoUpdater } = require('electron')

const server = <your-deployment-url>
const url = `${server}/update/${process.platform}/${app.getVersion()}`

autoUpdater.setFeedURL({ url })

Deploy Hazel to Vercel to create an update server for your Electron application. This server pulls release data from GitHub Releases and caches it in memory, providing direct links to GitHub assets to save bandwidth. It supports macOS and Windows and scales on Vercel Serverless Functions.

https://vercel.com/button

You can customize Hazel's behavior using the following environment variables:

You can integrate hazel-server into an existing Node.js HTTP server to implement custom logic, such as analytics, on specific paths.

const hazel = require('hazel-server')

http.createServer((req, res) => {
  hazel(req, res)
})

The main entry point of the hazel-server package is a factory function that accepts a config object. This function initializes a cache and sets up a router with several predefined routes for overview, downloads, and updates.

If the cache initialization fails with an error containing a code, the returned function will act as a middleware that responds with a 400 status code and a JSON error object containing the code and message. If the error does not contain a code, the initialization will throw the error.

The returned function is a standard Node.js request handler (req, res) => void compatible with most HTTP servers.

The hazel factory function (exported from lib/server.js) initializes a Hazel server instance using configuration provided via environment variables. This is the primary way to instantiate the server for programmatic use.

Required or supported environment variables:

• INTERVAL: The update interval.
• ACCOUNT: The account identifier.
• REPOSITORY: The repository identifier.
• PRE: A prefix for certain operations.
• TOKEN: The authentication token.
• URL: The private base URL (used if VERCEL_URL is not present).
• VERCEL_URL: The Vercel deployment URL.