Unifi Controller


Get Started with Apps!
Keywords: controller, unifi, network
Train: Community
Home Page: https://github.com/goofball222/unifi
Added: 2024-08-01
Last Updated: 2025-04-23
Unifi Controller is a network management controller for Unifi Equipment.
Run as Context- Unifi Controller runs as a non-root user.
Group: 999 / unifi
User: 999 / unifi
App Metadata (Raw File)
{
"1.3.15": {
"healthy": true,
"supported": true,
"healthy_error": null,
"location": "/__w/apps/apps/trains/community/unifi-controller/1.3.15",
"last_update": "2025-04-23 17:40:39",
"required_features": [],
"human_version": "9.0.114_1.3.15",
"version": "1.3.15",
"app_metadata": {
"app_version": "9.0.114",
"capabilities": [],
"categories": [
"networking"
],
"changelog_url": "https://github.com/goofball222/unifi/releases",
"date_added": "2024-08-01",
"description": "Unifi Controller is a network management controller for Unifi Equipment.",
"home": "https://github.com/goofball222/unifi",
"host_mounts": [],
"icon": "https://media.sys.truenas.net/apps/unifi-controller/icons/icon.png",
"keywords": [
"controller",
"unifi",
"network"
],
"lib_version": "2.1.16",
"lib_version_hash": "dac15686f882b9ce65b8549a3d5c0ed7bafe2df7a9028880d1a99b0ff4af1eff",
"maintainers": [
{
"email": "dev@ixsystems.com",
"name": "truenas",
"url": "https://www.truenas.com/"
}
],
"name": "unifi-controller",
"run_as_context": [
{
"description": "Unifi Controller runs as a non-root user.",
"gid": 999,
"group_name": "unifi",
"uid": 999,
"user_name": "unifi"
}
],
"screenshots": [],
"sources": [
"https://github.com/goofball222/unifi",
"https://hub.docker.com/r/goofball222/unifi"
],
"title": "Unifi Controller",
"train": "community",
"version": "1.3.15"
},
"schema": {
"groups": [
{
"name": "Unifi Controller Configuration",
"description": "Configure Unifi Controller"
},
{
"name": "Network Configuration",
"description": "Configure Network for Unifi Controller"
},
{
"name": "Storage Configuration",
"description": "Configure Storage for Unifi Controller"
},
{
"name": "Labels Configuration",
"description": "Configure Labels for Unifi Controller"
},
{
"name": "Resources Configuration",
"description": "Configure Resources for Unifi Controller"
}
],
"questions": [
{
"variable": "TZ",
"group": "Unifi Controller Configuration",
"label": "Timezone",
"schema": {
"type": "string",
"default": "Etc/UTC",
"required": true,
"$ref": [
"definitions/timezone"
]
}
},
{
"variable": "unifi",
"label": "",
"group": "Unifi Controller Configuration",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "additional_envs",
"label": "Additional Environment Variables",
"description": "Configure additional environment variables for Unifi Controller.",
"schema": {
"type": "list",
"default": [],
"items": [
{
"variable": "env",
"label": "Environment Variable",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "name",
"label": "Name",
"schema": {
"type": "string",
"required": true
}
},
{
"variable": "value",
"label": "Value",
"schema": {
"type": "string",
"required": true
}
}
]
}
}
]
}
}
]
}
},
{
"variable": "network",
"label": "",
"group": "Network Configuration",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "web_https_port",
"label": "WebUI / API Port",
"description": "The port for Unifi Controller WebUI / API",
"schema": {
"type": "int",
"default": 30072,
"required": true,
"$ref": [
"definitions/port"
]
}
},
{
"variable": "enable_web_http",
"label": "Enable UAP/USW/USG to Inform Controller Port",
"description": "Enable Web HTTP",
"schema": {
"type": "boolean",
"default": true
}
},
{
"variable": "web_http_port",
"label": "UAP/USW/USG to Inform Controller Port",
"description": "The HTTP port for Unifi Controller WebUI",
"schema": {
"type": "int",
"default": 30073,
"show_if": [
[
"enable_web_http",
"=",
true
]
],
"required": true,
"$ref": [
"definitions/port"
]
}
},
{
"variable": "portal_https_port",
"label": "Portal HTTPS Port",
"description": "The HTTPS port for Unifi Controller Portal",
"schema": {
"type": "int",
"default": 30074,
"required": true,
"$ref": [
"definitions/port"
]
}
},
{
"variable": "enable_portal_http",
"label": "Enable Portal HTTP",
"description": "Enable Portal HTTP",
"schema": {
"type": "boolean",
"default": true
}
},
{
"variable": "portal_http_port",
"label": "Portal HTTP Port",
"description": "The HTTP port for Unifi Controller Portal",
"schema": {
"type": "int",
"default": 30075,
"show_if": [
[
"enable_portal_http",
"=",
true
]
],
"required": true,
"$ref": [
"definitions/port"
]
}
},
{
"variable": "enable_throughput",
"label": "Enable Throughput Measurements Port",
"schema": {
"type": "boolean",
"default": false
}
},
{
"variable": "throughput_port",
"label": "Throughput Measurements Port",
"description": "The port for Unifi Controller Throughput Measurements",
"schema": {
"type": "int",
"default": 30023,
"show_if": [
[
"enable_throughput",
"=",
true
]
],
"required": true,
"$ref": [
"definitions/port"
]
}
},
{
"variable": "discovery_port",
"label": "Discovery Port",
"description": "The port for Unifi Controller Discovery",
"schema": {
"type": "dict",
"show_if": [
[
"host_network",
"=",
false
]
],
"attrs": [
{
"variable": "bind_mode",
"label": "Port Bind Mode",
"description": "The port bind mode.</br>\n- Publish: The port will be published on the host for external access.</br>\n- Expose: The port will be exposed for inter-container communication.</br>\n- None: The port will not be exposed or published.</br>\nNote: If the Dockerfile defines an EXPOSE directive,\nthe port will still be exposed for inter-container communication regardless of this setting.\n",
"schema": {
"type": "string",
"default": "",
"enum": [
{
"value": "published",
"description": "Publish port on the host for external access"
},
{
"value": "exposed",
"description": "Expose port for inter-container communication"
},
{
"value": "",
"description": "None"
}
]
}
},
{
"variable": "port_number",
"label": "Port Number",
"schema": {
"type": "int",
"default": 10001,
"show_if": [
[
"bind_mode",
"=",
"published"
]
],
"required": true,
"$ref": [
"definitions/port"
]
}
},
{
"variable": "host_ips",
"label": "Host IPs",
"description": "IPs on the host to bind this port",
"schema": {
"type": "list",
"show_if": [
[
"bind_mode",
"=",
"published"
]
],
"default": [],
"items": [
{
"variable": "host_ip",
"label": "Host IP",
"schema": {
"type": "string",
"required": true,
"$ref": [
"definitions/node_bind_ip"
]
}
}
]
}
}
]
}
},
{
"variable": "certificate_id",
"label": "Certificate ID",
"description": "The ID of the certificate to use for Unifi Controller",
"schema": {
"type": "int",
"null": true,
"$ref": [
"definitions/certificate"
]
}
},
{
"variable": "host_network",
"label": "Host Network",
"description": "Bind to the host network. It's recommended to keep this disabled.\n",
"schema": {
"type": "boolean",
"default": false
}
}
]
}
},
{
"variable": "storage",
"label": "",
"group": "Storage Configuration",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "data",
"label": "Unifi Controller Data Storage",
"description": "The path to store Unifi Controller Data.",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "type",
"label": "Type",
"description": "ixVolume: Is dataset created automatically by the system.</br>\nHost Path: Is a path that already exists on the system.\n",
"schema": {
"type": "string",
"required": true,
"immutable": true,
"default": "ix_volume",
"enum": [
{
"value": "host_path",
"description": "Host Path (Path that already exists on the system)"
},
{
"value": "ix_volume",
"description": "ixVolume (Dataset created automatically by the system)"
}
]
}
},
{
"variable": "ix_volume_config",
"label": "ixVolume Configuration",
"description": "The configuration for the ixVolume dataset.",
"schema": {
"type": "dict",
"show_if": [
[
"type",
"=",
"ix_volume"
]
],
"$ref": [
"normalize/ix_volume"
],
"attrs": [
{
"variable": "acl_enable",
"label": "Enable ACL",
"description": "Enable ACL for the storage.",
"schema": {
"type": "boolean",
"default": false
}
},
{
"variable": "dataset_name",
"label": "Dataset Name",
"description": "The name of the dataset to use for storage.",
"schema": {
"type": "string",
"required": true,
"immutable": true,
"hidden": true,
"default": "data"
}
},
{
"variable": "acl_entries",
"label": "ACL Configuration",
"schema": {
"type": "dict",
"show_if": [
[
"acl_enable",
"=",
true
]
],
"attrs": []
}
}
]
}
},
{
"variable": "host_path_config",
"label": "Host Path Configuration",
"schema": {
"type": "dict",
"show_if": [
[
"type",
"=",
"host_path"
]
],
"attrs": [
{
"variable": "acl_enable",
"label": "Enable ACL",
"description": "Enable ACL for the storage.",
"schema": {
"type": "boolean",
"default": false
}
},
{
"variable": "acl",
"label": "ACL Configuration",
"schema": {
"type": "dict",
"show_if": [
[
"acl_enable",
"=",
true
]
],
"attrs": [],
"$ref": [
"normalize/acl"
]
}
},
{
"variable": "path",
"label": "Host Path",
"description": "The host path to use for storage.",
"schema": {
"type": "hostpath",
"show_if": [
[
"acl_enable",
"=",
false
]
],
"required": true
}
}
]
}
}
]
}
},
{
"variable": "additional_storage",
"label": "Additional Storage",
"description": "Additional storage for Unifi Controller.",
"schema": {
"type": "list",
"default": [],
"items": [
{
"variable": "storageEntry",
"label": "Storage Entry",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "type",
"label": "Type",
"description": "ixVolume: Is dataset created automatically by the system.</br>\nHost Path: Is a path that already exists on the system.</br>\nSMB Share: Is a SMB share that is mounted to as a volume.\n",
"schema": {
"type": "string",
"required": true,
"default": "ix_volume",
"immutable": true,
"enum": [
{
"value": "host_path",
"description": "Host Path (Path that already exists on the system)"
},
{
"value": "ix_volume",
"description": "ixVolume (Dataset created automatically by the system)"
},
{
"value": "cifs",
"description": "SMB/CIFS Share (Mounts a volume to a SMB share)"
}
]
}
},
{
"variable": "read_only",
"label": "Read Only",
"description": "Mount the volume as read only.",
"schema": {
"type": "boolean",
"default": false
}
},
{
"variable": "mount_path",
"label": "Mount Path",
"description": "The path inside the container to mount the storage.",
"schema": {
"type": "path",
"required": true
}
},
{
"variable": "host_path_config",
"label": "Host Path Configuration",
"schema": {
"type": "dict",
"show_if": [
[
"type",
"=",
"host_path"
]
],
"attrs": [
{
"variable": "acl_enable",
"label": "Enable ACL",
"description": "Enable ACL for the storage.",
"schema": {
"type": "boolean",
"default": false
}
},
{
"variable": "acl",
"label": "ACL Configuration",
"schema": {
"type": "dict",
"show_if": [
[
"acl_enable",
"=",
true
]
],
"attrs": [],
"$ref": [
"normalize/acl"
]
}
},
{
"variable": "path",
"label": "Host Path",
"description": "The host path to use for storage.",
"schema": {
"type": "hostpath",
"show_if": [
[
"acl_enable",
"=",
false
]
],
"required": true
}
}
]
}
},
{
"variable": "ix_volume_config",
"label": "ixVolume Configuration",
"description": "The configuration for the ixVolume dataset.",
"schema": {
"type": "dict",
"show_if": [
[
"type",
"=",
"ix_volume"
]
],
"$ref": [
"normalize/ix_volume"
],
"attrs": [
{
"variable": "acl_enable",
"label": "Enable ACL",
"description": "Enable ACL for the storage.",
"schema": {
"type": "boolean",
"default": false
}
},
{
"variable": "dataset_name",
"label": "Dataset Name",
"description": "The name of the dataset to use for storage.",
"schema": {
"type": "string",
"required": true,
"immutable": true,
"default": "storage_entry"
}
},
{
"variable": "acl_entries",
"label": "ACL Configuration",
"schema": {
"type": "dict",
"show_if": [
[
"acl_enable",
"=",
true
]
],
"attrs": [],
"$ref": [
"normalize/acl"
]
}
}
]
}
},
{
"variable": "cifs_config",
"label": "SMB Configuration",
"description": "The configuration for the SMB dataset.",
"schema": {
"type": "dict",
"show_if": [
[
"type",
"=",
"cifs"
]
],
"attrs": [
{
"variable": "server",
"label": "Server",
"description": "The server to mount the SMB share.",
"schema": {
"type": "string",
"required": true
}
},
{
"variable": "path",
"label": "Path",
"description": "The path to mount the SMB share.",
"schema": {
"type": "string",
"required": true
}
},
{
"variable": "username",
"label": "Username",
"description": "The username to use for the SMB share.",
"schema": {
"type": "string",
"required": true
}
},
{
"variable": "password",
"label": "Password",
"description": "The password to use for the SMB share.",
"schema": {
"type": "string",
"required": true,
"private": true
}
},
{
"variable": "domain",
"label": "Domain",
"description": "The domain to use for the SMB share.",
"schema": {
"type": "string"
}
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"variable": "labels",
"label": "",
"group": "Labels Configuration",
"schema": {
"type": "list",
"default": [],
"items": [
{
"variable": "label",
"label": "Label",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "key",
"label": "Key",
"schema": {
"type": "string",
"required": true
}
},
{
"variable": "value",
"label": "Value",
"schema": {
"type": "string",
"required": true
}
},
{
"variable": "containers",
"label": "Containers",
"description": "Containers where the label should be applied",
"schema": {
"type": "list",
"items": [
{
"variable": "container",
"label": "Container",
"schema": {
"type": "string",
"required": true,
"enum": [
{
"value": "unifi",
"description": "unifi"
}
]
}
}
]
}
}
]
}
}
]
}
},
{
"variable": "resources",
"label": "",
"group": "Resources Configuration",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "limits",
"label": "Limits",
"schema": {
"type": "dict",
"attrs": [
{
"variable": "cpus",
"label": "CPUs",
"description": "CPUs limit for Unifi Controller.",
"schema": {
"type": "int",
"default": 2,
"required": true
}
},
{
"variable": "memory",
"label": "Memory (in MB)",
"description": "Memory limit for Unifi Controller.",
"schema": {
"type": "int",
"default": 4096,
"required": true
}
}
]
}
}
]
}
}
]
},
"readme": "<h1>Unifi Controller</h1> <p><a href=\"https://github.com/goofball222/unifi\">Unifi Controller</a> is a network management controller for Unifi Equipment.</p>",
"changelog": null,
"chart_metadata": {
"app_version": "9.0.114",
"capabilities": [],
"categories": [
"networking"
],
"changelog_url": "https://github.com/goofball222/unifi/releases",
"date_added": "2024-08-01",
"description": "Unifi Controller is a network management controller for Unifi Equipment.",
"home": "https://github.com/goofball222/unifi",
"host_mounts": [],
"icon": "https://media.sys.truenas.net/apps/unifi-controller/icons/icon.png",
"keywords": [
"controller",
"unifi",
"network"
],
"lib_version": "2.1.16",
"lib_version_hash": "dac15686f882b9ce65b8549a3d5c0ed7bafe2df7a9028880d1a99b0ff4af1eff",
"maintainers": [
{
"email": "dev@ixsystems.com",
"name": "truenas",
"url": "https://www.truenas.com/"
}
],
"name": "unifi-controller",
"run_as_context": [
{
"description": "Unifi Controller runs as a non-root user.",
"gid": 999,
"group_name": "unifi",
"uid": 999,
"user_name": "unifi"
}
],
"screenshots": [],
"sources": [
"https://github.com/goofball222/unifi",
"https://hub.docker.com/r/goofball222/unifi"
],
"title": "Unifi Controller",
"train": "community",
"version": "1.3.15"
}
}
}
Support, maintenance, and documentation for applications within the Community catalog is handled by the TrueNAS community. The TrueNAS Applications Portal hosts but does not validate or maintain any linked resources associated with this app.
There currently aren’t any resources available for this application!
Please help the TrueNAS community create content or discuss this application in the TrueNAS Community forum.