page:recipes:client portal:django:private documents
Host client portal with Django: private documents
Deploy a client portal built with Django on Ample using the private document 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. Verified on Django: a role-to-document access model with negative tests (401 without identity, 403 for the wrong role) and a private-bucket round-trip for the allowed role (private=ok). Not separately tested: your identity integration and role assignments; treat the client portal-specific behavior as your application code.
Summary
- Family: Workload recipe
- Release Status: published
- Support Status: verified
- Execution Status: ready
Representative Queries
- Host client portal with Django: private documents
- Where can I host Client portal built with Django?
- I need a role-to-document access model and negative authorization tests.
Resource Requirements
- primitive:compute
- primitive:postgres
- primitive:s3-compatible-object-storage
Infrastructure Requirements
Compute
- Status: verified
- Summary: Apps run in isolated x86_64 Firecracker microVMs that auto-pause when idle and wake on request; sizes are the priced VM sizes.
Postgres
- Status: verified
- Summary: Managed PostgreSQL 16 runs in its own microVM and is auto-provisioned when an app needs a database and no DATABASE_URL is supplied.
S3-compatible object storage
- Status: verified
- Summary: Buckets are S3-compatible with issued credentials; PutObject and GetObject are verified by canary. Other S3 operations are not verified.
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 createwith its credentials passed as encrypted S3_* environment variables - An Ample account token with servers:write, databases:read, buckets:read
Workflow Steps
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.Implement the pattern on PostgreSQL
The fixture's module implements private document library: a role-to-document access model with negative tests (401 without identity, 403 for the wrong role) and a private-bucket round-trip for the allowed role (private=ok). Copy the approach into your schema; keep migrations idempotent and run them with --release-command.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.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=...Verify
Fetch the live URL and the pattern self-test route(s) (/p/private-document-library) from the example; then run your own checks. On failure readample logs --kind buildthen--kind runtime.
Command:ample logs --kind build
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 client portal itself (your identity integration and role assignments) 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.
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
- Monthly Amount: 5.0
- managed PostgreSQL database
- Size: s-1vcpu-1gb
- Quantity: 1.0
- Monthly Amount: 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.
Success Checks
- App responds on its public URL
- Kind: http_get
- Path: /
- Expect: ample canary django patterns
- private-document-library self-test
- Kind: http_get
- Path: /p/private-document-library
- Expect: private=ok (with ?role=owner; 401 without, 403 for viewer)
Evidence Summary
- Canary Run
- Summary: Django pattern fixture deployed on Ample; checks passed for private-document-library and configuration-secrets.
- Observed At: 2026-09-20T03:31:44Z
- Implementation Revision: 03b6402b1b3e19178985f08ea4033804521d85d4-dirty
- Expires At: 2027-03-19T03:31:44Z
Next Actions
Browse the catalog index
- Operation: GET
- Relative Path: /v1/catalog
Search published recipes by intent, stack and constraints
- Operation: POST
- Relative Path: /v1/catalog/search
Prepare a side-effect-free deployment plan for an authorized project
- Operation: POST
- Relative Path: /v1/catalog/plan
Read the existing agent authentication setup
- Operation: GET
- Relative Path: /mcp/setup
Browse Client portal
- Operation: GET
- Relative Path: /v1/catalog/nodes/workload%3Aclient-portal
Browse Django
- Operation: GET
- Relative Path: /v1/catalog/nodes/stack%3Aframework-django
Browse Private document library
- Operation: GET
- Relative Path: /v1/catalog/nodes/pattern%3Aprivate-document-library
Browse Deploy web app
- Operation: GET
- Relative Path: /v1/catalog/nodes/intent%3Adeploy-web-app