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.7+
- Python3-pip
- InfluxDB
Supported Modules:
- Sonarr - Smart PVR for newsgroup and bittorrent users.
- SickChill - SickChill is an automatic Video Library Manager for TV Shows.
- Radarr - A fork of Sonarr to work with movies à la Couchpotato.
- Tautulli - A Python based monitoring and tracking tool for Plex Media Server.
- Ombi - Want a Movie or TV Show on Plex or Emby? Use Ombi!
- Cisco ASA
Key features:
- Multiple server support for all modules
- Geolocation mapping from GeoLite2
- Grafana Worldmap Panel support
# Clone the repository
git clone https://github.com/Boerderij/Varken.git /opt/Varken
# Follow the systemd install instructions located in varken.systemd
cp /opt/Varken/varken.systemd /etc/systemd/system/varken.service
nano /etc/systemd/system/varken.service
# Create venv in project
/usr/bin/python3 -m venv /opt/Varken/varken-venv
# Install requirements
/opt/Varken/varken-venv/bin/python -m pip install -r requirements.txt
# 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
# Make the appropriate changes to varken.ini
nano /opt/Varken/data/varken.ini
# Make sure all the files have the appropriate permissions
chown $USER:$USER -R /opt/Varken
# Start the service and enable it
systemctl start varken
systemctl enable varken
Example
docker run -d \
--name=varken \
-v <path to data>:/config \
-e PGID=<gid> -e PUID=<uid> \
-e TZ=America/Chicago \
boerderij/varken
- latest
- nightly
- release-tag e.g. v1.0
docker stop varken
docker rm varken
# Run deploy command above
InfluxDB Installation Documentation
Influxdb is required but not packaged as part of Varken. Varken will create
its database on its own. If you choose to give varken user permissions that
do not include database creation, please ensure you create an influx database
named varken
Grafana Installation Documentation
Official Example Dashboards
Grafana is used in our examples but not required, nor packaged as part of Varken. Panel examples now exist in both nightly and tagged releases hosted on grafana.com (link above).
- Use the link above, then click on your desired dashboard version
- Click
Copy ID to Clipboard
- In grafana, click your dashboards menu dropdown, and then click
Import dashboard
- Paste the ID into the
Grafana.com Dashboard
field and then click into empty space on the screen. (This should change the screen to showImporting Dashboard from Grafana.com
- Select your varken datasource name in the dropdown labeled
Varken
- Click Import!