Site Setup
Site Setup is the one-time onboarding step shown to brand-new tenants the first time they sign in. It registers the domain where the BreakGround SDK will run, issues the API key you'll use to install the SDK, and kicks off AI mapping of your site. After completing this step you land in the dashboard and won't see this page again — ongoing site management lives in Settings > Sites.
Step 1: Site Details
Fill in the two required fields:
- Domain — the host where the SDK will run (e.g.
app.example.com). The value is validated as a domain and normalized to lowercase. - Site Name — a short label used in the dashboard to identify this site. Up to 20 characters.
Click Continue to create the site. The platform issues a fresh API key, opens the Enable AI creation dialog on top of the screen, and reveals the API key panel underneath.
Step 2: Enable AI Mapping
The Enable AI creation dialog opens automatically as soon as your site is created. Provide demo-account credentials so our crawler can sign in and walk through your application — this is what powers AI-assisted authoring later.
| Field | What to enter |
|---|---|
| Login URL | The sign-in page on your site, e.g. https://app.example.com/login must be on the same domain as the site you just registered. |
| Demo username / email | The username or email of a dedicated demo account. |
| Demo password | The password for the demo account. Stored encrypted at rest and used only for mapping. |
Use a dedicated demo account, not real customer or admin credentials. The crawler signs in as this user and explores authenticated pages on your behalf. Treat the account as you would any service credential — give it the minimum access needed to view representative pages.
Click Verify & start mapping. BreakGround first loads your login URL in a headless browser to confirm the credentials work; only then is the mapping job queued. If verification fails, you'll see one of these messages:
| Message | What to check |
|---|---|
| "Those credentials didn't work on the login page." | Username/password typo, or the demo account is locked or expired. |
| "We couldn't find a login form at that URL." | The Login URL doesn't render a sign-in form — point it at the actual login page. |
| "That URL didn't load. Make sure it's reachable." | The URL is unreachable, behind a VPN, or returning a non-2xx response. |
| "Verification timed out." | The login page takes too long to render — retry or use a faster page. |
Once verification succeeds, a confirmation dialog appears letting you know mapping has started. You'll receive an email when it's done (it can take up to an hour for large sites). You can close the dialog and keep working in the meantime.
Don't have demo credentials ready? You can close the dialog and skip mapping for now. Re-open it later from any site card on Settings > Sites by clicking Enable AI.
Step 3: Save Your API Key
Behind the AI creation dialog, your full API key is shown in a monospace block with a Copy button. After you start mapping (or close the dialog), this is the next thing to handle.
This is the only time the full key is displayed during onboarding. Copy it into your password manager, secrets vault, or environment variable store before leaving this screen. If you lose it, you'll need to regenerate the key from Settings > Sites.
Once you've saved the key:
- Tick I've saved my API key somewhere safe.
- Click Continue to enter the dashboard.
What Happens Next
When you finish onboarding, two things happen in parallel:
- AI Mapping runs in the background. The crawler signs in with your demo credentials and walks the application to build a map of pages, selectors, and routes. You can watch the status from the Sites page — see AI Mapping. You'll also receive an email when the mapping job finishes.
- Your dashboard becomes available. From here you can install the SDK, invite team members, and start authoring content.
The natural next step is installing the SDK on your domain. Head to SDK Installation for the snippet and framework-specific guides.