diff --git a/README.md b/README.md index 8e6124c..e50d91c 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,58 @@ # unifi Docker container for Ubiquiti Unifi Controler -this Docker container based on Ubuntu runs a Ubiquiti Unifi Controler +this Docker container based on Ubuntu Trusty runs a Ubiquiti Unifi5 Controler. The Controler is a java app on top of MongoDB + +### build +```sh +docker build -t tommi2day/unifi:5.0 -f Dockerfile.unifi . +``` +see also build_unifi.sh +### exposed Ports +```sh +# WebUI Inform mongodb +EXPOSE 8443 8080 27117 +``` +### Volumes +```sh +VOLUME /usr/lib/unifi/data #Unifi config and data dir +VOLUME /backups /logs #logs and backup +``` + +### Environment variables used +```sh +None +``` + +### Run +Specify the environment variable and a volume +for the datafiles when launching a new container, e.g: + +```sh +docker volume create --name unifi_data +docker run -d \ + -v unifi_data:/usr/lib/unifi/data \ + -v /shared/unifi/backups:/backups \ + -v /shared/unifi/logs":/logs \ + --hostname unifi \ + --name unifi \ + -p 8080:8080 \ + -p 8443:8443 \ + -p 27117:27117 \ + tommi2day/unifi:5.0 +``` +see run_unifi.sh for an example + +### Addons +All Addons are in /usr/lib/unifi +####start/stop +unifi.sh is a start/stop/status script. the start script calls finally a tail -f server.log to keep the container running +####Backup +There is a cronjob in place calling backup_unifi.sh , which will trigger a logrotate for mongodb and afterwards +stop the Controler to tar the unifi data tree to /backups and restart finally +####Restore +for restoring a backup call/exec restore_unifi.sh [filename]. filename will be expected in /backups. Without filename the last backup +unifi_data.$(date '+%Y%m%d').tar.gz is assumed as default + see https://help.ubnt.com/hc/en-us/articles/220066768-UniFi-Debian-Ubuntu-APT-howto