page:recipes:documentation site:django:public site

Host documentation site with Django: public-site delivery

Deploy a documentation site built with Django on Ample using the public web service pattern. Compute runs the app in an isolated microVM behind a public HTTPS URL, and a published bucket serves public assets from the CDN host. Verified on Django: a versioned, immutable-cached asset uploaded to a published bucket and served from the CDN URL alongside the app's own public HTTPS URL. Not separately tested: your site content and build; treat the documentation site-specific behavior as your application code.

Summary

Representative Queries

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 bucket from ample bucket create with its credentials passed as encrypted S3_* environment variables
  3. An Ample account token with servers:write, buckets:read

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. 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.

3. 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.

ample deploy . --name <app_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=...

4. Verify

Fetch the live URL and the pattern self-test route(s) (/p/versioned-static-assets) from the example; then run your own checks. On failure read ample logs --kind build then --kind runtime.

ample logs  --kind build

Tested Configuration

Success Checks

Limitations

Examples

Multi-pattern Django app

The public web service module was checked live; the module is under tests/deploy-canaries/_pattern-modules.

Cost Estimate