From cfb532794074350be481560b7947f129fa892ed4 Mon Sep 17 00:00:00 2001 From: samwiseg0 Date: Tue, 4 Dec 2018 11:03:39 -0500 Subject: [PATCH] Update README to simplify instructions --- README.md | 24 +++++++++++------------- 1 file changed, 11 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 1201638..5291bf0 100644 --- a/README.md +++ b/README.md @@ -7,24 +7,22 @@ frontend Requirements /w install links: [Grafana](http://docs.grafana.org/installation/), [Python3](https://www.python.org/downloads/), [InfluxDB](https://docs.influxdata.com/influxdb/v1.5/introduction/installation/) -
+

+ +

## 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/` -1. Switch to the testing branch `cd /opt/Varken && git checkout refactor-project` +1. Follow the systemd install instructions located in `varken.systemd` 1. Create venv in project `/usr/bin/python3 -m venv varken-venv` 1. Install requirements `/opt/Varken/varken-venv/bin/python -m pip install -r requirements.txt` -2. Make a copy of `varken.example.ini` to `varken.ini` in the `data` folder +1. 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` -3. Make the appropriate changes to `varken.ini` - `nano /opt/Varken/data/varken.ini` -4. Copy the systemd file `sudo cp /opt/Varken/varken.service /etc/systemd/system/` -1. Edit the username of the systemd file `sudo sed -i "s/username/$USER" /etc/systemd/system/varken.service` -5. start the service and enable it `systemctl start varken && systemctl enable varken` -5. After completing the [getting started](http://docs.grafana.org/guides/getting_started/) portion of grafana, create your datasource for influxdb. At a minimum, you will need the plex database. -6. Install `grafana-cli plugins install grafana-worldmap-panel` -7. TODO:: Click the + on your menu and click import. Using the .json provided in this repo, paste it in and customize as you like. +1. Make the appropriate changes to `varken.ini` + ie.`nano /opt/Varken/data/varken.ini` +1. After completing the [getting started](http://docs.grafana.org/guides/getting_started/) portion of grafana, create your datasource for influxdb. +1. Install `grafana-cli plugins install grafana-worldmap-panel` +1. 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 @@ -41,4 +39,4 @@ docker create \ si0972/grafana-scripts:varken ```

- \ No newline at end of file +