page:recipes:documentation site:rails:public site

Host documentation site with Rails: public-site delivery

Summary

Deploy a documentation site built with Rails 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 Rails: 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 Rails: public-site delivery
• Where can I host Documentation site built with Rails?
• I need an explicit origin-to-CDN delivery path and a tested public content build.

Prerequisites

• A Rails project that builds and starts with the documented commands (bundle install into vendor/bundle from Gemfile.lock (development and test groups skipped), then Puma via rails server reading PORT on the ruby-3.4 template with RAILS_ENV=production)
• A bucket from ample bucket create with its credentials passed as encrypted S3_* environment variables
• An Ample account token with servers:write, buckets:read

Workflow Steps

1. Build and start
   bundle install into vendor/bundle from Gemfile.lock (development and test groups skipped), then Puma via rails server reading PORT on the ruby-3.4 template with RAILS_ENV=production. 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  --public --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  
   

Examples

• Rails pattern fixture
  Multi-pattern Rails app whose public web service module was checked live; the module is under tests/deploy-canaries/_pattern-modules.
  • Source Reference: tests/deploy-canaries/rails-patterns

Success Checks

• App responds on its public URL
  • Kind: http_get
  • Path: /
  • Expect: ample canary rails patterns
• Versioned-static-assets self-test
  • Kind: http_get
  • Path: /p/versioned-static-assets
  • Expect: a CDN URL whose content is served publicly

Limitations

1. Verified on the ruby-3.4 template at s-1vcpu-1gb with the example fixture; other sizes, templates and Rails major versions are not verified.
2. The documentation site itself (your site content and build) is application code and was not separately tested; the pattern checks are what was verified.
3. Region, compliance attestations and request-duration limits are unknown and not claimed.
4. Apps auto-pause when idle and wake on the next request; always-on is an operator setting, not a plan feature.
5. PutObject and GetObject with path-style addressing are verified; multipart upload, listing, presigned URLs and lifecycle rules are not.
6. The CDN serves published-bucket objects only; cache rules, purge and TTL control are not verified.

Cost Estimate

• Currency: USD
• Monthly Amount: 5.0
• Basis: size prices from pricing.toml
• Components:
  • App server: 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.

Evidence Summary

• Kind: canary_run
  • Summary: Rails pattern fixture deployed on Ample; checks passed for versioned-static-assets and configuration-secrets.
  • Observed At: 2026-09-20T21:55:28Z
• Kind: canary_run
  • Summary: The same Rails app deployed with a --release-command migration; the marker it created was readable after activation.
  • Observed At: 2026-09-20T21:55:28Z

Next Actions

• Browse the catalog index
• Search published recipes by intent, stack and constraints
• Prepare a side-effect-free deployment plan for an authorized project
• Read the existing agent authentication setup
• Browse Documentation site
• Browse Rails
• Browse Public web service
• Browse Deploy web app