Skip to content
Octarq

Quickstart

Get Octarq up and running on your server or local environment in minutes using Docker Compose or single binary builds.

1. Quick Start with Docker Compose

Terminal window
git clone https://github.com/octarq-org/octarq.git && cd octarq
cp .env.example .env          # set OCTARQ_SECRET_KEY and OCTARQ_ADMIN_PASSWORD
docker compose up -d

Open http://localhost:8080 and log in. That’s the full stack — dashboard, API, redirector, MCP — in one container backed by SQLite.

Prefer a ~19MB scratch image or from-source build? See make release and deploy/.

2. Environment Setup

Create .env based on .env.example:

OCTARQ_SECRET_KEY=your-32-byte-secret-key
OCTARQ_ADMIN_PASSWORD=your-secure-admin-password
OCTARQ_PORT=8080
  • Database: SQLite database stored automatically as octarq.db (no separate DB container required).
  • Authentication: Admin account configured via environment variables.

3. Consuming @octarq/plugin-sdk

If you are developing plugins or extensions, configure @octarq-org in your consumer project’s .npmrc:

@octarq-org:registry=https://npm.pkg.github.com
//npm.pkg.github.com/:_authToken=${GITHUB_TOKEN}

Set your token and install dependencies:

Terminal window
export GITHUB_TOKEN=ghp_xxx
pnpm install