ApikeeApikeeDocs
Administration

First-run setup

The six-step wizard that runs the first time you open a fresh instance.

A new instance opens the setup wizard instead of the dashboard. Every step except the workspace is optional and can be changed later in Admin → Settings.

1. Welcome

What the wizard is about to ask for. Nothing to fill in.

2. Domain

The public address of this instance, stored as app:url.

This matters more than it looks: OAuth callback URLs and every link in an outbound email are built from it. Set it to the HTTPS address users actually visit, not localhost.

Callbacks will be {APP_URL}/api/auth/callback/{provider} — the wizard shows them so you can paste them into your identity provider.

3. Workspace

The name and slug of your first workspace. The account running setup becomes its owner and is flagged as an instance administrator.

Optionally seed demo data — a sample project with endpoints and clients, useful for a first look and easy to delete.

4. Email

SMTP host, port, credentials and a from-address.

Without it the instance still works, but invitations, one-time sign-in codes and notifications cannot be delivered — which in practice means you cannot invite anyone. Worth doing now.

5. Sign-in

Enable GitHub, Google or generic OIDC, and decide whether public signups are allowed. ALLOW_SIGNUPS defaults to false, which is usually what you want.

See Authentication.

6. AI

Optionally point the instance at an AI endpoint. Two fields — endpoint URL and model — plus an optional key.

Skipping this leaves the assistant off. Nothing else is affected.

Afterwards

The instance marks setup complete (SETUP_COMPLETE) and the wizard stops appearing. Every value it collected lives in Admin → Settings, where saved values take precedence over the environment variables.

On this page