documentation
Start here, go deeper if you need to.
Run the container, point your tooling at localhost:4566, and check the support matrix for gaps.
docker run --rm \
-p 4566:4566 \
-p 4567:4567 \
ghcr.io/overcast-sh/overcast:latestCommon first steps
Pointing the AWS CLI, Node.js, Python, Go, Java, .NET, Rust and Terraform at Overcast, plus overcast env and overcast aws, S3 addressing styles, and the credential and region defaults.
Bootstrap and deploy a CDK stack against Overcast: the environment CDK needs, the five calls a deploy makes, and where the resource coverage, limitations and fixes live.
Swap the image line and keep the rest: the compose diff, the endpoint and hostname settings, and where the variable, endpoint and behavioural detail lives.
Build against it
You have it running and you are writing the app.
- Networking and host-based addressing Reach it from sibling containers, Compose, and host-routed URLs.
- The inner loop — live code inside emulated compute Edit a file and see it take effect — no rebuild, no redeploy.
- Testcontainers Start and stop the emulator from an integration test.
- HTTPS and HTTP/2 Browser-trusted TLS in two commands.
- Storage and persistence Pick a backend, and know what survives a restart.
Run and operate it
You are the one who has to keep it up.
- Configuration Every environment variable, its default, and the LocalStack aliases.
- CLI reference Every overcast subcommand, with flags and defaults.
- Troubleshooting Start from the symptom. Every startup warning has an entry.
- Debug endpoints Health, metrics, state dumps, request traces, pprof.
- Performance and memory Startup and memory targets, and the knobs that move them.
Reference
Tables, for looking one thing up.
Alpha stability
Any release may change behaviour, config, or APIs.
-
Pin an exact tag:
ghcr.io/overcast-sh/overcast:0.0.1-alpha.NN. Both:latestand:alphamove with every release. - Check the release changelog before upgrading.
- Report anything unexpected on GitHub.