// docs

Getting started

From first run to first filed fail in about ten minutes. Pull the image, set an admin password, and work the sample deck — mark each case by eye, and watch a failure leave with its evidence bundle already attached.

Teasynaer ships as a Docker image with a bundled sample Auth deck, so you can go from docker compose up to marking your first case in one sitting. There is no SaaS tier and no signup — everything runs on your machine.

1. Bring it up

cp .env.example .env        # then set TEASYNAER_ADMIN_PASSWORD in .env (required)
docker compose up           # starts the app + Postgres 16
# → http://localhost:8080

Compose reads .env. TEASYNAER_ADMIN_PASSWORD has no default — compose refuses to start until you set one, so a stock deploy can never boot with a published password. Migrations run automatically at container start, and a bootstrap admin is created from TEASYNAER_ADMIN_EMAIL / TEASYNAER_ADMIN_PASSWORD.

2. Sign in

Log in as the bootstrap admin. Teasynaer forces a password change on first login, so the value from .env is only ever used once. Authentication is a built-in local-admin account with hardened, DB-backed sessions — there is no external identity provider to wire up to get started. (OIDC and reverse-proxy auth are on the roadmap.)

3. Work the deck

Open the seeded Auth package and step through its cases one at a time. Mark each by key — p pass · f fail · s skip — or swipe the card left, right, or down. There is no sidebar; ⌘K (Ctrl-K) opens the command palette for everything else. Close the tab mid-run and the deck resumes exactly where you left off.

4. File a fail

On a fail, Teasynaer files a tracked issue — case, steps, notes — with an evidence bundle attached, once you have configured a tracker. GitHub is the default, self-host-ready adapter; set QA_TRACKER, a repo and a token (and TRACKER_CREDENTIALS_KEY, openssl rand -hex 32, before you save credentials in the admin UI). If no tracker is wired up yet, you can export the packet and file it by hand instead. See Self-hosting and Evidence & redaction for the next steps.

← All docs