mirror of
https://github.com/stack-auth/stack.git
synced 2026-06-13 21:01:21 +08:00
44 lines
2.5 KiB
Plaintext
44 lines
2.5 KiB
Plaintext
---
|
|
title: "Launch Checklist"
|
|
description: "A guided checklist to make sure your project is ready for production"
|
|
icon: "clipboard-check"
|
|
---
|
|
|
|
The Launch Checklist is a built-in dashboard tool that walks you through everything you need to verify before going live. It checks your project configuration and guides you through each requirement, so nothing gets missed on launch day.
|
|
|
|
Enable it from the **App Store** in your [Stack Auth dashboard](https://app.stack-auth.com), then find it in your project sidebar.
|
|
|
|
## What it checks
|
|
|
|
The checklist is organized into four areas, each with specific sub-tasks:
|
|
|
|
### Domains & callbacks
|
|
|
|
- **Production domain saved** — At least one domain must be configured in your project's domain settings.
|
|
- **Localhost callbacks disabled** — The "Allow localhost" option must be turned off. Localhost should not be reachable in production.
|
|
|
|
### OAuth providers
|
|
|
|
- **Custom client IDs and secrets** — Any OAuth provider you've enabled (Google, GitHub, etc.) must use your own client credentials, not the shared defaults that Stack Auth provides for development. Shared credentials are not suitable for production.
|
|
|
|
The checklist includes expandable guides with callback URLs and setup instructions for each provider.
|
|
|
|
### Email server
|
|
|
|
- **Custom SMTP or Resend configured** — Your project must use your own email server, not Stack Auth's shared email service. This ensures reliable deliverability and lets you send from your own domain.
|
|
|
|
### Production mode
|
|
|
|
- **Automated checks passing** — Stack Auth runs a set of automated validations on your project config. These verify that all trusted domains use HTTPS, are not localhost, and are not raw IP addresses.
|
|
- **Production mode enabled** — Once all checks pass, you can flip the production mode toggle directly from the checklist. This locks down your project to production-ready settings.
|
|
|
|
<Info>
|
|
You can toggle production mode on and off directly from the Launch Checklist page. When you enable it for the first time, you'll get a confetti celebration.
|
|
</Info>
|
|
|
|
## How it works
|
|
|
|
The Launch Checklist doesn't have its own API — it reads your existing project configuration and evaluates readiness based on the settings you've already configured elsewhere (domains, OAuth providers, email server, etc.). Each task links directly to the relevant settings page so you can fix issues in context.
|
|
|
|
Progress is tracked visually with a progress bar and completion indicators. The checklist highlights the next action you need to take, making it easy to work through the tasks in order.
|