Quick start

This gets a headless Quorum API running from source. For the admin console and embeddable widgets as well, see Console and widgets locally, or skip the build entirely with Docker.

Prerequisites

• Go 1.26+
• PostgreSQL 14+ or SQL Server 2019+
• golang-migrate CLI

1. Get Quorum

git clone https://github.com/lawale/quorum.git
cd quorum
make build

2. Configure the database

Copy the example config and set your database credentials:

cp config.example.yaml config.yaml
# Edit config.yaml with your database details

3. Run migrations

Quorum keeps all of its tables in a dedicated quorum schema so it can share a database with your application. On PostgreSQL the schema must exist before the migrations run.

# PostgreSQL: create the quorum schema, then run migrations
psql "postgres://quorum:quorum@localhost:5432/quorum?sslmode=disable" -c "CREATE SCHEMA IF NOT EXISTS quorum;"
migrate -path migrations/postgres -database "postgres://quorum:quorum@localhost:5432/quorum?sslmode=disable&search_path=quorum" up

# SQL Server (schema is created automatically by migration 001)
migrate -path migrations/mssql -database "sqlserver://sa:Password@localhost:1433?database=quorum" up

4. Start the server

./bin/quorum -config config.yaml

The API is now live at http://localhost:8080. The default authentication mode is trust, which reads the caller’s identity from headers such as X-User-ID, so you can exercise the API with curl straight away.

Next steps

• Follow the wire transfer walkthrough to create a policy, a request and an approval.
• Read the REST API overview, or use the Go client.
• Review the configuration reference before deploying.