RELEASES DOCUMENTATION

Setup & integration

The shortest path from a compiled build to a private, authenticated software update.

1. Start the stack

./scripts/generate-env.sh
docker compose up -d --build

Terminate TLS at your reverse proxy and point RELEASES_BASE_URL at the public HTTPS address.

2. Create repository credentials

Create one Publisher key for your workstation or CI pipeline and one or more Client keys for shipped applications. Keys are scoped to one repository and secrets are shown only once.

3. Push a build

releases login --url https://releases.sourcefab.net --token 'bvp_…'
releases push ./dist --repo my-app --version 1.4.0 --channel stable --publish

The CLI chunks locally, asks which hashes already exist, uploads only missing content, then commits the artifact manifest.

Generic update check

GET /api/v1/client/repos/my-app/update
  ?current_version=1.3.0
  &channel=stable
  &platform=linux
  &arch=x64
Authorization: Bearer bvc_…

Successful responses include checksums, protected download URLs and an Ed25519 manifest signature.

Electron updater

provider: "generic"
url: "https://releases.sourcefab.net/electron/my-app/stable/win32/x64/"
requestHeaders:
  Authorization: "Bearer bvc_…"

Upload the full electron-builder output so installers, latest*.yml and .blockmap files stay together.