page:guides:phoenix:object client
Configure S3-compatible access for Phoenix
Summary
Object storage client for a Phoenix app on Ample. Verified on Phoenix: bucket credentials delivered as encrypted S3_* environment variables and a validated PutObject/GetObject round-trip linked to a database row (upload=ok linked=ok). 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.
Prerequisites
- A Phoenix project.
- A bucket from
ample bucket createwith 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. - Create the bucket and pass its credentials
Create it once withample bucket create, then pass endpoint, region, bucket and keys with --env; use path-style addressing.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 /p/browser-file-uploads on the example; on failure read the build and runtime logs.ample logs --kind build
Success Checks
- app responds on its public URL
- Path:
/ - Expect: ample canary phoenix patterns
- Path:
- browser-file-uploads check from the example
- Path:
/p/browser-file-uploads - Expect: see the pattern fixture checks
- Path:
Limitations
- Verified on the elixir-1.18 template at s-1vcpu-1gb; other sizes and Phoenix major versions are not verified.
- Region, compliance attestations and request-duration limits are unknown and not claimed.
- PutObject and GetObject with path-style addressing are verified; other S3 operations are not.
Cost Estimate
- Currency: USD
- Monthly Amount: 5.0
- Basis: Size prices from pricing.toml (loaded by the API) at build revision 1ac5595375130d45290090e82ed0f554ccd45405-dirty.
- Components:
- Name: app server, Size: s-1vcpu-1gb, Quantity: 1.0, Monthly Amount: 5.0
- Note: Always-on monthly price of the tested sizes; apps auto-pause when idle.
Examples
- Phoenix pattern fixture: Verified object storage client on Phoenix.
- Source Reference: tests/deploy-canaries/phoenix-patterns
Tested Configuration
- Template: elixir-1.18
- Runtime: elixir
- Size: s-1vcpu-1gb
- Install: mix local.hex --force && mix local.rebar --force && MIX_ENV=prod mix deps.get --only prod
- Build: MIX_ENV=prod mix compile && MIX_ENV=prod mix release --overwrite
- Start: PHX_SERVER=true _build/prod/rel/$(ls _build/prod/rel | head -n 1)/bin/$(ls _build/prod/rel | head -n 1) start