d_mcknight/Varken
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update README to simplify instructions

Browse source
This commit is contained in:
samwiseg0 2018-12-04 11:03:39 -05:00
parent 3993f6e9e0
commit cfb5327940
1 changed files with 11 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
README.md
View file

@ -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/) 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/)
<center><img width="800" src="https://i.imgur.com/av8e0HP.png"></center> <p align="center">
<img width="800" src="https://i.imgur.com/av8e0HP.png">
</p>
## Quick Setup (Varken Alpha) ## Quick Setup (Varken Alpha)
1. Clone the repository `sudo git clone https://github.com/DirtyCajunRice/grafana-scripts.git /opt/Varken` 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. Follow the systemd install instructions located in `varken.systemd`
1. Switch to the testing branch `cd /opt/Varken && git checkout refactor-project`
1. Create venv in project `/usr/bin/python3 -m venv varken-venv` 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` 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` `cp /opt/Varken/data/varken.example.ini /opt/Varken/data/varken.ini`
3. Make the appropriate changes to `varken.ini` 1. Make the appropriate changes to `varken.ini`
`nano /opt/Varken/data/varken.ini` ie.`nano /opt/Varken/data/varken.ini`
4. Copy the systemd file `sudo cp /opt/Varken/varken.service /etc/systemd/system/` 1. After completing the [getting started](http://docs.grafana.org/guides/getting_started/) portion of grafana, create your datasource for influxdb.
1. Edit the username of the systemd file `sudo sed -i "s/username/$USER" /etc/systemd/system/varken.service` 1. Install `grafana-cli plugins install grafana-worldmap-panel`
5. start the service and enable it `systemctl start varken && systemctl enable varken` 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.
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.
### Docker ### Docker
@ -41,4 +39,4 @@ docker create \
si0972/grafana-scripts:varken si0972/grafana-scripts:varken
``` ```
</p> </p>
</details> </details>