Add README
This commit is contained in:
parent
6b0fa3ac23
commit
4bb223efe8
|
|
@ -0,0 +1,20 @@
|
|||
Copyright (c) 2016 Garrett Bjerkhoel
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining
|
||||
a copy of this software and associated documentation files (the
|
||||
"Software"), to deal in the Software without restriction, including
|
||||
without limitation the rights to use, copy, modify, merge, publish,
|
||||
distribute, sublicense, and/or sell copies of the Software, and to
|
||||
permit persons to whom the Software is furnished to do so, subject to
|
||||
the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be
|
||||
included in all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
||||
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
||||
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
||||
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
||||
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
|
@ -0,0 +1,32 @@
|
|||
# Unifi
|
||||
|
||||
Collect your Unifi client data every 15 seconds and send it to an InfluxDB instance.
|
||||
|
||||

|
||||
|
||||
## Deploying
|
||||
|
||||
The repository is ready for deployment on Heroku. Steps to deploy:
|
||||
|
||||
Clone the repository and using `.env.example` create your own `.env` file with your Unifi GUI and InfluxDB credentials.
|
||||
|
||||
Create your heroku application:
|
||||
|
||||
```
|
||||
heroku create [name]
|
||||
```
|
||||
|
||||
Set your environment variables before deploying:
|
||||
|
||||
```
|
||||
heroku config:set $(cat .env | grep -v ^# | xargs)
|
||||
```
|
||||
|
||||
Push to heroku:
|
||||
|
||||
```
|
||||
git push heroku master
|
||||
```
|
||||
|
||||
## Copyright
|
||||
Copyright © 2016 Garrett Bjerkhoel. See [MIT-LICENSE](http://github.com/dewski/unifi/blob/master/MIT-LICENSE) for details.
|
||||
Loading…
Reference in New Issue