page:recipes:documentation site:phoenix:public site
Host documentation site with Phoenix: public-site delivery
Summary
Deploy a documentation site built with Phoenix 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 Phoenix: 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.
Representative Queries
- Host documentation site with Phoenix: public-site delivery
- Where can I host Documentation site built with Phoenix?
- I need an explicit origin-to-CDN delivery path and a tested public content build.
Resource Requirements
- primitive:compute
- primitive: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.
- 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
- A Phoenix project that builds and starts with the documented commands (mix deps.get, MIX_ENV=prod mix compile and mix release in the builder, then the release bin script with PHX_SERVER=true on the elixir-1.18 template; PORT, DATABASE_URL and SECRET_KEY_BASE read in config/runtime.exs)
- A bucket from
ample bucket createwith its credentials passed as encrypted S3_* environment variables - An Ample account token with servers:write, buckets:read
Workflow Steps
- Build and start: mix deps.get, MIX_ENV=prod mix compile and mix release in the builder, then the release bin script with PHX_SERVER=true on the elixir-1.18 template; PORT, DATABASE_URL and SECRET_KEY_BASE read in config/runtime.exs. The server must bind 0.0.0.0 on PORT.
- 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.
- 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 --env S3_ENDPOINT=... --env S3_REGION=... --env S3_BUCKET=... --env S3_ACCESS_KEY_ID=... --env S3_SECRET_ACCESS_KEY=... --env CDN_PUBLIC_URL=...
- 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 buildthen--kind runtime. Command: ample logs --kind build
Examples
- Phoenix pattern fixture: Multi-pattern Phoenix app whose public web service module was checked live; the module is under tests/deploy-canaries/_pattern-modules.
Success Checks
- App responds on its public URL
- Kind: http_get
- Path: /
- Expect: ample canary phoenix patterns
- Versioned-static-assets self-test
- Kind: http_get
- Path: /p/versioned-static-assets
- Expect: a CDN URL whose content is served publicly.
Limitations
- Verified on the elixir-1.18 template at s-1vcpu-1gb with the example fixture; other sizes, templates and Phoenix major versions are not verified.
- The documentation site itself (your site content and build) 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.
- 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: 5.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
- App Server:
- 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.
Next Actions
- Browse the catalog index:
- Action ID: browse-catalog
- Method: GET
- Relative Path: /v1/catalog
- Search published recipes by intent, stack and constraints:
- Action ID: search-recipes
- Method: POST
- Relative Path: /v1/catalog/search
- Parameters:
- body: { limit: 5, query: "Host documentation site with Phoenix: public-site delivery" }
- Prepare a side-effect-free deployment plan for an authorized project:
- Action ID: plan:page:recipes:documentation-site:phoenix:public-site
- Method: POST
- Relative Path: /v1/catalog/plan
- Read the existing agent authentication setup:
- Action ID: auth-setup
- Method: GET
- Relative Path: /mcp/setup
- Browse Documentation site:
- Action ID: browse:workload:documentation-site
- Method: GET
- Relative Path: /v1/catalog/nodes/workload%3Adocumentation-site
- Browse Phoenix:
- Action ID: browse:stack:framework-phoenix
- Method: GET
- Relative Path: /v1/catalog/nodes/stack%3Aframework-phoenix
- Browse Public web service:
- Action ID: browse:pattern:public-web-service
- Method: GET
- Relative Path: /v1/catalog/nodes/pattern%3Apublic-web-service
- Browse Deploy web app:
- Action ID: browse:intent:deploy-web-app
- Method: GET
- Relative Path: /v1/catalog/nodes/intent%3Adeploy-web-app