# Host documentation site with Django: Postgres-backed content

Deploy a documentation site built with Django on Ample using the relational records pattern. Compute runs the app in an isolated microVM behind a public HTTPS URL, a managed PostgreSQL 16 database is auto-provisioned and injected as DATABASE_URL, and a published bucket serves public assets from the CDN host.

## Summary
Verified on Django: a workspace-scoped table, an explicit state machine (draft to review to published) that rejects invalid transitions, and a cross-workspace read that returns nothing (transitions=true isolation=true). Not separately tested: your record schema, states and access rules; treat the documentation site-specific behavior as your application code.

## Representative Queries
- Host documentation site with Django: Postgres-backed content
- Where can I host Documentation site built with Django?
- I need a content schema, publishing workflow and cache behavior after content updates.

## Resource Requirements
- **Compute**
- **Postgres**
- **CDN**

## Infrastructure Requirements
- **Compute**: Apps run in isolated x86_64 Firecracker microVMs that auto-pause when idle and wake on request; sizes are the priced VM sizes.
- **Postgres**: Managed PostgreSQL 16 runs in its own microVM and is auto-provisioned when an app needs a database and no DATABASE_URL is supplied.
- **CDN**: The CDN host serves objects from published buckets. It does not front app compute and is not a cache or key-value store.

## Prerequisites
1. A Django project that builds and starts with the documented commands (pip install into .ample/python from requirements.txt, then waitress serving project.wsgi from run.py reading PORT on the python-3.12 template).
2. A PostgreSQL driver reading DATABASE_URL at runtime (auto-provisioned when omitted, or supplied with --env).
3. A bucket from `ample bucket create` with its credentials passed as encrypted S3_* environment variables.
4. An Ample account token with servers:write, databases:read, buckets:read.

## Tested Configuration
- **Template**: python-3.12
- **Runtime**: python
- **Size**: s-1vcpu-1gb
- **Install**: python3 -m pip install --target .ample/python -r requirements.txt
- **Start**: PYTHONPATH=.ample/python:${PYTHONPATH:-} python3 run.py

## Workflow Steps
1. **Build and start**: pip install into .ample/python from requirements.txt, then waitress serving project.wsgi from run.py reading PORT on the python-3.12 template. The server must bind 0.0.0.0 on PORT.
2. **Implement the pattern on PostgreSQL**: The fixture's module implements relational records: a workspace-scoped table, an explicit state machine (draft to review to published) that rejects invalid transitions, and a cross-workspace read that returns nothing (transitions=true isolation=true). Copy the approach into your schema; keep migrations idempotent and run them with --release-command.
3. **Wire object storage**: Create the bucket(s), then pass endpoint, region, bucket and keys as --env values. Use path-style addressing. Keep private data in an unpublished bucket. Publish only the bucket that serves public assets and reference its CDN URL.
4. **Deploy**: Run the synchronous deploy once and read the result (exit 0 live, 1 failed, 2 blocked). Re-running with no change is a no-op.
   Command: ample deploy . --name  --public --start "python3 run.py" --env S3_ENDPOINT=... --env S3_REGION=... --env S3_BUCKET=... --env S3_ACCESS_KEY_ID=... --env S3_SECRET_ACCESS_KEY=... --env CDN_PUBLIC_URL=...
5. **Verify**: Fetch the live URL and the pattern self-test route(s) (/p/relational-records) from the example; then run your own checks. On failure read `ample logs  --kind build` then `--kind runtime`.
   Command: ample logs  --kind build

## Success Checks
- App responds on its public URL (kind: http_get, path: /, expect: ample canary django patterns)
- Relational-records self-test (kind: http_get, path: /p/relational-records, expect: records=ok transitions=true isolation=true)

## Limitations
- Verified on the python-3.12 template at s-1vcpu-1gb with the example fixture; other sizes, templates and Django major versions are not verified.
- The documentation site itself (your record schema, states and access rules) is application code and was not separately tested; the pattern checks are what was verified.

## Cost Estimate
- **Currency**: USD
- **Monthly Amount**: 10.0
- **Note**: Always-on monthly price of the tested sizes; apps and databases auto-pause when idle. Buckets are allocation-priced per quota and not included.

## Evidence Summary
- **Kind**: canary_run
   - **Summary**: Django pattern fixture deployed on Ample; checks passed for relational-records and configuration-secrets.
   - **Observed At**: 2026-09-20T03:31:44Z
   - **Implementation Revision**: 03b6402b1b3e19178985f08ea4033804521d85d4-dirty
   - **Expires At**: 2027-03-19T03:31:44Z

## Last Verified At
2026-09-20T03:31:44Z

## Next Actions
- **Browse the catalog index**: GET /v1/catalog
- **Search published recipes**: POST /v1/catalog/search (body: {"limit":5,"query":"Host documentation site with Django: Postgres-backed content"})
- **Prepare a side-effect-free deployment plan**: POST /v1/catalog/plan (body: {"inputs":{},"projectId":"","recipeId":"page:recipes:documentation-site:django:relational-content","recipeRevision":"r1"})
- **Read existing agent authentication setup**: GET /mcp/setup
- **Browse Documentation site**: GET /v1/catalog/nodes/workload%3Adocumentation-site
- **Browse Django**: GET /v1/catalog/nodes/stack%3Aframework-django
- **Browse Relational records**: GET /v1/catalog/nodes/pattern%3Arelational-records
- **Browse Deploy web app**: GET /v1/catalog/nodes/intent%3Adeploy-web-app
