page:recipes:documentation site:nuxt:relational content

Host documentation site with Nuxt: Postgres-backed content

Deploy a documentation site built with Nuxt on Ample using the relational records 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, and a published bucket serves public assets from the CDN host. Verified on Nuxt: a workspace-scoped table, an explicit state machine (draft to review to published) that rejects invalid transitions, and a cross-workspace read that returns nothing (transitions=true isolation=true). Not separately tested: your record schema, states and access rules; treat the documentation site-specific behavior as your application code.

Representative Queries

• Host documentation site with Nuxt: Postgres-backed content
• Where can I host Documentation site built with Nuxt?
• I need a content schema, publishing workflow and cache behavior after content updates.

Resource Requirements

• primitive:compute
• primitive:postgres
• primitive:cdn

Infrastructure Requirements

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

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

3. CDN
   Status: verified
   Summary: 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 Nuxt project that builds and starts with the documented commands (nuxt build then node .output/server/index.mjs (reads HOST and PORT) on the node-22 template).
• 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.

Tested Configuration

• Template: node-22
• Runtime: node
• Size: s-1vcpu-1gb
• Install: npm install
• Build: npm run build --if-present
• Start: npm run start

Workflow Steps

1. Build and start
   Execute: nuxt build then node .output/server/index.mjs (reads HOST and PORT) on the node-22 template. The server must bind 0.0.0.0 on PORT.

2. Implement the pattern on PostgreSQL
   The fixture's module implements relational records: a workspace-scoped table, an explicit state machine (draft to review to published) that rejects invalid transitions, and a cross-workspace read that returns nothing (transitions=true isolation=true). Copy the approach into your schema; keep migrations idempotent and run them with --release-command.

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

4. Deploy
   Execute: 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=... 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.

5. Verify
   Fetch the live URL and the pattern self-test route(s) (/api/p/relational-records) from the example; then run your own checks. On failure, read ample logs --kind build then --kind runtime.
   Execute: ample logs --kind build

Examples

• Title: Nuxt pattern fixture
  Description: Multi-pattern Nuxt app whose relational records module was checked live; the module is under tests/deploy-canaries/_pattern-modules.
  Source Reference: tests/deploy-canaries/nuxt-patterns

Success Checks

• App responds on its public URL.
  Kind: http_get
  Path: /
  Expect: ample canary nuxt patterns

• Relational-records self-test.
  Kind: http_get
  Path: /api/p/relational-records
  Expect: records=ok transitions=true isolation=true

Limitations

• Verified on the node-22 template at s-1vcpu-1gb with the example fixture; other sizes, templates and Nuxt major versions are not verified.
• The documentation site itself (your record schema, states and access rules) is application code and was not separately tested; the pattern checks are what was verified.
• Apps auto-pause when idle and wake on the next request; always-on is an operator setting, not a plan feature.

Cost Estimate

• Currency: USD
• Monthly Amount: 10.0
• Basis: size prices from pricing.toml (loaded by the API) at build revision 1ac5595375130d45290090e82ed0f554ccd45405-dirty
  Components:

1. App Server
   • Size: s-1vcpu-1gb
   • Quantity: 1.0
   • Monthly Amount: 5.0
2. 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.

Next Actions

1. Browse Catalog

   • Action ID: browse-catalog
   • Label: Browse the catalog index
   • Operation ID: catalog_index
   • Method: GET
   • Relative Path: /v1/catalog

2. Search Recipes

   • Action ID: search-recipes
   • Label: Search published recipes by intent, stack and constraints
   • Operation ID: search_recipes
   • Method: POST
   • Relative Path: /v1/catalog/search
   • Parameters:
     • Body: {"limit":5,"query":"Host documentation site with Nuxt: Postgres-backed content"}

3. Deploy Plan

   • Action ID: plan:page:recipes:documentation-site:nuxt:relational-content
   • Label: Prepare a side-effect-free deployment plan for an authorized project
   • Operation ID: plan_deployment
   • Method: POST
   • Parameters: {"body":{"inputs":{},"projectId":"","recipeId":"page:recipes:documentation-site:nuxt:relational-content","recipeRevision":"r1"}}