Console

The console is the web dashboard for sandboxes, templates, volumes, API keys and organizations. It runs next to the control plane, on its own hostname.

Turn it on

Point a DNS name such as app.example.com at the control plane, then pass it to setup.sh.

# on the control plane, in platinum/infra/compose
./setup.sh --console-domain app.example.com
docker compose up -d

setup.sh adds the console profile and, when the console and API names are siblings, sets PT_COOKIE_DOMAIN to their parent (.example.com). The console's terminal connects to the API directly, so it needs that shared cookie.

Compose sets PT_PUBLIC_APP_ORIGIN to https://app.example.com, so sign-in, invite and reset links point at the console. The image reads the API URL when it starts, so a new PT_DOMAIN needs only docker compose up -d.

Create the first account

Open https://app.example.com/dashboard and sign up with an address listed in PT_ADMIN_EMAILS. setup.sh --email put yours there.

A listed address can always sign up, even in invite-only mode. It becomes a platform admin once the address is verified: through the emailed link, or by signing in with Google.

A regular account still creates sandboxes and API keys in its own organization. The ADMIN_TOKEN covers operator tasks either way.

Create an API key

Open API Keys in the dashboard and create a key. Then point the SDK or CLI at your API:

export PT_API_URL=https://api.example.com
export PT_TOKEN=pt_live_…

Every guide in these docs works the same against your install. Start with the Quickstart.

Invite people

setup.sh sets PT_SIGNUP_MODE=invite-only. Anyone else needs a pending invite for their exact address, sent from the console. Invites are emailed, so they also need an email provider.

Google and GitHub sign-in appear when GOOGLE_CLIENT_* or GITHUB_CLIENT_* is set.

Know the routes

Fix common problems