Getting Started

Getting Started with Unifi OS Server

System Requirements

UniFi OS Server has these minimum hardware requirements:

• x86_64 or ARM64 CPU
• At least 2GB RAM
• 20GB free disk space
• Docker Compose >v2
• Linux Kernel >3.16

These requirements tend to be larger than the earlier Network Controller requirements, so you may need to upgrade your hardware to run Unifi OS Server.

That said, there is a report of successful installation on a Raspberry Pi 4 running with reasonable speed for two dozen devices. Note: Pulling and starting the container on the Pi are slow, taking 7-8 minutes for each. But once it's running, the response time of the container is absolutely fine.

Installation

Docker Compose

Clone the repo from https://github.com/lemker/unifi-os-server.git

Update the docker-compose.yaml template with these changes:

• Change /path/to/unifi-os-server/* in the template to match your host's persistent data paths
• Change the UOS_SYSTEM_IP to your system's IP address.

Then enter docker compose up -d. After starting the container, the UniFi OS Server console is available at https://<IP>:11443.

Note: If you are changing the IP address of your server, read the Migration-Guide especially the section about changing the inform address.

Kubernetes

See kubernetes/.

Note that currently Kubernetes deployments require privileged: true in order to function. See #51.

Updating

Update UniFi OS Server

To update UniFi OS Server, stop the container (docker compose down), use docker pull ghcr.io/lemker/unifi-os-server:latest or update the pinned tag in your Docker Compose file, then restart (docker compose up -d).

You may wish to set up alerts for when new releases are published on GitHub or use a GitOps method like Renovate to keep your container updated.

Update Applications

To update UniFi applications like Network, InnerSpace, etc. use the UniFi OS Server GUI: navigate to Settings > Control Plane > Updates