Welcome

⚠️ IMPORTANT: Remember that this documentation is public. Treat any sensitive data or credentials with the same level of caution that you would on any public forum.

Quickstart

To create all the relevant Docker containers, run:

# Build and start the containers defined in docker-compose.yml
docker-compose up -d

To get data and media from the host platform, check out fetching data.

Updating this documentation

The navigation for this this documentation is configured in mkdocs.yml. You can add new markdown files there to get them to appear in the navigation.

You can preview changes locally by starting the docs container (if it isn't already running):

docker compose up -d docs

This will make your local copy of the documentation available in your browser at: http://localhost:8001/