Run QuietPacket locally

Start the website and status API on your own machine with Docker Compose.

Prerequisites

Use the local QuietPacket checkout, Git, and Docker Desktop with Linux containers. Ports 5173 and 8000 must be free. Initial image and dependency downloads require an internet connection. No cloud account or credentials are needed.

Start the local stack

From PowerShell in the project directory, build and start both services. Open the loopback address below; the public domain is not deployed by these commands.

# From the local project directory
docker compose up --build -d --wait
Start-Process http://127.0.0.1:5173

Check the API

The API is part of local development only. This static public site does not contact it. See the repository README for local liveness and readiness checks.

# API checks are local-only. See the repository README.

Stop without losing local state

Ordinary shutdown preserves the named SQLite volume. Avoid adding --volumes unless you deliberately want to erase the local database. See the repository README for native development and test commands.

docker compose down