Skip to content
Docs menu

Quick start

Run Excaliself and its Postgres database on your server with one compose file.

You need a server with Docker. The prebuilt image runs on amd64 and arm64, so nothing is built on your server.

Install

mkdir excaliself && cd excaliself
curl -fsSLO https://raw.githubusercontent.com/maciekzygmunt/excaliself/main/docker-compose.yaml
curl -fsSL -o .env https://raw.githubusercontent.com/maciekzygmunt/excaliself/main/.env.example

Fill in these three values in .env:

Variable Value
POSTGRES_PASSWORD openssl rand -hex 24
BETTER_AUTH_SECRET openssl rand -base64 32
BASE_URL The public URL users open, e.g. https://draw.example.com

Then start it:

docker compose up -d

Create the admin account

Open BASE_URL. The first visit goes to /setup, where you create the admin account. After that, sign-up is invite-only: admins send invite links from Settings.

Next steps

Edit this page on GitHub