mesh-catalog/modules/unifi/module.json

{
  "module": "unifi",
  "version": "1",
  "capabilities": [
    "container-runtime"
  ],
  "listens": [
    {
      "name": "web",
      "port": 8443,
      "protocol": "tcp",
      "from": "mesh",
      "why": "the controller web UI and API, over its own self-signed tls; named through the proxy as an https route"
    },
    {
      "name": "inform",
      "port": 8080,
      "protocol": "tcp",
      "from": "mesh",
      "why": "device inform, how APs and switches check in and are adopted; the controller tells devices this number, so the machine must publish it on the same one"
    },
    {
      "name": "stun",
      "port": 3478,
      "protocol": "udp",
      "from": "mesh",
      "why": "STUN for managed devices; the controller tells devices this number, so the machine must publish it on the same one"
    },
    {
      "name": "discovery",
      "port": 10001,
      "protocol": "udp",
      "from": "mesh",
      "why": "device discovery broadcasts from unadopted devices and the UniFi apps"
    },
    {
      "name": "discovery-l2",
      "port": 1900,
      "protocol": "udp",
      "from": "mesh",
      "why": "make-controller-discoverable-on-L2 (SSDP); the software listens on 1900, which machines commonly have taken by another SSDP speaker"
    },
    {
      "name": "portal-tls",
      "port": 8843,
      "protocol": "tcp",
      "from": "mesh",
      "why": "the guest captive portal over https"
    },
    {
      "name": "portal",
      "port": 8880,
      "protocol": "tcp",
      "from": "mesh",
      "why": "the guest captive portal over http"
    },
    {
      "name": "speedtest",
      "port": 6789,
      "protocol": "tcp",
      "from": "mesh",
      "why": "mobile-app speed-test throughput measurement"
    },
    {
      "name": "syslog",
      "port": 5514,
      "protocol": "udp",
      "from": "mesh",
      "why": "remote syslog from managed devices"
    }
  ],
  "data": {
    "own": [
      {
        "id": "data",
        "path": "${dir:data}",
        "class": "valuable",
        "why": "the network's configuration and every adopted device"
      }
    ]
  },
  "config": {
    "site": {
      "type": "string",
      "description": "The UniFi site the module's tools act on, by its id; the file's default is default.",
      "trusted": true,
      "default": "default"
    },
    "url": {
      "type": "string",
      "description": "The address the module's tools reach the UniFi controller at, as a URL; unset, the code falls back to its environment, else this machine's controller on its HTTPS port.",
      "trusted": true,
      "default": ""
    },
    "username": {
      "type": "string",
      "description": "The UniFi account the module's tools sign in as with the vault's password; unset, the code falls back to its environment.",
      "trusted": true,
      "default": ""
    }
  },
  "resources": [
    {
      "id": "mesh-state",
      "type": "directory",
      "mode": "0700",
      "place": "mesh",
      "unknown": "program"
    },
    {
      "id": "state",
      "type": "directory",
      "mode": "0700",
      "place": ".",
      "unknown": "program"
    },
    {
      "id": "data",
      "type": "directory",
      "mode": "0700",
      "owner": "1000:1000",
      "unknown": "program"
    },
    {
      "id": "server",
      "type": "container",
      "name": "unifi-controller",
      "image": "lscr.io/linuxserver/unifi-controller@sha256:0ae315a3a45635e443899e30e86bd507c2c48922cb27f4bc7241777885f4650e",
      "ports": [
        "8443",
        "8080",
        "3478/udp",
        "10001/udp",
        "1900/udp",
        "8843",
        "8880",
        "6789",
        "5514/udp"
      ],
      "env": {
        "PUID": "1000",
        "PGID": "1000",
        "TZ": "Etc/UTC",
        "MEM_LIMIT": "1024",
        "MEM_STARTUP": "1024"
      },
      "volumes": [
        "${dir:data}:/config"
      ]
    },
    {
      "id": "runtime-config",
      "type": "file",
      "path": "${dir:mesh-state}/config.json",
      "mode": "0600",
      "template": "files/config.json",
      "merge": "json",
      "takes-config": ["site", "url", "username"],
      "protected": ["password"]
    }
  ],
  "requires": [
    "route"
  ],
  "contributes": {
    "route": {
      "label": "unifi",
      "endpoint": "web",
      "scheme": "https",
      "insecure": true
    }
  },
  "binds": {
    "route": "${dir:state}/route.json"
  },
  "own-secrets": {
    "controller": "${dir:mesh-state}/controller"
  },
  "build": {
    "artifacts": [
      {
        "name": "tools",
        "kind": "bundle",
        "language": "typescript",
        "entrypoints": [
          "tools/index.js"
        ],
        "loads": [
          "tools/index.js"
        ],
        "env": {
          "MESH_UNIFI_URL": "https://127.0.0.1:${port:8443}",
          "MESH_UNIFI_CONFIG_FILE": "${dir:mesh-state}/config.json"
        }
      },
      {
        "name": "files",
        "kind": "archive",
        "from": "files"
      }
    ]
  }
}