Skip to content

Backend OS Alpha Templates

Backend OS Alpha is an alpha validation path, not a cloud marketplace. It proves that one small-to-medium application can be scaffolded, inspected, started, backed up, and upgraded with Core plus official plugins.

Use the CLI scaffold path for the alpha experience:

Terminal window
cd plystra/plystra
go run ./cmd/plystractl templates list
go run ./cmd/plystractl templates describe auth-ready-saas
go run ./cmd/plystractl templates create --template auth-ready-saas --name "Acme SaaS" --out ./acme-saas
TemplatePurposeRequired pluginsRequired capabilities
blankMinimal production-alpha Core baseline.nonenone
internal-adminInternal operations backend with API key governance and webhook metadata requirements.plystra.api_keys, plystra.webhooksapi_key.credential standard
community-liteSmall community backend with moderation-oriented groups, roles, and permissions.plystra.moderationnone
auth-ready-saasSmall SaaS backend pairing Core with Complete Auth and transactional email.plystra.auth_completeemail.transactional standard

templates create writes an inspectable application directory:

FilePurpose
README.mdOperator instructions for the generated app.
.env.exampleProduction-oriented configuration template with placeholder secrets only.
docker-compose.ymlCore, PostgreSQL, and selected official plugin sidecars.
plystra/template-installation.jsonTemplate manifest, deployment profile, preview, required plugins, and capability requirements.
plystra/install-explanation.mdHuman-readable explanation of what the template declares and what must be reviewed.

The generator never writes real secrets, never applies migrations automatically, and never creates the first instance super admin.

The current alpha profile assumes:

  • one Plystra Core container.
  • official plugin sidecars when selected by a template.
  • external PostgreSQL 16+ for production alpha.
  • versioned migrations before startup.
  • non-sensitive mutable plugin settings stored in database tables.
  • secrets and process bootstrap values provided through environment variables or a secret manager.
  • health checks through /api/v1/health, /api/v1/ready, and plugin /health routes.
  • backups through PostgreSQL dump plus runtime config/secret-manager export.

Before treating a generated template as production-ready:

  1. Review every generated file.
  2. Replace all placeholder secrets.
  3. Configure production SERVER_PUBLIC_URL and explicit CORS origins.
  4. Apply and verify Core migrations.
  5. Apply selected plugin migrations.
  6. Bootstrap the first instance super admin explicitly.
  7. Configure required capability providers.
  8. Run plystractl doctor.
  9. Smoke test health, ready, login, API key creation, authz/check, audit logs, and selected plugin health routes.
  10. Test backup and restore in staging.

auth-ready-saas requires the Complete Auth plugin and email.transactional.

For production email:

plugin_auth_settings.email_delivery_mode = capability
plugin_auth_settings.email_capability_url = https://...
plugin_auth_settings.email_from_address = [email protected]

Then run either the SMTP provider or the Cloudflare Email Sending provider as an independent service implementing POST /contract/v1/email/send.

Backend OS Alpha does not include:

  • cloud hosting.
  • template marketplace.
  • third-party plugin trust model.
  • advanced plugin sandboxing.
  • automatic rollback for plugin upgrades.
  • hidden production secrets in generated files.

The point of Alpha is inspectability: developers can see exactly what the scaffold requires before running it.