Installation

1. Docker
2. Kubernetes
3. PyPI

Docker

Olli is available as a Docker image hosted at ghcr.io/python-discord/olli.

There are several tags available (ghcr.io/python-discord/olli:{tag}):

• :main will track to the latest main commit to Olli.
• :latest will track to the latest release of Olli.
• :<semver> (e.g. :0.0.1) will track to a specific release of Olli.
• :<sha> will track to a specific commit to a specific commit to Olli.

Head to ghcr.io/python-discord/olli to see all available versions.

Once you have a container image you need to configure it by placing a config file in a location described in Configuration.

An example Docker run might look like:

$ docker run --env-file .env ghcr.io/python-discord/olli:latest

Kubernetes

The Kubernetes setup is very much similar to Docker, so reading that is advised.

An example Kubernetes deployment manifest can be found here in the repository.

PyPI

Olli is available on PyPI under the olli package.

Install it with pip install olli. The PyPI version only supports Python 3.9+.

You should then be able to run olli (or sometimes python -m olli) to start Olli.

Once installed follow Configuration to configure Olli to report.