Getting started

If you are just trying out Dokemon, you can quickly run an instance using the docker run command. You can also use Docker Compose files to run Dokemon.

Use your preferred method from the below. After you start Dokemon, you can open http://localhost:9090 in your browser.

Docker Run

Dokemon stores its data in /data directory which you can either map to a docker volume or to a directory on your host.

Store data in host directory

If you prefer easy access to the Dokemon data from your host, you can create a directory on your host and bind it to /data as below.

# Create directory to store Dokemon data
mkdir ./dokemondata

# Run Dokemon
sudo docker run -p 9090:9090 \
      -v ./dokemondata:/data \
      -v /var/run/docker.sock:/var/run/docker.sock \
      --restart unless-stopped \
      --name dokemon -d productiveops/dokemon:latest

Store data in volume

If you prefer using Docker volumes, you can use the below script.

# Create volume to store Dokemon data
sudo docker volume create dokemondata

# Run Dokemon
sudo docker run -p 9090:9090 \
      -v dokemondata:/data \
      -v /var/run/docker.sock:/var/run/docker.sock \
      --restart unless-stopped \
      --name dokemon -d productiveops/dokemon:latest

Docker Compose

You can use the below compose definition to manage Dokemon via Compose. Create a file called compose.yaml with the below content and run docker compose up -d

version: '3.3'

services:
  dokemon:
    image: productiveops/dokemon:latest
    container_name: dokemon
    restart: unless-stopped
    ports:
      - 9090:9090
    volumes:
      - dokemondata:/data
      - /var/run/docker.sock:/var/run/docker.sock

volumes:
  dokemondata: {}

Enabling SSL

To enable SSL set the value of SSL_ENABLED environment variable to 1 for the Dokemon container.

Dokemon will generate a self-signed certificate in /data/certs. The certificate file will be named server.crt and the key file will be named server.key.

If you want to use your own certificate you can replace the above files with your own certificate and key files.