Varken/README.md
2018-12-05 10:33:36 -05:00

1.7 KiB

Varken

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 /w install links: Grafana, Python3, InfluxDB

Quick Setup (Varken Alpha)

  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 /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. After completing the getting started portion of grafana, create your datasource for influxdb.
  8. Install grafana-cli plugins install grafana-worldmap-panel
  9. TODO:: Click the + on your menu and click import. Using the .json provided in this repo, paste it in and customize as you like.

Docker

Repo is included in si0972/grafana-scripts-docker

Example

docker create \
  --name=grafana-scripts \
  -v <path to data>:/Scripts \
  -e PGID=<gid> -e PUID=<uid>  \
  si0972/grafana-scripts:varken