This doc is far from complete.
Lets talk about how the software gets built for our users before we talk about making changes to it.
This repo is tested, built and deployed by Travis-CI.
The .travis.yml file in this repo coordinates the entire process. As long as this document is kept up to date, this is what the travis file does:
- Creates a go-capable build environment on a Linux host, some debian variant.
- Install ruby-devel to get rubygems.
- Installs other build tools including rpm and fpm from rubygems.
- Starts docker, builds the docker container and runs it.
- Tests that the Docker container ran and produced expected output.
- Makes a release.
make release: This does a lot of things, controlled by the Makefile.- Runs go tests and go linters.
- Compiles the application binaries for Windows, Linux and macOS.
- Compiles a man page that goes into the packages.
- Creates rpm and deb packages using fpm.
- Puts the packages, gzipped binaries and files containing the SHA256s of each asset into a release folder.
After the release is built and Docker image tested:
- Deploys the release assets to the tagged release on GitHub using an encrypted GitHub Token (api key).
- Runs another script to create and upload a Homebrew formula to golift/homebrew-mugs.
- Uses an encrypted SSH key to upload the updated formula to the repo.
- Travis does nothing else with Docker; it just makes sure the thing compiles and runs.
it's a mac thing.
Homebrew is all I use at home. Please don't break the homebrew formula stuff; it took a lot of pain to get it just right. I am very interested in how it works for you.
Docker is built automatically by Docker Cloud using the Dockerfile in the path
init/docker/Dockerfile. Some of the configuration is
done in the Cloud service under my personal account golift, but the majority
happens in the build files in the init/docker/hooks/ directory.
If you have need to change the Dockerfile, please clearly explain what problem your changes are solving, and how it has been tested and validated. As far as I'm concerned this file should never need to change again, but I'm not a Docker expert; you're welcome to prove me wrong.
Make a pull request and tell me what you're fixing. Pretty simple. If I need to I'll add more "rules." For now I'm happy to have help. Thank you!
If you see typos, errors, omissions, etc, please fix them.
At this point, the wiki is pretty solid. Please keep your edits brief and without too much opinion. If you want to provide a way to do something, please also provide any alternatives you're aware of. If you're not sure, just open an issue and we can hash it out. I'm reasonable.
The UniFi data extraction is provided as an external library, and you can import that code directly without futzing with this application. That means, if you wanted to do something like make telegraf collect your data instead of UniFi Poller you can achieve that with a little bit of Go code. You could write a small app that acts as a telegraf input plugin using the unifi library to grab the data from your controller.
This application is very dynamic and built using several package repos. They are all in the UniFi Poller GitHub Org.