From 847ed69cc67770a5eb67af1befe7aad7e0c7c324 Mon Sep 17 00:00:00 2001 From: samwiseg0 Date: Mon, 31 Dec 2018 01:00:07 -0500 Subject: [PATCH] Update the README to reflect wiki changes --- README.md | 67 ++++++------------------------------------------------- 1 file changed, 7 insertions(+), 60 deletions(-) diff --git a/README.md b/README.md index d31afcd..73107ef 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,10 @@ [![Build Status](https://travis-ci.org/Boerderij/Varken.svg?branch=master)](https://travis-ci.org/Boerderij/Varken) [![Discord](https://img.shields.io/badge/Discord-Varken-7289DA.svg?logo=discord&style=flat-square)](https://discord.gg/AGTG44H) [![BuyMeACoffee](https://img.shields.io/badge/BuyMeACoffee-Donate-ff813f.svg?logo=CoffeeScript&style=flat-square)](https://www.buymeacoffee.com/varken) +[![Docker-Layers](https://images.microbadger.com/badges/image/boerderij/varken.svg)](https://microbadger.com/images/boerderij/varken) +[![Docker-Version](https://images.microbadger.com/badges/version/boerderij/varken.svg)](https://microbadger.com/images/boerderij/varken) +[![Docker Pulls](https://img.shields.io/docker/pulls/boerderij/varken.svg)](https://hub.docker.com/r/boerderij/varken/) +[![Docker Stars](https://img.shields.io/docker/stars/boerderij/varken.svg)](https://hub.docker.com/r/boerderij/varken/) Dutch for PIG. PIG is an Acronym for Plex/InfluxDB/Grafana @@ -10,7 +14,7 @@ from the Plex ecosystem into InfluxDB. Examples use Grafana for a frontend Requirements: -* Python3.6.7+ +* [Python 3.6.7+](https://www.python.org/downloads/release/python-367/) * Python3-pip * [InfluxDB](https://www.influxdata.com/) @@ -34,65 +38,8 @@ Key features: * Grafana [Worldmap Panel](https://grafana.com/plugins/grafana-worldmap-panel/installation) support -## Quick Setup (Git Clone) -``` -# 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 -``` -### Docker - -[![Docker-Layers](https://images.microbadger.com/badges/image/boerderij/varken.svg)](https://microbadger.com/images/boerderij/varken) -[![Docker-Version](https://images.microbadger.com/badges/version/boerderij/varken.svg)](https://microbadger.com/images/boerderij/varken) -[![Docker Pulls](https://img.shields.io/docker/pulls/boerderij/varken.svg)](https://hub.docker.com/r/boerderij/varken/) -[![Docker Stars](https://img.shields.io/docker/stars/boerderij/varken.svg)](https://hub.docker.com/r/boerderij/varken/) -
Example -

- -``` -docker run -d \ - --name=varken \ - -v :/config \ - -e PGID= -e PUID= \ - -e TZ=America/Chicago \ - boerderij/varken -``` -

-
- -#### Tags -* **latest** -* **nightly** -* **release-tag** e.g. v1.0 - -#### Upgrading with docker -```sh -docker stop varken -docker rm varken -# Run deploy command above -``` +## Installation Guides +* Installation guides can be found in the [wiki](https://github.com/Boerderij/Varken/wiki/Installation). ### InfluxDB [InfluxDB Installation Documentation](https://docs.influxdata.com/influxdb/v1.7/introduction/installation/)