/Varken

Standalone command-line utility to aggregate data from the Plex ecosystem into InfluxDB

Primary LanguagePython

Varken

Discord BuyMeACoffee Docker Pulls

Dutch for PIG. PIG is an Acronym for Plex/InfluxDB/Grafana

Varken is a standalone command-line utility to aggregate data from the Plex ecosystem into InfluxDB. Examples use Grafana for a frontend

Requirements:

  • Python3.6+
  • Python3-pip

Quick Setup

  1. Clone the repository sudo git clone https://github.com/Boerderij/Varken.git /opt/Varken
  2. Follow the systemd install instructions located in varken.systemd
  3. Create venv in project cd /opt/Varken && /usr/bin/python3 -m venv varken-venv
  4. Install requirements /opt/Varken/varken-venv/bin/python -m pip install -r requirements.txt
  5. Make a copy of varken.example.ini to varken.ini in the data folder cp /opt/Varken/data/varken.example.ini /opt/Varken/data/varken.ini
  6. Make the appropriate changes to varken.ini ie.nano /opt/Varken/data/varken.ini
  7. Make sure all the files have the appropriate permissions sudo chown varken:varken -R /opt/Varken
  8. After completing the getting started portion of grafana, create your datasource for influxdb.
  9. Install grafana-cli plugins install grafana-worldmap-panel

Docker

Repo is included in Boerderij/docker-Varken

Example 

docker run -d \
  --name=varken \
  -v <path to data>:/config \
  -e PGID=<gid> -e PUID=<uid>  \
  boerderij/varken:nightly