Requirements: Docker with Compose v2.24 or newer, curl, and OpenSSL. No local Node.js, pnpm, Elixir, or PostgreSQL installation is needed. See the operator guide for deployment details and all maintenance procedures.
-
Create a directory and download the deployment files:
mkdir signet cd signet curl -fsSLO https://raw.githubusercontent.com/Christopher2K/signet/main/compose.yaml curl -fsSLO https://raw.githubusercontent.com/Christopher2K/signet/main/.env.example cp .env.example .env -
Generate two secrets:
openssl rand -hex 32 openssl rand -hex 48
In
.env, replacePOSTGRES_PASSWORDwith the first value andSECRET_KEY_BASEwith the second. KeepPHX_HOST=localhostfor local HTTP. For a public deployment, follow the release-tag instructions below before starting Signet. -
Pull and start Signet:
docker compose pull docker compose up -d
-
Open http://localhost:8080 and create an account. API readiness is available at http://localhost:8080/healthz.
The first published release requires a maintainer to make both GHCR packages public; see GHCR package visibility.
Clone the repository, copy .env.example to .env, and generate secrets as above. Then run:
docker compose -f compose.yaml -f compose.build.yaml up --build -dThis creates local signet-api:local and signet-web:local images without pulling the application images from GHCR.
For a direct public deployment, create a public DNS A record for the server's IPv4 address, allow inbound TCP ports 80 and 443, and set this in .env:
SIGNET_DOMAIN=signet.example.com
SIGNET_VERSION=1.2.3Registry-only installations must download the base and HTTPS Compose files from the matching release tag. Replace both occurrences of v1.2.3 and the SIGNET_VERSION value together when choosing another release:
curl -fsSLO https://raw.githubusercontent.com/Christopher2K/signet/v1.2.3/compose.yaml
curl -fsSLO https://raw.githubusercontent.com/Christopher2K/signet/v1.2.3/compose.https.yaml
docker compose -f compose.yaml -f compose.https.yaml pull
docker compose -f compose.yaml -f compose.https.yaml up -dOpen https://signet.example.com. Use the same public server URL in the browser and native clients. For source builds, add -f compose.build.yaml before -f compose.https.yaml and use up --build -d instead of pull and up.
Do not expose the default local HTTP configuration publicly. DNS, firewall, existing reverse proxy, and certificate troubleshooting details are in the public deployment guide.
The operator guide covers:
- service status and logs;
- stable upgrades and rollback limits;
- tested PostgreSQL backup and restore commands;
- operator password resets;
- named volumes and safe removal.
Migrations run automatically before Phoenix starts. PostgreSQL, account, bookmark, and session data persist in db_data; Caddy certificate and configuration state persist in caddy_data and caddy_config. docker compose down removes containers and the network without deleting these volumes; a subsequent docker compose up -d recreates the services. Never add --volumes unless you intend to permanently delete that deployment's data.