From c36c8014c45b1452d504519ddf12ae5b628531fa Mon Sep 17 00:00:00 2001 From: f Date: Thu, 1 Aug 2019 12:43:16 +0000 Subject: [PATCH] Add 'README.md' --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..8a09a70 --- /dev/null +++ b/README.md @@ -0,0 +1,19 @@ +A minimalist systemd service that periodically polls a minecraft server and logs player activity. This requires the minecraft server to have `enable-query=true`. + +The script is currently set up to poll `xkcd.cbouton.com` and produce a graph for the past *hour*, *day*, *month*, *4 months* and *18 months*. The graph is generated from `template.html`, an SVG inside an auto-refreshing HTML page. + +# Installation +Nothing in the installation process is automated so far: +1. Install Python 3.x +2. Perform `pip install mcstatus` in the monitor folder +3. Set the `PATH` in `xkcdstatus.service` to the monitor folder. +4. Optionally move the *web* subfolder to a location in your webserver root +5. Set the arguments in `xkcraftia-monitor.sh` to point to the *web* subfolder +6. Move `xkcdstatus.service` and `xkcdstatus.timer` to `/etc/systemd/system/` +7. Enable and start the timer +``` +sudo systemctl enable xkcdstatus.timer +sudo systemctl start xkcdstatus.timer +``` +# Demo +See a live version of the monitor at [xkcd.flumble.nl](https://xkcd.flumble.nl/) \ No newline at end of file