Skip to content
Octarq

Quick start

octarq is a single binary. You need a .env with two secrets, then either build from source or run the Docker image.

1. Configure

Section titled “1. Configure”
Terminal window
cp .env.example .env   # then set OCTARQ_SECRET_KEY + OCTARQ_ADMIN_PASSWORD

OCTARQ_SECRET_KEY signs sessions; OCTARQ_ADMIN_PASSWORD is the first admin login. See Configuration for the full list.

2. Run

Section titled “2. Run”

From source

Section titled “From source”
Terminal window
make release   # builds the web dashboard + the Go binary
./octarq          # serves dashboard + API + redirects on :8080

With Docker

Section titled “With Docker”
Terminal window
docker compose up --build   # reads .env, persists data in a volume

For a tiny (~19 MB) scratch image with no Node stage — when the web assets are already built — use the binary-only Dockerfile:

Terminal window
docker build -f deploy/Dockerfile.binary -t octarq:latest .

3. Sign in

Section titled “3. Sign in”

Open http://localhost:8080 (it redirects to /admin) and sign in with OCTARQ_ADMIN_USER / OCTARQ_ADMIN_PASSWORD.

Next steps

Section titled “Next steps”