# UniFi Network [![Build Status](https://img.shields.io/github/actions/workflow/status/daemonless/unifi/build.yaml?style=flat-square&label=Build&color=green)](https://github.com/daemonless/unifi/actions) [![Last Commit](https://img.shields.io/github/last-commit/daemonless/unifi?style=flat-square&label=Last+Commit&color=blue)](https://github.com/daemonless/unifi/commits) [![OCI Pulls](https://img.shields.io/docker/pulls/daemonless/unifi?style=flat-square&label=OCI+Pulls&color=blue)](https://hub.docker.com/r/daemonless/unifi) [![mlock Required](https://img.shields.io/badge/mlock-required-orange?style=flat-square&logo=freebsd&logoColor=white)](https://daemonless.io/guides/ocijail-patch/) Ubiquiti UniFi Network Application for managing UniFi access points, switches, and gateways. | | | |---|---| | **Port** | 8443 | | **Registry** | `ghcr.io/daemonless/unifi` | | **Source** | [https://ui.com/](https://ui.com/) | | **Website** | [https://ui.com/](https://ui.com/) | ## Version Tags | Tag | Description | Best For | | :--- | :--- | :--- | | `latest` | **FreeBSD Latest**. Rolling package updates. | Staying current. | | `pkg` / `pkg-latest` | **FreeBSD Latest**. Rolling package updates. | Staying current. | ## Prerequisites Before deploying, ensure your host environment is ready. See the [Quick Start Guide](https://daemonless.io/guides/quick-start) for host setup instructions. ## Deployment ### Podman Compose ```yaml services: unifi: image: "ghcr.io/daemonless/unifi:latest" container_name: unifi environment: - PUID=1000 # User ID for the application process - PGID=1000 # Group ID for the application process - TZ=UTC # Timezone for the container volumes: - "/containers/unifi:/config" ports: - "8443:8443" - "8080:8080" - "8843:8843" - "8880:8880" - "6789:6789" - "3478:3478/udp" - "10001:10001/udp" annotations: org.freebsd.jail.allow.mlock: "true" # always (not unless-stopped) so FreeBSD's podman rc.d auto-starts it at boot restart: always ``` Save as `compose.yaml`, then run `podman-compose up -d`. ### AppJail Director **.env**: ``` # .env DIRECTOR_PROJECT=unifi PUID=1000 PGID=1000 TZ=UTC ``` **appjail-director.yml**: ```yaml # appjail-director.yml options: - virtualnet: ': default' - nat: services: unifi: name: unifi options: - container: 'args:--pull' - expose: '8443:8443 proto:tcp' - expose: '8080:8080 proto:tcp' - expose: '8843:8843 proto:tcp' - expose: '8880:8880 proto:tcp' - expose: '6789:6789 proto:tcp' - expose: '3478:3478 proto:udp' - expose: '10001:10001 proto:udp' - template: !ENV '${PWD}/template.conf' oci: user: root environment: - PUID: !ENV '${PUID}' - PGID: !ENV '${PGID}' - TZ: !ENV '${TZ}' volumes: - unifi: /config volumes: unifi: device: '/containers/unifi' ``` **Makejail**: ``` # Makejail ARG tag=latest OPTION container=boot OPTION overwrite=force OPTION from=ghcr.io/daemonless/unifi:${tag} ``` **template.conf**: ``` # template.conf exec.start: "/bin/sh /etc/rc" exec.stop: "/bin/sh /etc/rc.shutdown jail" mount.devfs persist allow.mlock ``` Save the files above, then run `appjail-director up`. > [!WARNING] > Exposing ports in AppJail means that your service can be reached from remote hosts. If that is not your intention, do not expose the ports and communicate with the service using the jail's IPv4 address or hostname assigned by the virtual network. > > To avoid exposing ports, just remove the `expose` option in your `appjail-director.yml` or from your command-line arguments. ### Bastille > [!WARNING] > Bastille's OCI support is **experimental**. It requires `buildah` and shares the host network stack (`inherit`). Mount volumes with `--volume HOST JAIL`; without it, image-declared volumes are stored under `${bastille_volumesdir}/${jail}`. ```yaml services: unifi: name: unifi image: "ghcr.io/daemonless/unifi:latest" network: - mode: host environment: - PUID=1000 - PGID=1000 - TZ=UTC volumes: - "/containers/unifi:/config" ``` Save as `bastille-compose.yml`, then run `bastille up`. ## Parameters ### Environment Variables | Variable | Default | Description | |----------|---------|-------------| | `PUID` | `1000` | User ID for the application process | | `PGID` | `1000` | Group ID for the application process | | `TZ` | `UTC` | Timezone for the container | ### Volumes | Path | Description | |------|-------------| | `/config` | Configuration and database directory | ### Ports | Port | Protocol | Description | |------|----------|-------------| | `8443` | TCP | Web UI (HTTPS) | | `8080` | TCP | Device inform | | `8843` | TCP | Guest portal HTTPS | | `8880` | TCP | Guest portal HTTP | | `6789` | TCP | Mobile throughput test | | `3478` | UDP | STUN (UDP) | | `10001` | UDP | Device discovery (UDP) | **Architectures:** amd64, aarch64 **User:** `bsd` (UID/GID via PUID/PGID, defaults to 1000:1000) **Base:** FreeBSD 15.1 --- Need help? Join our [Discord](https://discord.gg/Kb9tkhecZT) community.