Skip to content

First-run setup

stratolms init asks a short set of questions when stdin is a TTY and --yes is absent: site name and URL, host adapter, payment provider, email delivery, signed video, progress store, whether to store learner emails, the owner dashboard, and an xAPI endpoint.

Terminal window
npm create stratolms@latest my-course
# or, non-interactive:
stratolms init my-course --adapter cloudflare --answers answers.json

--yes scaffolds the default-off site, the same as v1. --answers writes stratolms.config.mjs and fills missing .env keys (STRATO_SECRET, LEARNER_ID_KEY, MAINTENANCE_TOKEN, EMAIL_ENCRYPTION_KEY) without printing the secret values.

Keep the generated .env and fill in the provider credentials it still needs. The CLI’s next steps distinguish a setup-generated environment from a scaffold that still needs an environment file. Copying .env.example over the generated file would erase its generated keys and your settings.

Afterward:

Terminal window
cd my-course
pnpm install
pnpm stratolms doctor
pnpm stratolms check
pnpm dev

The local editor’s Setup screen uses the same writer. Cloudflare D1, R2 and Stream bindings are added to wrangler.jsonc when that adapter is selected. Run stratolms db migrate before turning the store on in production.

Setup updates only the answers you supply; omitted settings and existing secrets are retained. Explicit false or cleared values are edits. The editor reads safe editable settings rather than returning secret values. Automated config editing supports a static defineStratoConfig({ ... }) object; executable expressions or unsupported custom syntax produce an unsupported-config result before files are changed. Edit such configuration manually, then rerun the content/config checks.