docs / getting-started / quick-start

Quick start

From zero to issuing passes in one command.

One command checks prerequisites, downloads the compose stack, generates secrets, asks for your domain and owner wallet, and starts everything:

curl -fsSL https://raw.githubusercontent.com/cauu/ouro-pass/main/deploy/install.sh | sh

Prefer to inspect before running, or automate it in CI:

# review first
curl -fsSLO https://raw.githubusercontent.com/cauu/ouro-pass/main/deploy/install.sh
less install.sh && sh install.sh

# non-interactive
curl -fsSL …/install.sh \
  | OURO_DOMAIN=pass.example.com OURO_OWNER_ADDR=stake1… sh -s -- --non-interactive

Manual setup

You don’t need the source tree — fetch only the compose stack, bootstrap secrets, and start:

./deploy/init.sh                 # .env + random secrets + ./data dirs
docker run --rm ghcr.io/cauu/ouro-pass stake-hash stake1…   # owner key hash
$EDITOR .env                     # set DOMAIN + OUROPASS_OWNER_KEYS
docker compose up -d             # issuer + postgres + caddy

Then open https://<DOMAIN>/admin and sign in with your owner wallet.

Found an issue in these docs? Edit this page on GitHub ↗