d_mcknight/Varken
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Varken/README.md
Nicholas St. Germain 62a2134833 added docker config to readme
2018-12-03 14:37:29 -06:00

2.1 KiB
Raw Blame History

Varken

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

Varken is a standalone commmand-line utility that will aggregate date from the plex ecosystem into influxdb to be displayed in grafana

Requirements /w install links: Grafana, Python3, InfluxDB

Quick Setup (Varken Alpha)

  1. Clone the repository sudo git clone https://github.com/DirtyCajunRice/grafana-scripts.git /opt/Varken
  2. Change ownership to current user sudo chown $USER -R /opt/Varken/
  3. Switch to the testing branch cd /opt/Varken && git checkout refactor-project
  4. Create venv in project /usr/bin/python3 -m venv varken-venv
  5. Install requirements /opt/Varken/varken-venv/bin/python -m pip install -r requirements.txt
  6. 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
  7. Make the appropriate changes to varken.ini nano /opt/Varken/data/varken.ini
  8. Copy the systemd file sudo cp /opt/Varken/varken.service /etc/systemd/system/
  9. Edit the username of the systemd file sudo sed -i "s/username/$USER" /etc/systemd/system/varken.service
  10. start the service and enable it systemctl start varken && systemctl enable varken
  11. After completing the getting started portion of grafana, create your datasource for influxdb. At a minimum, you will need the plex database.
  12. Install grafana-cli plugins install grafana-worldmap-panel
  13. 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 plex=true \
  -e PGID=<gid> -e PUID=<uid>  \
  si0972/grafana-scripts:varken