readme-vars.yml

---

# project information
project_name: unifi-controller
project_url: "https://www.ubnt.com/enterprise/#unifi"
project_logo: "https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/unifi-banner.png"
project_blurb: "The [{{ project_name|capitalize }}]({{ project_url }}) software is a powerful, enterprise wireless software engine ideal for high-density client deployments requiring low latency and high uptime performance."
project_lsio_github_repo_url: "https://github.com/linuxserver/docker-{{ project_name }}"

project_deprecation_status: true
project_deprecation_message: |
  We recommend our unifi-network-application image instead:
  https://github.com/linuxserver/docker-unifi-network-application

# supported architectures
available_architectures:
  - { arch: "{{ arch_x86_64 }}", tag: "amd64-latest"}
  - { arch: "{{ arch_arm64 }}", tag: "arm64v8-latest"}

# development version
development_versions: true
development_versions_items:
  - { tag: "latest", desc: "Stable Unifi Controller releases." }
  - { tag: "mongoless", desc: "Stable Unifi Controller releases without mongodb included." }

# container parameters
param_container_name: "{{ project_name }}"
param_usage_include_vols: true
param_volumes:
  - { vol_path: "/config", vol_host_path: "/path/to/data", desc: "All Unifi data stored here" }

param_usage_include_ports: true
param_ports:
  - { external_port: "8443", internal_port: "8443", port_desc: "Unifi web admin port" }
  - { external_port: "3478", internal_port: "3478/udp", port_desc: "Unifi STUN port" }
  - { external_port: "10001", internal_port: "10001/udp", port_desc: "Required for AP discovery" }
  - { external_port: "8080", internal_port: "8080", port_desc: "Required for device communication" }

param_usage_include_env: true
param_env_vars:
  - { env_var: "TZ", env_value: "Europe/London", desc: "Specify a timezone to use (e.g. Europe/London) - [see list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)" }

# optional container parameters
opt_param_usage_include_env: true
opt_param_env_vars:
  - { env_var: "MEM_LIMIT", env_value: "1024", desc: "Optionally change the Java memory limit (in Megabytes). Set to `default` to reset to default" }
  - { env_var: "MEM_STARTUP", env_value: "1024", desc: "Optionally change the Java initial/minimum memory (in Megabytes). Set to `default` to reset to default" }

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: "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" }
  - { external_port: "5514", internal_port: "5514/udp", port_desc: "Remote syslog port" }

# application setup block
app_setup_block_enabled: true
app_setup_block: |
  ### From 2024-01-01 this image will be deprecated and it will no longer be updated. Please migrate to our [Unifi Network Application](https://github.com/linuxserver/docker-unifi-network-application) image instead

  See: [https://info.linuxserver.io/issues/2023-09-06-unifi-controller](https://info.linuxserver.io/issues/2023-09-06-unifi-controller) for more information.

  The webui is at https://ip:8443, setup with the first run wizard.

  For Unifi to adopt other devices, e.g. an Access Point, it is required to change the inform IP address. Because Unifi runs inside Docker by default it uses an IP address not accessible by other devices. To change this go to Settings > System > Advanced and set the Inform Host to a hostname or IP address accessible by your devices. Additionally the checkbox "Override" has to be checked, so that devices can connect to the controller during adoption (devices use the inform-endpoint during adoption).

  **Please note, Unifi change the location of this option every few releases so if it's not where it says, search for "Inform" or "Inform Host" in the settings.**

  In order to manually adopt a device take these steps:

  ```
  ssh ubnt@$AP-IP
  set-inform http://$address:8080/inform
  ```

  The default device password is `ubnt`. `$address` is the IP address of the host you are running this container on and `$AP-IP` is the Access Point IP address.

  When using a Security Gateway (router) it could be that network connected devices are unable to obtain an ip address. This can be fixed by setting "DHCP Gateway IP", under Settings > Networks > network_name, to a correct (and accessable) ip address.

# changelog
changelogs:
  - { date: "01.01.24:", desc: "Deprecate."}
  - { date: "05.09.23:", desc: "Add deprecation warning as per [https://info.linuxserver.io/issues/2023-09-06-unifi-controller](https://info.linuxserver.io/issues/2023-09-06-unifi-controller)."}
  - { date: "04.09.23:", desc: "Bump JRE to 17 to support v7.5."}
  - { date: "02.05.23:", desc: "Cleanup `apt-get install` during build to reduce image size."}
  - { date: "18.03.23:", desc: "Add mongoless branch."}
  - { date: "10.03.23:", desc: "Test writing to /run/unifi and symlink to /config/run if it fails."}
  - { date: "20.02.23:", desc: "Migrate to s6v3, install deb package on build, fix permissions."}
  - { date: "23.01.23:", desc: "Exclude `run` from `/config` volume."}
  - { date: "30.11.22:", desc: "Bump JRE to 11."}
  - { date: "01.06.22:", desc: "Deprecate armhf."}
  - { date: "23.12.21:", desc: "Move min/max memory config from run to system.properties."}
  - { date: "22.12.21:", desc: "Move deb package install to first init to avoid overlayfs performance issues."}
  - { date: "13.12.21:", desc: "Rebase 64 bit containers to Focal."}
  - { date: "11.12.21:", desc: "Add java opts to mitigate CVE-2021-44228."}
  - { date: "11.06.21:", desc: "Allow for changing Java initial mem via new optional environment variable."}
  - { date: "12.01.21:", desc: "Deprecate the `LTS` tag as Unifi no longer releases LTS stable builds. Existing users can switch to the `latest` tag. Direct upgrade from 5.6.42 (LTS) to 6.0.42 (latest) tested successfully."}
  - { date: "17.07.20:", desc: "Rebase 64 bit containers to Bionic and Mongo 3.6."}
  - { date: "16.06.20:", desc: "Add logrotate."}
  - { date: "02.06.20:", desc: "Updated port list & descriptions. Moved some ports to optional."}
  - { date: "14.11.19:", desc: "Changed url for deb package to match new Ubiquity domain." }
  - { date: "29.07.19:", desc: "Allow for changing Java mem limit via new optional environment variable." }
  - { date: "23.03.19:", desc: "Switching to new Base images, shift to arm32v7 tag." }
  - { date: "10.02.19:", desc: "Initial release of new unifi-controller image with new tags and pipeline logic" }