# Host client portal with Spring Boot: private documents

Deploy a client portal built with Spring Boot 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 Spring Boot: 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.

## Prerequisites
1. A Spring Boot project that builds and starts with the documented commands (./mvnw -q -DskipTests package (or the Gradle wrapper) producing one application jar, then java -jar on the jvm-21 template (Temurin JDK 21) with server.port read from PORT)
2. A PostgreSQL driver reading DATABASE_URL at runtime (auto-provisioned when omitted, or supplied with --env)
3. A bucket from `ample bucket create` with its credentials passed as encrypted S3_* environment variables
4. An Ample account token with servers:write, databases:read, buckets:read

## Workflow Steps
### Build and start
- ./mvnw -q -DskipTests package (or the Gradle wrapper) producing one application jar, then java -jar on the jvm-21 template (Temurin JDK 21) with server.port read from PORT. 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.
  ```
  ample deploy . --name  --public --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 read `ample logs  --kind build` then `--kind runtime`.
  ```
  ample logs  --kind build
  ```

## Success Checks
1. App responds on its public URL
   - Kind: http_get
   - Path: /
   - Expect: ample canary spring boot patterns
2. 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 jvm-21 template at s-1vcpu-2gb with the example fixture; other sizes, templates and Spring Boot 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 verified.

## Cost Estimate
- Currency: USD
- Monthly Amount: 10.0
- 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.

## Examples
### Spring Boot pattern fixture
- Description: Multi-pattern Spring Boot app whose private document library module was checked live; the module is under tests/deploy-canaries/_pattern-modules.
- Source Ref: tests/deploy-canaries/spring-boot-patterns

## Evidence Summary
1. **Canary Run**
   - Summary: Spring Boot pattern fixture deployed on Ample... checks passed for private-document-library and configuration-secrets.
   - Observed At: 2026-09-21T02:34:39Z
   - Expires At: 2027-03-20T02:34:39Z
2. **Canary Run**
   - Summary: The same Spring Boot app deployed with a --release-command migration...
   - Observed At: 2026-09-20T22:49:19Z
   - Expires At: 2027-03-19T22:49:19Z