2019-01-25 10:39:54 -08:00
|
|
|
<p align="center">
|
|
|
|
|
<img width="800" src="https://bin.cajun.pro/images/varken_full_banner.png">
|
|
|
|
|
</p>
|
|
|
|
|
|
2018-12-10 19:54:01 -08:00
|
|
|
[](https://travis-ci.org/Boerderij/Varken)
|
2019-01-02 14:19:44 -08:00
|
|
|
[](https://discord.gg/VjZ6qSM)
|
2018-12-06 22:34:46 -08:00
|
|
|
[](https://www.buymeacoffee.com/varken)
|
2018-12-30 22:00:07 -08:00
|
|
|
[](https://microbadger.com/images/boerderij/varken)
|
|
|
|
|
[](https://microbadger.com/images/boerderij/varken)
|
|
|
|
|
[](https://hub.docker.com/r/boerderij/varken/)
|
2018-12-06 22:34:46 -08:00
|
|
|
|
2018-12-01 21:47:59 -08:00
|
|
|
Dutch for PIG. PIG is an Acronym for Plex/InfluxDB/Grafana
|
2018-12-01 21:15:12 -08:00
|
|
|
|
2018-12-06 22:40:37 -08:00
|
|
|
Varken is a standalone command-line utility to aggregate data
|
2018-12-04 08:50:02 -08:00
|
|
|
from the Plex ecosystem into InfluxDB. Examples use Grafana for a
|
2018-12-03 21:47:46 -08:00
|
|
|
frontend
|
2018-04-17 08:44:32 -07:00
|
|
|
|
2018-12-06 22:34:46 -08:00
|
|
|
Requirements:
|
2018-12-30 22:00:07 -08:00
|
|
|
* [Python 3.6.7+](https://www.python.org/downloads/release/python-367/)
|
2018-12-06 22:34:46 -08:00
|
|
|
* Python3-pip
|
2018-12-14 12:37:43 -08:00
|
|
|
* [InfluxDB](https://www.influxdata.com/)
|
2018-04-17 08:44:32 -07:00
|
|
|
|
2018-12-04 08:03:39 -08:00
|
|
|
<p align="center">
|
2018-12-14 12:42:43 -08:00
|
|
|
Example Dashboard
|
2018-12-14 12:38:19 -08:00
|
|
|
|
2018-12-30 20:51:23 -08:00
|
|
|
<img width="800" src="https://i.imgur.com/3hNZTkC.png">
|
2018-12-04 08:03:39 -08:00
|
|
|
</p>
|
2018-10-29 17:16:31 -07:00
|
|
|
|
2018-12-14 12:37:43 -08:00
|
|
|
Supported Modules:
|
|
|
|
|
* [Sonarr](https://sonarr.tv/) - Smart PVR for newsgroup and bittorrent users.
|
2018-12-16 06:39:33 -08:00
|
|
|
* [SickChill](https://sickchill.github.io/) - SickChill is an automatic Video Library Manager for TV Shows.
|
2018-12-14 12:37:43 -08:00
|
|
|
* [Radarr](https://radarr.video/) - A fork of Sonarr to work with movies à la Couchpotato.
|
|
|
|
|
* [Tautulli](https://tautulli.com/) - A Python based monitoring and tracking tool for Plex Media Server.
|
|
|
|
|
* [Ombi](https://ombi.io/) - Want a Movie or TV Show on Plex or Emby? Use Ombi!
|
2019-01-05 13:47:07 -08:00
|
|
|
* [Unifi](https://unifi-sdn.ubnt.com/) - The Global Leader in Managed Wi-Fi Systems
|
2018-12-14 12:37:43 -08:00
|
|
|
|
|
|
|
|
Key features:
|
|
|
|
|
* Multiple server support for all modules
|
|
|
|
|
* Geolocation mapping from [GeoLite2](https://dev.maxmind.com/geoip/geoip2/geolite2/)
|
|
|
|
|
* Grafana [Worldmap Panel](https://grafana.com/plugins/grafana-worldmap-panel/installation) support
|
|
|
|
|
|
|
|
|
|
|
2018-12-30 22:00:07 -08:00
|
|
|
## Installation Guides
|
2018-12-30 22:59:36 -08:00
|
|
|
Varken Installation guides can be found in the [wiki](https://github.com/Boerderij/Varken/wiki/Installation).
|
2018-12-10 19:54:01 -08:00
|
|
|
|
|
|
|
|
### InfluxDB
|
2018-12-10 19:56:07 -08:00
|
|
|
[InfluxDB Installation Documentation](https://docs.influxdata.com/influxdb/v1.7/introduction/installation/)
|
2018-12-10 19:59:10 -08:00
|
|
|
|
2018-12-10 19:54:01 -08:00
|
|
|
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
|
2018-12-29 22:59:02 -08:00
|
|
|
[Grafana Installation Documentation](http://docs.grafana.org/installation/)
|
2018-12-30 22:59:36 -08:00
|
|
|
Official dashboard installation instructions can be found in the [wiki](https://github.com/Boerderij/Varken/wiki/Installation#grafana)
|
