# Overcast documentation > The guides and references for Overcast, a free, MIT-licensed local emulator for AWS APIs: pointing AWS clients at it, running it, and working out what it did. Every link below ends in `.md` and returns that page as markdown. The same page renders as HTML at the path without the extension. Per-service pages are indexed separately, in /docs/services/llms.txt. ## Overview - [Overview](https://overcast.sh/docs/overview/index.md): What Overcast emulates and what it deliberately does not, the Docker and native-binary quick starts… ## Getting Started - [Using AWS CDK with Overcast](https://overcast.sh/docs/cdk/index.md): Bootstrap and deploy a CDK stack against Overcast: the environment CDK needs, the five calls a deploy makes… - [Install Overcast](https://overcast.sh/docs/install/index.md): One line installs the native binary on macOS, Linux or Windows: what the installer does… - [The inner loop — live code inside emulated compute](https://overcast.sh/docs/local-dev/index.md): Edit a file and see it take effect without rebuilding an image or redeploying: cdk watch, Lambda hot reload… - [Migrating from LocalStack](https://overcast.sh/docs/migration-from-localstack/index.md): Swap the image line and keep the rest: the compose diff, the endpoint and hostname settings… - [Migration — Behavioural differences from LocalStack](https://overcast.sh/docs/migration/differences/index.md): What changes once the container is running: editions and plans, egress, S3 addressing, SQS queue URLs… - [Migration — LocalStack endpoints and init hooks](https://overcast.sh/docs/migration/endpoints/index.md): Which /_localstack and /_aws paths Overcast serves as-is, what the rest map to… - [Migration — LocalStack environment variables](https://overcast.sh/docs/migration/environment-variables/index.md): Which LocalStack variables Overcast reads as aliases, which are recognised and do nothing… - [Using AWS SDKs and CLI with Overcast](https://overcast.sh/docs/sdk-cli/index.md): Pointing the AWS CLI, Node.js, Python, Go, Java, .NET, Rust and Terraform at Overcast… - [Testcontainers](https://overcast.sh/docs/testcontainers/index.md): Run Overcast from your integration tests with the Testcontainers module for Go… ## CDK - [CDK — Cross-stack references in CDK](https://overcast.sh/docs/cdk/cross-stack-references/index.md): Strong references (Fn::ImportValue) and weak ones (Fn::GetStackOutput) against Overcast… - [CDK — CDK limitations](https://overcast.sh/docs/cdk/limitations/index.md): What a cdk deploy against Overcast does not do: custom resources without Docker… - [CDK — Local VPCs for CDK](https://overcast.sh/docs/cdk/local-vpc/index.md): Give the local environment a stack that creates the VPC: CDK owns the IDs, a teardown just produces new ones… - [CDK — CDK resource type coverage](https://overcast.sh/docs/cdk/resource-types/index.md): Which CloudFormation resource types Overcast provisions for real, which are recognised as stubs… - [CDK — CDK troubleshooting](https://overcast.sh/docs/cdk/troubleshooting/index.md): Symptom, cause and fix for a CDK deploy against Overcast: a bootstrap that fails… - [CDK — Importing a VPC into CDK](https://overcast.sh/docs/cdk/vpc-lookups/index.md): When something other than CDK owns the local VPC: which import to use, what availability zones resolve to… ## Networking - [HTTPS and HTTP/2](https://overcast.sh/docs/https/index.md): Two commands for browser-trusted TLS on the API and the web console, what HTTP/2 fixes in the console… - [HTTPS — Overcast in Docker over HTTPS](https://overcast.sh/docs/https/docker/index.md): Keep the CA on the host and let the container mint leaves from it, so one trust install survives every… - [HTTPS — How the local CA works](https://overcast.sh/docs/https/how-it-works/index.md): What overcast https enable mints and how long it lasts, which names the certificate covers, working offline… - [HTTPS — Installing the CA by hand](https://overcast.sh/docs/https/manual-trust/index.md): The per-platform trust-store commands, Firefox and Chromium's own NSS store, the WSL split-trust case… - [Networking and host-based addressing](https://overcast.sh/docs/networking/index.md): One port, one process, and one question: what name does a caller use… - [Networking — Data-plane endpoints](https://overcast.sh/docs/networking/data-plane-endpoints/index.md): RDS, Aurora and ElastiCache endpoints name a container Overcast started… - [Networking — The Docker networks Overcast uses](https://overcast.sh/docs/networking/docker-networks/index.md): The data plane, the control plane and the per-VPC networks: what each one carries, which one a resource joins… - [Networking — Egress modes](https://overcast.sh/docs/networking/egress/index.md): OVERCAST_VPC_EGRESS decides whether the containers Overcast starts reach anything outside your machine: open… - [Networking — Host-routed addressing](https://overcast.sh/docs/networking/host-routing/index.md): Which AWS subdomain forms Overcast routes, how it decides whether a Host belongs to S3 or to a service… - [Networking — Hostnames that resolve for every caller](https://overcast.sh/docs/networking/hostnames/index.md): Set OVERCAST_HOSTNAME to a name your shell and your containers both resolve: the wildcard DNS domain… - [Networking — Network state verification](https://overcast.sh/docs/networking/network-state/index.md): Docker returns an existing network unchanged, so Overcast checks every field of each network it reuses on… - [Networking — routed: egress from your route tables](https://overcast.sh/docs/networking/routed-egress/index.md): OVERCAST_VPC_EGRESS=routed decides egress per subnet from the route table associated with it… - [Networking — Networking troubleshooting](https://overcast.sh/docs/networking/troubleshooting/index.md): Symptom, cause and fix for names that will not resolve, ports that differ by caller, refused data-plane names… - [Networking — What host and port a URL carries](https://overcast.sh/docs/networking/urls/index.md): Overcast mints every URL on the configured hostname and the port you reached it on… - [Networking — How a VPC is backed by a Docker network](https://overcast.sh/docs/networking/vpc-backing/index.md): Each non-default VPC becomes a real Docker bridge: the labels it carries, what an internet gateway does to it… - [Networking — Lambda, ECS and VPCs](https://overcast.sh/docs/networking/vpcs/index.md): A VpcConfig puts the container in that VPC and takes away everything outside it… ## Storage & Performance - [Performance and memory](https://overcast.sh/docs/performance/index.md): The startup, memory and image-size targets, what each storage backend costs at startup… - [Performance — Storage tuning](https://overcast.sh/docs/performance/storage-tuning/index.md): Where /data should live, what the slow-filesystem probe is telling you, and the hybrid flush knobs… - [Storage and persistence](https://overcast.sh/docs/storage/index.md): Pick and configure a storage backend: what auto resolves to, what survives a restart on each of… ## Troubleshooting - [Troubleshooting](https://overcast.sh/docs/troubleshooting/index.md): Start here when something is wrong: a symptom-to-guide index, then every startup warning and runtime advisory… ## Reference - [CLI reference](https://overcast.sh/docs/cli/index.md): The overcast binary: the three commands most people need, and a page per command group — running the daemon… - [CLI — Pointing AWS tools at Overcast](https://overcast.sh/docs/cli/aws/index.md): overcast env prints AWS_* exports for your shell to eval; overcast aws runs one AWS CLI call against the… - [CLI — Reaching Overcast by name](https://overcast.sh/docs/cli/bridge/index.md): overcast bridge publishes overcast.local and every API Gateway custom domain over mDNS and proxies port 80 by… - [CLI — Running the daemon](https://overcast.sh/docs/cli/daemon/index.md): overcast serve runs the emulator in the foreground; overcast start runs it detached under a name that stop… - [CLI — Checking a running daemon](https://overcast.sh/docs/cli/inspect/index.md): overcast status, wait, services and config: is the daemon up, is it ready yet, which services are enabled… - [CLI — Docker networks](https://overcast.sh/docs/cli/networks/index.md): overcast network status compares every Overcast-managed Docker network against what your configuration asks… - [CLI — Wiping and importing state](https://overcast.sh/docs/cli/state/index.md): overcast reset wipes emulated state, all of it or one service's; overcast import cognito-users copies users… - [CLI — HTTPS and the trust store](https://overcast.sh/docs/cli/tls/index.md): overcast https enable sets up browser-trusted TLS in one command; overcast trust manages the Overcast CA in… - [Configuration](https://overcast.sh/docs/configuration/index.md): Overcast is configured entirely with environment variables. The handful most people set… - [Configuration — Log levels](https://overcast.sh/docs/configuration/log-levels/index.md): What each OVERCAST_LOG_LEVEL prints — info, debug, trace, warn and error… - [Configuration — Exposing MCP](https://overcast.sh/docs/configuration/mcp/index.md): OVERCAST_MCP_REMOTE_EXPOSURE and OVERCAST_MCP_AUTH_TOKEN turn on bearer-token auth for /_overcast/mcp… - [Configuration — Bind address and port](https://overcast.sh/docs/configuration/ports/index.md): Which addresses and ports Overcast binds for the AWS API and the web console, how to bind several at once… - [Configuration — Environment variable reference](https://overcast.sh/docs/configuration/reference/index.md): Every environment variable Overcast reads, with its default: the OVERCAST_* settings… - [Configuration — Running two instances on one host](https://overcast.sh/docs/configuration/two-instances/index.md): Which listeners find a free port on their own, which port bases you have to move by hand… - [Debug endpoints](https://overcast.sh/docs/debug-endpoints/index.md): The /_overcast/debug/* namespace and always-on diagnostics: health, metrics, state dump, request tracing… - [LocalStack compatibility matrix](https://overcast.sh/docs/localstack-compatibility/index.md): Every part of a LocalStack setup — ports, endpoints, hostnames, container conventions… - [Reference index](https://overcast.sh/docs/reference/index.md): Runtime emulation tiers, the full service index with per-service coverage, supported event pipelines… ## More detail - [Service reference index](https://overcast.sh/docs/services/llms.txt): Every emulated service, with its operations, limitations and examples.