Downloads and distributions

Offen is currently distributed in two ways: packaged as a single binary file for Linux, MacOS and Windows or as a Docker image. The most recent release is available here, Docker images are hosted on Docker Hub.


Table of contents

  1. Release channels
  2. Downloading binary files
  3. Verifying the binaries’ signatures
  4. Pulling the Docker image
  5. Click-To-Deploy
    1. Heroku

Release channels

Both for binaries and Docker images you can use one of these channels to pick your download:

Tagged releases

In case you want to deploy Offen, this channel is what you are most likely going to use. When ready, we cut official releases and tag them with a version identifier (e.g. v0.1.0). These releases are immutable and will never change, so both a download and the Docker image are guaranteed to provide the exact same build every time.

Stable channel

The stable channel gives you the most recent build from the master branch of our repository. These are usually stable and ready to use. Be aware that there is not necessarily an upgrade path in between stable versions.

Latest channel

The latest channel gives you the most recent build from the development branch of our repository. This is likely to contain things that are not production ready or bring other kinds of caveats. You probably should not use this unless you are participating in the development of Offen.


Downloading binary files

Binary files can be downloaded from our GitHub repository or using get.offen.dev. The most recent release is available here.

Downloading https://get.offen.dev will give you a tarball containing the most recent tagged release. If you specify a version or channel like https://get.offen.dev/v0.1.0-alpha.8 you will download that specific version.

# most recent release
curl -L https://get.offen.dev
# most recent build from the latest channel
curl -L https://get.offen.dev/latest
# build for v0.1.3
curl -L https://get.offen.dev/v0.1.3

Heads Up

The archive file currently contains the binaries for all supported operating systems, so no matter which OS you are targeting, you will always download the same file.

Verifying the binaries’ signatures

To prevent unwanted modifications of our releases, we sign all binaries using GPG and include the signature in our distribution. You can run the following commands to verify the integrity of your download:

curl https://keybase.io/hioffen/pgp_keys.asc | gpg --import
gpg --verify offen-linux-amd64.asc offen-linux-amd64

Pulling the Docker image

Docker images are available as offen/offen on Docker Hub. Tagged releases are available under the respective tag (e.g. offen/offen:v0.1.0). The stable and latest channel are available as image tags as well.

# v0.1.3 release
docker pull offen/offen:v0.1.3
# latest channel
docker pull offen/offen:latest

Heads Up

While our version tags on Docker Hub are immutable and will always return the same build, it is important to note that both stable and latest will be updated on a rolling basis. If you deploy Offen using Docker, make sure to use a version tag or pin your image’s revision.


Click-To-Deploy

We currently also offer “Click-To-Deploy” packages for the following hosting providers:

Heroku

You can deploy Offen to Heroku using our deployment template. We also offer a tutorial on this website.