Run Monika in Docker

Monika is available as a docker image. You can find the image in the docker hub as hyperjump/monika, or pull the image with the following command

 docker pull hyperjump/monika

Running Monika on ARM / Apple Silicon

Monika docker image only supports amd64 architecture, you have to pass --platform linux/amd64 when using hyperjump/monika docker image

 docker pull --platform linux/amd64 hyperjump/monika

Once you've pulled the latest image, you can run it using

1 # Run Monika in foreground
2 docker run --name monika --net=host -it hyperjump/monika:latest
3 
4 # Or, if you prefer to run Monika in the background
5 docker run --name monika --net=host --detach hyperjump/monika:latest
6 
7 # On ARM / Apple Silicon chip, pass --platform linux/amd64
8 docker run --name monika --net=host --platform linux/amd64 -it hyperjump/monika:latest
9 docker run --name monika --net=host --platform linux/amd64 --detach hyperjump/monika:latest

In the example above, we create a container from the hyperjump/monika base image naming it with--name monika, indicate we'll use the host machine's network configuration with --net=host and let it run in the backround using the --detach switch (or interactively with -it).

Once monika is up and running, you can see its log using

 docker logs monika

Or you can stop the container with

 docker stop monika

For more complex probing, for example to use your existing customized configuration and have the prometheus plugin. First copy your personalized config to a directory, say /config. Then create your container with the directory mounted as a --volume (-v) for the container to use, like so:

1 docker run --name monika_interactive \
2     --net=host \
3     -v ${PWD}/config:/config \
4     -d hyperjump/monika:latest \
5     monika -c /config/myConfig.yml --prometheus 3001
6 
7 # On ARM / Apple Silicon
8 docker run --name monika_interactive \
9     --net=host \
10     --platform linux/amd64 \
11     -v ${PWD}/config:/config \
12     -d hyperjump/monika:latest \
13     monika -c /config/myConfig.yml --prometheus 3001

Troubleshooting

Genererally when facing issues with your container or configuration, try the same configuration YAML using regular monika. For instance:

 monika -c myConfig.yml --prometheus 3001

Ensure your container is up and running by issuing simple commands/parameters:

1 docker run --name monika_interactive \
2     -it hyperjump/monika:latest monika --help

For further docker commands and documentation, visit the official Docker documentation here.

If all else fails, hit us up at monika discussions or file an issue.