← All guides

Quick start

Start an authenticated PiChamber server and open its browser UI.

Start a local server:

pichamber serve

In an interactive terminal, PiChamber asks where to listen, which port and password to use, whether to serve the browser UI, and whether to run in the background. Review the choices and confirm. For a script or non-interactive shell, provide the values yourself:

pichamber serve --port 3000 --ui-password "choose-a-strong-password"

Open the URL printed by the command. The server starts its private Pi session daemon and loads the Pi configuration and sessions belonging to that host.

Use the Local network choice or --lan only on a trusted network. Always set --ui-password when the server can be reached by another device. To pair a phone or another browser, run pichamber connect-url --qr on the server and scan the one-time link.

You should land on the PiChamber session list and be able to start a new Pi session. If the browser reports that Pi is unavailable, see Troubleshooting. For the full set of guided and scripted commands, see the CLI guide.

Docker

Copy docker-compose.yml from the repository, set PICHAMBER_UI_PASSWORD, and run docker compose up -d. Open the URL in the container logs, then pair other devices from the browser UI. See Run PiChamber in Docker for projects, persistent data, upgrades, and ways to reuse an existing Pi configuration.

These guides are synced from the PiChamber repository at 720cb33 and may lag behind main. Spot something stale? Propose an edit upstream, then re-run npm run sync:docs here.