From e7d9ccbb93a7353b29bab16351874744bfb93575 Mon Sep 17 00:00:00 2001 From: davidnewhall2 Date: Mon, 9 Sep 2019 01:33:08 -0700 Subject: [PATCH] update readmes --- README.md | 2 +- init/docker/README.md | 17 +++++++++++++++++ 2 files changed, 18 insertions(+), 1 deletion(-) create mode 100644 init/docker/README.md diff --git a/README.md b/README.md index 91e1de96..c2ca2d6a 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ [![pulls](https://badgen.net/docker/pulls/golift/unifi-poller?icon=https://simpleicons.now.sh/docker/38B1ED&label=pulls&color=0011ff "Docker Pulls")](https://hub.docker.com/r/golift/unifi-poller) [![DLs](https://img.shields.io/github/downloads/davidnewhall/unifi-poller/total.svg?logo=github&color=0116ff "GitHub Downloads")](https://www.somsubhra.com/github-release-stats/?username=davidnewhall&repository=unifi-poller) -[![unifi](https://badgen.net/badge/UniFi/5.10.x,5.11.x,UAP,USG,USW?list=|&icon=https://docs.golift.io/svg/ubiquiti_color.svg&color=0099ee "UniFi Products Supported")](https://github.com/golift/unifi) +[![unifi](https://badgen.net/badge/UniFi/5.11.x,5.12.x,UAP,USG,USW,UDM?list=|&icon=https://docs.golift.io/svg/ubiquiti_color.svg&color=0099ee "UniFi Products Supported")](https://github.com/golift/unifi) [![builer](https://badgen.net/badge/go/Application%20Builder?label=&icon=https://docs.golift.io/svg/go.svg&color=0099ee "Go Application Builder")](https://github.com/golift/application-builder) [![stars](https://badgen.net/github/stars/davidnewhall/unifi-poller?icon=https://simpleicons.now.sh/macys/fab&label=&color=0099ee "GitHub Stars")](https://github.com/davidnewhall/unifi-poller) [![travis](https://badgen.net/travis/davidnewhall/unifi-poller?icon=travis&label=build "Travis Build")](https://travis-ci.org/davidnewhall/unifi-poller) diff --git a/init/docker/README.md b/init/docker/README.md new file mode 100644 index 00000000..67b37750 --- /dev/null +++ b/init/docker/README.md @@ -0,0 +1,17 @@ +## Docker Cloud Builds + +This folder contains the files that build our Docker image. The image +is built by Docker Hub "automatically" using the [Dockerfile](Dockerfile) +and [hooks/](hooks/) in this folder. + +## Docker Compose + +The other files in this folder can be used locally to spin up +a full set of applications (minus the UniFi controller) to get +UniFi Poller up and running. Including InfluxDB, Grafana, and +Chronograph. This last app is useful to inspect the data stored +in InfluxDB by UniFi Poller. + +##### HOWTO +**Learn more about how and when to use these *Docker Compose* files in the +[Docker Wiki](https://github.com/davidnewhall/unifi-poller/wiki/Docker).**