Guides

The guides tell a developer and a hosting provider how to run and operate the API.

• Run the API locally -- the simple and the full local setup, CORS, the deployment program and a password-protected SSH key.
• Incus -- the Incus setup that a deployment needs, and how to give the deployer its Incus credentials.
• Pin the schema of the default source -- how to freeze the schema baseline with SELF_MODULE_SOURCE, and how to pin the schema to one deployment method with PIN_EFFECT.
• Windmill and Centrifugo in production -- which modules deploy Windmill and Centrifugo for production.
• Sending authorized requests from the Swagger UI -- how to get a token and send it with each request.
• Running tests -- how to run the API tests and the end-to-end deployment tests.
• Deploying (extending the base model) -- the deploy family of flake attributes.