Merge pull request #258 from jpartain89/master

Synology Docker-Compose

init/synology-docker-compose/.gitignore

@@ -0,0 +1 @@
+.env

init/synology-docker-compose/README.md

@@ -0,0 +1,81 @@
+# Synology Docker Compose Example
+
+This folder is an example `docker-compose.yml` file and a `.env` file for using docker through a Synology Server.
+
+The `.env` file is a special environment/variable file that `docker-compose` automatically uses to make configuration of your containers easier.
+
+## Directions
+
+First, create the directories where you want the containers to save everything. I use the same base directory for them, like: `/volume1/Docker/unifi-poller`, then inside the `./unifi-poller` directory: `./grafana` and `./influxdb`.
+
+  NOTE: Its best to use the command line over SSH to create these directories, AFTER you have the root shared directory created. (`Control Panel -> Shared Folder -> Create`)
+
+```bash
+sudo mkdir -p /volume[#]/[Shared Directory]/unifi-poller/grafana
+sudo mkdir -p /volume[#]/[Shared Directory]/unifi-poller/influxdbx
+```
+
+Where `/volume[#]` is the volume number corresponding to your volumes in Synology;
+`[Shared Directory]` is the shared directory from above, and then
+creating the `grafana and influxdb` directories.
+
+You still have to [do this prep work](https://github.com/unifi-poller/unifi-poller/wiki/Synology-HOWTO#method-2), creating the `unifi-poller` user, which I'll re-iterate here:
+
+#. Create a new user account on the Synology from the Control Panel:
+    - Name the user `unifi-poller`
+    - Set the password (you don't need to logon as unifipoller and change it)
+    - `Disallow Password Change`
+    - Assign them to the user group `users`
+    - Give them `r/w` permission to the folder you created e.g. `/docker/unifi-poller`
+    - Don't assign them **anything** else - the point of this user is for security's sake.
+#. SSH into your Synology
+#. Run the following command to find the PID of the user you created and set the variable `GRAFANA_LOCAL_USERID` in your `.env` file:
+    - `sudo id unifi-poller`
+    - `GRAFANA_LOCAL_USERID=1026`
+
+## Spin Up the Containers
+
+At this point, you are able to run `sudo docker-compose up -d` from within the directory that you have the `docker-compose.yml` file and the `.env` file saved on your Synology. 
+
+And now we have to create the Influx Database.
+
+## Create Influx Database
+
+#. Click `Containers` and then double click the running `influxdb1` container
+#. Switch to the `terminal` tab
+#. Click the drop down next to `Create` and select `launch with command`
+#. Enter `bash` and click `ok`
+#. Select `bash` from the left hand side. You should now see an active `command prompt`
+#. In the command prompt, enter these commands: (note: pasting IS possible! You have to right click in the terminal window and select `paste`)
+        
+`influx`
+After a couple of seconds you should be in the InfluxDB shell. 
+Run the following commands in the InfluxDB shell, then close the window:
+
+```
+CREATE DATABASE unifi
+USE unifi
+CREATE USER unifipoller WITH PASSWORD 'unifipoller' WITH ALL PRIVILEGES
+GRANT ALL ON unifi TO unifipoller
+exit
+```
+
+## Variables
+
+For all of the variables used in the docker-compose file, you'll find them in the `docker-compose.example.env` file. Please, `cp docker-compose.example.env .env` and open it in your favorite text editor. `nano .env`
+
+For the `/local/storage/location/` lines, change those to match your directories.
+
+```bash
+#influxdb
+INFLUXDB_ADMIN_PASSWORD=changeme
+INFLUXDB_LOCAL_VOLUME=/local/storage/location/influxdb
+
+#grafana
+GRAFANA_USERNAME=unifi-poller_username
+GRAFANA_PASSWORD=changeme
+GRAFANA_LOCAL_USERID=1026
+
+UNIFI_PASS=set_this_on_your_controller
+UNIFI_URL=https://127.0.0.1:8443
+```

init/synology-docker-compose/docker-compose.example.env

@@ -0,0 +1,20 @@
+#influxdb
+INFLUXDB_HTTP_AUTH_ENABLED=true
+INFLUXDB_ADMIN_USER=unifi-poller
+INFLUXDB_ADMIN_PASSWORD=changeme
+INFLUXDB_DB=unifi
+INFLUXDB_LOCAL_VOLUME=/local/storage/location/influxdb
+
+#grafana
+GRAFANA_USERNAME=grafana_username
+GRAFANA_PASSWORD=changeme
+GRAFANA_LOCAL_VOLUME=/local/storage/location/grafana
+GRAFANA_LOCAL_USERID=1026
+
+#unifi-poller
+POLLER_TAG=latest
+POLLER_DEBUG=false
+POLLER_SAVE_DPI=false
+UNIFI_USER=unifipoller
+UNIFI_PASS=set_this_on_your_controller
+UNIFI_URL=https://127.0.0.1:8443

init/synology-docker-compose/docker-compose.yml

@@ -0,0 +1,52 @@
+# This is for unifi-poller v2.
+version: '3'
+services:
+
+  influxdb:
+    restart: always
+    image: influxdb:latest
+    volumes:
+      - ${INFLUXDB_LOCAL_VOLUME}:/var/lib/influxdb
+    environment:
+      - INFLUXDB_DATA_DIR=/var/lib/influxdb/data
+      - INFLUXDB_DATA_WAL_DIR=/var/lib/influxdb/wal
+      - INFLUXDB_DATA_META_DIR=/var/lib/influxdb/meta
+    networks:
+      - Grafana_Network
+
+  grafana:
+    image: grafana/grafana:latest
+    restart: always
+    ports:
+      - '3000:3000'
+    volumes:
+      - ${GRAFANA_LOCAL_VOLUME}:/var/lib/grafana
+    depends_on:
+      - influxdb
+    user: "${GRAFANA_LOCAL_USERID}"
+    environment:
+      - GF_SECURITY_ADMIN_USER=${GRAFANA_USERNAME}
+      - GF_SECURITY_ADMIN_PASSWORD=${GRAFANA_PASSWORD}
+      - GF_INSTALL_PLUGINS=grafana-clock-panel,natel-discrete-panel,grafana-piechart-panel
+      - GF_SERVER_DOMAIN=${GRAFANA_SERVER_DOMAIN}
+      - GF_ENFORCE_DOMAIN=true
+    networks:
+      - Grafana_Network
+
+  unifi-poller:
+    restart: always
+    image: golift/unifi-poller:latest
+    environment:
+      - UP_INFLUXDB_USER=${INFLUXDB_ADMIN_USER}
+      - UP_INFLUXDB_PASS=${INFLUXDB_ADMIN_PASSWORD}
+      - UP_INFLUXDB_URL=http://influxdb:8086
+      - UP_UNIFI_DEFAULT_USER=${UNIFI_USER}
+      - UP_UNIFI_DEFAULT_PASS=${UNIFI_PASS}
+      - UP_UNIFI_DEFAULT_URL=${UNIFI_URL}
+      - UP_POLLER_DEBUG=${POLLER_DEBUG}
+      - UP_UNIFI_DEFAULT_SAVE_DPI=${POLLER_SAVE_DPI}
+    networks:
+      - Grafana_Network
+
+networks:
+  Grafana_Network: