# Host documentation site with Django: object-stored public media

Deploy a documentation site built with Django on Ample using the public media library 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, a private S3-compatible bucket holds objects with credentials delivered as encrypted environment variables, and a published bucket serves public assets from the CDN host. Verified on Django: an object written to a published bucket with an immutable Cache-Control header, a mapping row, and the CDN URL serving it publicly. Not separately tested: your media processing, object layout and cache policy; treat the documentation site-specific behavior as your application code.

## Representative Queries
- Host documentation site with Django: object-stored public media
- Where can I host Documentation site built with Django?
- I need an object layout, public asset URL policy and CDN delivery configuration.

## Resource Requirements
- primitive:compute
- primitive:postgres
- primitive:s3-compatible-object-storage
- primitive:cdn

## Infrastructure Requirements
1. **Compute**: Apps run in isolated x86_64 Firecracker microVMs that auto-pause when idle and wake on request; sizes are the priced VM sizes. (Status: verified)
2. **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. (Status: verified)
3. **S3-compatible object storage**: Buckets are S3-compatible with issued credentials; PutObject and GetObject are verified by canary. (Status: verified)
4. **CDN**: The CDN host serves objects from published buckets. It does not front app compute and is not a cache or key-value store. (Status: verified)

## Framework
- Django

## Workload
- Documentation site

## Release Status
- published

## Support Status
- verified

## Execution Status
- ready

## Prerequisites
- 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).
- A PostgreSQL driver reading DATABASE_URL at runtime (auto-provisioned when omitted, or supplied with --env).
- A bucket from `ample bucket create` with its credentials passed as encrypted S3_* environment variables and a second, published bucket for public assets (CDN_*).
- 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 public media library: an object written to a published bucket with an immutable Cache-Control header, a mapping row, and the CDN URL serving it publicly. 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.
5. **Verify**: Fetch the live URL and the pattern self-test route(s) (/p/public-media-library) from the example; then run your own checks. On failure read `ample logs  --kind build` then `--kind runtime`.

## Examples
- **Title**: Django pattern fixture
  - **Description**: Multi-pattern Django app whose public media library module was checked live; the module is under tests/deploy-canaries/_pattern-modules.
  - **Source Ref**: tests/deploy-canaries/django-patterns

## Success Checks
- app responds on its public URL (kind: http_get, path: /, expect: ample canary django patterns)
- public-media-library self-test (kind: http_get, path: /p/public-media-library, expect: a CDN URL whose content is served publicly)

## 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 media processing, object layout and cache policy) is application code and was not separately tested; the pattern checks are what was verified.
- Region, compliance attestations and request-duration limits are unknown and not claimed.
- Apps auto-pause when idle and wake on the next request; always-on is an operator setting, not a plan feature.
- Managed PostgreSQL 16 only; extensions, connection limits and backup or restore procedures are not verified; apps and their databases are placed together.
- PutObject and GetObject with path-style addressing are verified; multipart upload, listing, presigned URLs and lifecycle rules are not.
- The CDN serves published-bucket objects only; cache rules, purge and TTL control are not verified (the fixture sets Cache-Control on upload and versions keys).

## Cost Estimate
- **Currency**: USD  
- **Monthly Amount**: 10.0  
- **Basis**: size prices from pricing.toml (loaded by the API) at build revision 1ac5595375130d45290090e82ed0f554ccd45405-dirty
- **Components**:
  - **App server**: size: s-1vcpu-1gb, quantity: 1.0, monthlyAmount: 5.0
  - **Managed PostgreSQL database**: size: s-1vcpu-1gb, quantity: 1.0, monthlyAmount: 5.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 public-media-library and configuration-secrets.
  - **Observed At**: 2026-09-20T03:31:44Z
  - **Implementation Revision**: 03b6402b1b3e19178985f08ea4033804521d85d4-dirty (CLI b75e104)
  - **Expires At**: 2027-03-19T03:31:44Z
- **Kind**: canary_run 
  - **Summary**: The same Django app deployed with a --release-command migration.
  - **Observed At**: 2026-09-20T01:54:51Z
  - **Implementation Revision**: 199ff1dfd52683832ae75d3f98b53a7a4bff7f96-dirty (CLI e3181f5)
  - **Expires At**: 2027-03-19T01:54:51Z

## Next Actions
- **Browse the catalog index**: [GET /v1/catalog](api)  
- **Search published recipes by intent, stack and constraints**: [POST /v1/catalog/search](api)  
- **Prepare a side-effect-free deployment plan for an authorized project**: [POST /v1/catalog/plan](api)  
- **Read the existing agent authentication setup**: [GET /mcp/setup](api)  
- **Browse Documentation site**: [GET /v1/catalog/nodes/workload:documentation-site](api)  
- **Browse Django**: [GET /v1/catalog/nodes/stack:framework-django](api)  
- **Browse Public media library**: [GET /v1/catalog/nodes/pattern:public-media-library](api)  
- **Browse Deploy web app**: [GET /v1/catalog/nodes/intent:deploy-web-app](api)  
  
---
