Quickstart

한국어로 보기

Quickstart

Use this path to run a first toard server with Docker Compose and verify that the application and database are ready. For platform-specific deployment choices, see Deploying-toard.

Prerequisites

Install Docker Compose v2 and curl on the host.

docker compose version
curl --version

Start the server

AUTH_SECRET is required. Generate it on the deployment host and keep it out of source control and command history where possible.

AUTH_SECRET=$(openssl rand -base64 33) docker compose up -d

Compose starts the application and Postgres, then runs migrations before the application becomes ready. The default local address is http://localhost:3000; set PORT if that port is already in use.

For unattended provisioning, provide administrator details through your deployment's secret-management mechanism as BOOTSTRAP_ADMIN_EMAIL and BOOTSTRAP_ADMIN_PASSWORD. Do not put a real password in a Wiki page, shell history, or version control.

Create the first administrator

On a new installation with no users, opening the server directs you to /setup to create the first administrator. If bootstrap administrator variables were supplied, this setup step is skipped.

Verify the installation

Run these checks on the deployment host:

curl -fsS http://localhost:3000/api/health
curl -fsS http://localhost:3000/api/ready
docker compose ps -a

Success means both HTTP checks return successfully, app and postgres are running, and migrate has exited successfully. Then sign in through the server's login page with the administrator account you created.

Next steps

• To connect developers and verify their first event, continue with Roll-out-your-team.
• To use a reverse proxy, managed database, Kubernetes, or Helm, read Deploying-toard.
• For the complete deployment contract and options, use docs/DEPLOY.md as the source of truth.