Skip to content

Getting Started

Colton Jones edited this page Sep 22, 2026 · 1 revision

Getting started

Pick the path that matches what you are doing. Each row points at the reviewed procedure in the repository; follow that document, not a summary of it.

Evaluate or install a stack

  1. Read the readiness note and the open residuals. Recovery and cutover proof are still open, so plan evaluations, not production cutovers.

  2. Choose a path in the Installation guide:

    Situation Runbook
    Bare Ubuntu 26.04 server on a Windows LAN install-ubuntu-server.md
    Host with internet access install-online.md
    No outbound internet install-airgapped.md
    Hyper-V appliance on Windows Server appliance-install.md
  3. Provision the WORM bucket first: minio-object-lock-prereq.md.

  4. Complete first-run setup at /setup without signing in first. The wizard creates the first administrator from a one-time bootstrap secret (./scripts/easysynq setup mint-bootstrap).

  5. Configure backups and run a restore drill: backup-restore.md.

Set up a development host

The supported developer host is Ubuntu 26.04 on x86_64 (R71).

./scripts/doctor.sh contributor   # read-only; names each missing tool and the command that installs it
just setup                        # hydrate the locked Python and npm trees, hooks and contracts
cp .env.example .env && chmod 600 .env
just up s                         # S-profile stack at http://localhost

Use http://localhost, never a bare hostname: OIDC PKCE needs a secure context. The full, reviewed procedure is fresh-linux-setup.md; native Windows notes live in .claude/rules/windows-dev.md.

Optional post-setup fixtures: just demo-user and just seed-personas.

Use the application

The User manual covers documents, reviews, registers, audits, CAPA, change requests and notifications. Administrators use the Administrator & IT manual.

Clone this wiki locally