Merge pull request #43 from linuxserver/readme

fix readme-vars syntax

Author: nemchik

README.md

@@ -33,7 +33,7 @@ Find us at:
 [![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/unifi-controller.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pulls&logo=docker)](https://hub.docker.com/r/linuxserver/unifi-controller)
 [![Docker Stars](https://img.shields.io/docker/stars/linuxserver/unifi-controller.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=stars&logo=docker)](https://hub.docker.com/r/linuxserver/unifi-controller)
 [![Jenkins Build](https://img.shields.io/jenkins/build?labelColor=555555&logoColor=ffffff&style=for-the-badge&jobUrl=https%3A%2F%2Fci.linuxserver.io%2Fjob%2FDocker-Pipeline-Builders%2Fjob%2Fdocker-unifi-controller%2Fjob%2Fmaster%2F&logo=jenkins)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-unifi-controller/job/master/)
-[![LSIO CI](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=CI&query=CI&url=https%3A%2F%2Flsio-ci.ams3.digitaloceanspaces.com%2Flspipepr%2Funifi-controller%2Flatest%2Fci-status.yml)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/unifi-controller/latest/index.html)
+[![LSIO CI](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=CI&query=CI&url=https%3A%2F%2Flsio-ci.ams3.digitaloceanspaces.com%2Flinuxserver%2Funifi-controller%2Flatest%2Fci-status.yml)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/unifi-controller/latest/index.html)
 
 The [Unifi-controller](https://www.ubnt.com/enterprise/#unifi) Controller software is a powerful, enterprise wireless software engine ideal for high-density client deployments requiring low latency and high uptime performance.
 
@@ -70,11 +70,12 @@ docker create \
   -p 3478:3478/udp \
   -p 10001:10001/udp \
   -p 8080:8080 \
-  -p 8081:8081 \
   -p 8443:8443 \
-  -p 8843:8843 \
-  -p 8880:8880 \
-  -p 6789:6789 \
+  -p 1900:1900/udp `#optional` \
+  -p 8843:8843 `#optional` \
+  -p 8880:8880 `#optional` \
+  -p 6789:6789 `#optional` \
+  -p 5514:5514 `#optional` \
   -v <path to data>:/config \
   --restart unless-stopped \
   linuxserver/unifi-controller
@@ -117,11 +118,12 @@ services:
       - 3478:3478/udp
       - 10001:10001/udp
       - 8080:8080
-      - 8081:8081
       - 8443:8443
-      - 8843:8843
-      - 8880:8880
-      - 6789:6789
+      - 1900:1900/udp #optional
+      - 8843:8843 #optional
+      - 8880:8880 #optional
+      - 6789:6789 #optional
+      - 5514:5514 #optional
     restart: unless-stopped
 ```
 
@@ -131,14 +133,15 @@ Container images are configured using parameters passed at runtime (such as thos
 
 | Parameter | Function |
 | :----: | --- |
-| `-p 3478/udp` | Unifi communication port |
-| `-p 10001/udp` | required for AP discovery |
-| `-p 8080` | required for Unifi to function |
-| `-p 8081` | Unifi communication port |
-| `-p 8443` | Unifi communication port |
-| `-p 8843` | Unifi communication port |
-| `-p 8880` | Unifi communication port |
-| `-p 6789` | For throughput test |
+| `-p 3478/udp` | Unifi STUN port |
+| `-p 10001/udp` | Required for AP discovery |
+| `-p 8080` | Required for device communication |
+| `-p 8443` | Unifi web admin port |
+| `-p 1900/udp` | Required for `Make controller discoverable on L2 network` option |
+| `-p 8843` | Unifi guest portal HTTPS redirect port |
+| `-p 8880` | Unifi guest portal HTTP redirect port |
+| `-p 6789` | For mobile throughput test |
+| `-p 5514` | Remote syslog port |
 | `-e PUID=1000` | for UserID - see below for explanation |
 | `-e PGID=1000` | for GroupID - see below for explanation |
 | `-e MEM_LIMIT=1024M` | Optionally change the Java memory limit (-Xmx) (default is 1024M). |
@@ -186,7 +189,6 @@ Alternatively to manually adopt a device take these steps:
 
 ```
 ssh ubnt@$AP-IP
-mca-cli
 set-inform http://$address:8080/inform
 ```
 
@@ -263,6 +265,7 @@ Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64
 
 ## Versions
 
+* **02.06.20:** - Updated port list & descriptions. Moved some ports to optional.
 * **14.11.19:** - Changed url for deb package to match new Ubiquity domain.
 * **29.07.19:** - Allow for changing Java mem limit via new optional environment variable.
 * **23.03.19:** - Switching to new Base images, shift to arm32v7 tag.

readme-vars.yml

@@ -54,7 +54,7 @@ param_usage_include_env: false
 
 opt_param_usage_include_ports: true
 opt_param_ports:
-  - { external_port: "1900", internal_port: "1900/udp", port_desc: "Required for "Make controller discoverable on L2 network" option" }
+  - { external_port: "1900", internal_port: "1900/udp", port_desc: "Required for `Make controller discoverable on L2 network` option" }
   - { external_port: "8843", internal_port: "8843", port_desc: "Unifi guest portal HTTPS redirect port" }
   - { external_port: "8880", internal_port: "8880", port_desc: "Unifi guest portal HTTP redirect port" }
   - { external_port: "6789", internal_port: "6789", port_desc: "For mobile throughput test" }