{"catalogRevision":"cat_f13ab9a494120b5e","recipeId":"page:recipes:admin-dashboard:rails:private-documents","recipeRevision":"r1","canonicalPath":"/recipes/admin-dashboard/rails/private-documents","label":"Host admin dashboard with Rails: private documents","family":"Workload recipe","summary":"Deploy a admin dashboard built with Rails 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 Rails: 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 admin dashboard-specific behavior as your application code.","representativeQueries":["Host admin dashboard with Rails: private documents","Where can I host Admin dashboard built with Rails?","I need a role-to-document access model and negative authorization tests."],"breadcrumbIds":["discovery","workload","workload:portals-and-communities","workload:admin-dashboard","page:recipes:admin-dashboard:rails:private-documents"],"breadcrumbs":[{"id":"discovery","label":"Agent hosting discovery","canonicalPath":"/discover/discovery","kind":"root"},{"id":"workload","label":"Applications and workloads","canonicalPath":"/discover/workload","kind":"facet"},{"id":"workload:portals-and-communities","label":"Portals and communities","canonicalPath":"/discover/workload/portals-and-communities","kind":"group"},{"id":"workload:admin-dashboard","label":"Admin dashboard","canonicalPath":"/discover/workload/admin-dashboard","kind":"atom"},{"id":"page:recipes:admin-dashboard:rails:private-documents","label":"Host admin dashboard with Rails: private documents","canonicalPath":"/recipes/admin-dashboard/rails/private-documents","kind":"recipe"}],"parentIds":["workload:admin-dashboard","stack:framework-rails","pattern:private-document-library","intent:deploy-web-app"],"parents":[{"id":"workload:admin-dashboard","label":"Admin dashboard","canonicalPath":"/discover/workload/admin-dashboard","kind":"atom"},{"id":"stack:framework-rails","label":"Rails","canonicalPath":"/discover/stack/framework-rails","kind":"atom"},{"id":"pattern:private-document-library","label":"Private document library","canonicalPath":"/discover/pattern/private-document-library","kind":"atom"},{"id":"intent:deploy-web-app","label":"Deploy web app","canonicalPath":"/discover/intent/deploy-web-app","kind":"atom"}],"resourceRequirements":["primitive:compute","primitive:postgres","primitive:s3-compatible-object-storage"],"infrastructureRequirements":[{"primitiveId":"primitive:compute","label":"Compute","canonicalPath":"/discover/primitive/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."},{"primitiveId":"primitive:postgres","label":"Postgres","canonicalPath":"/discover/primitive/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."},{"primitiveId":"primitive:s3-compatible-object-storage","label":"S3-compatible object storage","canonicalPath":"/discover/primitive/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."}],"framework":"Rails","workload":"Admin dashboard","releaseStatus":"published","supportStatus":"verified","executionStatus":"ready","docsOnly":false,"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 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","An Ample account token with servers:write, databases:read, buckets:read"],"testedConfiguration":{"template":"ruby-3.4","runtime":"ruby","size":"s-1vcpu-1gb","install":"bundle config set --local path vendor/bundle && bundle config set --local without 'development test' && bundle install","start":"bundle exec rails server -b 0.0.0.0 -p $PORT"},"inputSchema":{"additionalProperties":false,"properties":{"env":{"description":"Encrypted environment variables (bucket credentials, secrets)","items":{"pattern":"^[A-Z][A-Z0-9_]*=.*$","type":"string"},"maxItems":50,"type":"array"},"name":{"description":"App name","maxLength":63,"minLength":1,"pattern":"^[a-z0-9-]+$","type":"string"},"path":{"description":"Project directory or ample.toml service","maxLength":512,"minLength":1,"type":"string"},"release_command":{"description":"Migration command run before activation","maxLength":512,"type":"string"}},"required":["env","name","path"],"type":"object"},"outputSchema":null,"workflowSteps":[{"title":"Build and start","body":"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."},{"title":"Implement the pattern on PostgreSQL","body":"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."},{"title":"Wire object storage","body":"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."},{"title":"Deploy","body":"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 <app-name> --public --env S3_ENDPOINT=... --env S3_REGION=... --env S3_BUCKET=... --env S3_ACCESS_KEY_ID=... --env S3_SECRET_ACCESS_KEY=..."},{"title":"Verify","body":"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 read `ample logs <deployment_id> --kind build` then `--kind runtime`.","command":"ample logs <deployment_id> --kind build"}],"examples":[{"title":"Rails pattern fixture","description":"Multi-pattern Rails app whose private document library module was checked live; the module is under tests/deploy-canaries/_pattern-modules.","sourceRef":"tests/deploy-canaries/rails-patterns"}],"successChecks":[{"description":"app responds on its public URL","kind":"http_get","path":"/","expect":"ample canary rails patterns"},{"description":"private-document-library self-test","kind":"http_get","path":"/p/private-document-library","expect":"private=ok (with ?role=owner; 401 without, 403 for viewer)"}],"limitations":["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.","The admin dashboard 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."],"costEstimate":{"currency":"USD","monthlyAmount":10.0,"authoritative":true,"basis":"size prices from pricing.toml (loaded by the API) at build revision 7cf090725a6f16dd91af7d28356fe72c1b404d6e","components":[{"name":"app server","size":"s-1vcpu-1gb","quantity":1.0,"monthlyAmount":5.0},{"name":"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."},"evidenceSummary":[{"kind":"canary_run","summary":"Rails pattern fixture deployed on Ample (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); checks passed for private-document-library and configuration-secrets. Pattern proof: 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).","observedAt":"2026-09-20T21:55:28Z","implementationRevision":"4f7cb9813c1f (CLI 4f7cb98)","expiresAt":"2027-03-19T21:55:28Z","scope":{"checks":["/p/private-document-library"],"pattern":"pattern:private-document-library","template":"ruby-3.4"}},{"kind":"canary_run","summary":"The same Rails app deployed with a --release-command migration; the marker it created was readable after activation.","observedAt":"2026-09-20T21:55:28Z","implementationRevision":"4f7cb9813c1f (CLI 4f7cb98)","expiresAt":"2027-03-19T21:55:28Z","scope":{"pattern":"pattern:private-document-library"}}],"lastVerifiedAt":"2026-09-20T21:55:28Z","mcpBinding":{"registryRef":"mcp:ample_deploy","toolName":"ample_deploy","schemaHash":"876465fce906da0c224d62961d3343064108ebe30af80cf1b87094974e948853","observedAt":"2026-09-22T00:31:22.774679+00:00","implementationRevision":"e6446ceea69b","requiredScopes":["servers:write","databases:read","buckets:read"],"bindingState":"current"},"unknowns":["region availability is unknown until a verified region fact is recorded","compliance attestations are unknown; none are claimed"],"formats":{"html":"https://ample.computer/recipes/admin-dashboard/rails/private-documents","markdown":"https://ample.computer/recipes/admin-dashboard/rails/private-documents.md","json":"https://api.ample.computer/v1/catalog/recipes/page%3Arecipes%3Aadmin-dashboard%3Arails%3Aprivate-documents"},"nextActions":[{"actionId":"browse-catalog","label":"Browse the catalog index","operationId":"catalog_index","method":"GET","relativePath":"/v1/catalog","origin":"api","parameters":{},"requiresAuthentication":false,"requiresApproval":false},{"actionId":"search-recipes","label":"Search published recipes by intent, stack and constraints","operationId":"search_recipes","method":"POST","relativePath":"/v1/catalog/search","origin":"api","parameters":{"body":{"limit":5,"query":"Host admin dashboard with Rails: private documents"}},"requiresAuthentication":false,"requiresApproval":false},{"actionId":"plan:page:recipes:admin-dashboard:rails:private-documents","label":"Prepare a side-effect-free deployment plan for an authorized project","operationId":"plan_deployment","method":"POST","relativePath":"/v1/catalog/plan","origin":"api","parameters":{"body":{"inputs":{},"projectId":"<workspace or server id you own>","recipeId":"page:recipes:admin-dashboard:rails:private-documents","recipeRevision":"r1"}},"requiresAuthentication":true,"requiresApproval":false},{"actionId":"auth-setup","label":"Read the existing agent authentication setup","operationId":"existing_auth_setup","method":"GET","relativePath":"/mcp/setup","origin":"api","parameters":{},"requiresAuthentication":false,"requiresApproval":false},{"actionId":"browse:workload:admin-dashboard","label":"Browse Admin dashboard","operationId":"browse_node","method":"GET","relativePath":"/v1/catalog/nodes/workload%3Aadmin-dashboard","origin":"api","parameters":{"nodeId":"workload:admin-dashboard"},"requiresAuthentication":false,"requiresApproval":false},{"actionId":"browse:stack:framework-rails","label":"Browse Rails","operationId":"browse_node","method":"GET","relativePath":"/v1/catalog/nodes/stack%3Aframework-rails","origin":"api","parameters":{"nodeId":"stack:framework-rails"},"requiresAuthentication":false,"requiresApproval":false},{"actionId":"browse:pattern:private-document-library","label":"Browse Private document library","operationId":"browse_node","method":"GET","relativePath":"/v1/catalog/nodes/pattern%3Aprivate-document-library","origin":"api","parameters":{"nodeId":"pattern:private-document-library"},"requiresAuthentication":false,"requiresApproval":false},{"actionId":"browse:intent:deploy-web-app","label":"Browse Deploy web app","operationId":"browse_node","method":"GET","relativePath":"/v1/catalog/nodes/intent%3Adeploy-web-app","origin":"api","parameters":{"nodeId":"intent:deploy-web-app"},"requiresAuthentication":false,"requiresApproval":false}]}