Skip to content

Installation

All the application is shipped inside a single Docker image except for the database. The currently used database is PostgreSQL.

Here an example configuration for your docker-compose.yml file:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
services:
  app:
    image: ghcr.io/gashmob/minecraft-monitor:latest
    ports:
      - "80:80"
    volumes:
      - ./config.toml:/etc/minecraft-monitor/config.toml # (1)
    depends_on:
      - db

  db:
    image: postgres:latest
    volumes:
      - db-data:/var/lib/postgresql/data

volumes:
  db-data:
  1. A volume bind to application configuration file, you can see more here.

Do not use this file directly

You should adapt it to your environment. Especially for the database configuration and version pin.

From sources#

The git repository is available here: https://github.com/Gashmob/minecraft-monitor.

You can either build yourself the docker image and run it anywhere or run it locally by "just" building the app. No matter your choice, all the tools are available inside a Nix shell.