Overcast is alpha — behaviour and APIs may change between releases. Pin your version and read the changelog before upgrading.

overcast

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.

>_ start overcast
docker run --rm \
  -p 4566:4566 \
  -p 4567:4567 \
  ghcr.io/overcast-sh/overcast:latest

Common first steps

Build against it

You have it running and you are writing the app.

Run and operate it

You are the one who has to keep it up.

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 :latest and :alpha move with every release.
  • Check the release changelog before upgrading.
  • Report anything unexpected on GitHub.