Unifi Controller#

Unifi Controller The Unifi-controller Controller software is a powerful, enterprise wireless software engine ideal for high-density client deployments requiring low latency and high uptime performance.

amd64
arm64
armv7

Information#

Docker Image: !!! LINK TO DOCKER IMAGE/ DOCKER HUB !!!
Current Image Version: latest

SETUP#

Enabling unificontroller#

Command:#

vlab set unificontroller.enable True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

unificontroller
enable: True

Finalising changes:#

run: vlab update_one service=unificontroller

FIRST RUN#

!!! DEVELOPERS: make sure that you include any information that the user requires to get started, below. !!!
!!! Below are some examples with headings, and with some example instructions !!!

ADMINISTRATOR SETUP#

Navigate to https://False/admin

Create an account with your desired username; as this is the first user, unificontroller makes this account the administrator.

SMTP/ MAIL#

  1. run vlab decrypt to decrypt the vault.yml file
  2. make some changes

SMTP Settings#

smtp:
host:
port:
user:
pass:
from_email:
from_name:
  1. run vlab update_one service=unificontroller to complete the changes

ACCESS#

unificontroller (HTTPS) link: https://unificontroller.vivumlab.xyz/ unificontroller (HTTP) link: http://unificontroller.vivumlab.xyz/

OPTIONS#

HTTPS_ONLY#

Default: False
Options: True/False

Command:#

vlab set unificontroller.https_only True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

unificontroller
https_only: True
Finalising changes:#

run: vlab update_one service=unificontroller

AUTH#

Default: False
Options: True/False

Command:#

vlab set unificontroller.auth True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

unificontroller
auth: True
Finalising changes:#

run: vlab update_one service=unificontroller

DOMAIN#

Default: False
NOTE: include the sitename and top level domain suffix. eg. name.com, site.net

Command:#

vlab set unificontroller.domain unificontroller.com

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

unificontroller
domain: unificontroller.com
Finalising changes:#

run: vlab update_one service=unificontroller

SUBDOMAIN#

Default: unificontroller
NOTE: Periods/ delimiters are not required. eg. 'media' will set the full URL as 'media.vivumlab.xyz'

Command:#

vlab set unificontroller.subdomain media

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

unificontroller
subdomain: media
Finalising changes:#

run: vlab update_one service=unificontroller

VERSION#

Default: latest
NOTE: Ensure that the version exists

Command:#

vlab set unificontroller.version 2.7

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

unificontroller
version: 2.7
Finalising changes:#

run: vlab update_one service=unificontroller

Need more help?#

Further information regarding services can be found.
General Information can be found in the documentation.
Additional assistance can be found on our Contact Us page.