UniFi Controller Installation auf einer Synology NAS
Bedingt durch den Umzug in ein Eigenheim inkl. Netzwerkverkabelung und neuer LAN/WLAN Infrastruktur habe ich meine Netzwerk-Komponenten vom Hersteller Ubiquiti (UniFi) bezogen. Damit die Komponenten miteinander interagieren benötigt man einen UniFi Netzwerk-Controller, entweder als kleine „Appliance“, als Cloud Lösung (https://unifi.ui.com) oder als Software. Ich habe mit für die letzte Lösung entschieden, um den Controller On-Premise zu halten.
Basis für meine Installation in diesem Beitrag ist der UniFi Controller 6.0.43 und Synology DSM 6.2.3.
Docker / Container Manager Installation
Falls noch nicht geschehen, muss zuerst Docker (ab DSM7.2: Container Manager) auf der Synology installiert werden. Dazu öffnet man in DSM das Package Center und sucht nach Docker zur Installation. Nachdem die Installation beendet ist, lässt sich Docker direkt über das Package Center öffnen oder über das DSM Menü.
UniFi Container Installation
In der Docker Konsole lade ich mir als erstes das UniFi Image herunter. Dazu wechsle ich in den Menüpunkt Registry und suche im Search Fenster nach „unifi“. Eines der Ergebnisse lautet jacobalberty/unifi. Dieses Image lade ich jetzt herunter.
Ist der Download abgeschlossen, wechsle ich in den Menüpunkt Image und starte einen neuen Container mit Launch.
Nun öffnet sich das Konfigurationsfenster für den neuen Container. Hier gebe ich dem Container einen Namen und limitiere die Ressourcen-Nutzung (je nach Modell kann hier natürlich etwas mehr RAM zugewiesen werden). Für die weitere Konfiguration klicke ich auf den Button Advanced Settings.
Als erstes sorge ich im Reiter Advanced Settings dafür, dass der Container nach einem Neustart der Synology auch automatisch wieder mitgestartet wird.
Im Reiter Volume verbinde ich jetzt einen Ordner und mounte ihn in den Container als /unifi. In diesem Ordner werden persistente Container-Daten gespeichert, damit auch nach einem Versionsupdate (siehe später) die Konfiguration des Controllers erhalten bleibt.
Im Reiter Network wähle ich die Option Use the same network as Docker Host aus. Möchte man die Ports des UniFi Controllers auf alternative Ports ändern (z.B. die Web GUI), wählt man in diesem Fenster statt der Checkbox das bridge Netzwerk aus und konfiguriert das Mapping der Local Ports und der Container Ports für die UniFi Ports, die weiter unten im Beitrag genannt sind.
Jetzt wechsle ich noch auf den letzten Reiter Environment und ändere die 2 Parameter BIND_PRIV und RUNAS_UID0 von true auf false.
Danach ist die Container Konfiguration beendet und kann mit Apply abgeschlossen werden. Den Container starte ich automatisch, wenn der Wizard beendet ist.
Ist der Container fertig hochgefahren, lässt sich das Webinterface des Controllers erreichen über die URL https://<Synology-IP>:8443
.
Sonstige Anpassungen
Ports
Falls auf der Disk Station die Firewall aktiv ist, müssen im aktiven Profil folgende Ports freigeschaltet werden:
- TCP/8443: Web GUI
- TCP/8080: Device/Controller Communication
- TCP/8880: HTTP Portal Redirection
- TCP/8843: HTTPS Portal Redirection
- TCP/6789: UniFi Mobile Speed Test
- UDP/3478: STUN (optional, für UniFi VoIP Telefone)
- UDP/10001: Device Discovery
- UDP/1900: Layer 2 Network Discovery
- UDP/5514: Remote Syslog Capture (optional)
Zudem dürfen die Ports natürlich nicht anderweitig bereits in Verwendung sein (z.B. durch andere Synology Packages oder andere Docker Container). Prädestiniert für Konflikte sind besonders die Ports 8080 und 8443, die werden als alternative HTTP/HTTPS Ports auch gerne durch andere Produkte verwendet. Sollte der Container nicht starten oder unerwartet sofort wieder stoppen, ist dies das häufigste Problem.
Geräte-Registrierung
Im Normalfall läuft der Controller nach der Einrichtung zwar problemlos, man wird aber feststellen, dass sich keine Geräte am Controller melden. Grund hierfür ist, dass sich die Geräte werksseitig bei der URL http://unifi:8080/inform melden, die NAS aber in den seltensten Fällen den Hostnamen UNIFI hat.
Die am häufigsten gefundene Methode im Internet ist es, sich auf das jeweilige Gerät per SSH zu verbinden und die Registrierungs-URL wie folgt zu ändern:
set-inform http://<Synology-IP/-Hostname>:8080/inform
Funktioniert das: Yepp!
Ist das charmant: Nope!
Geht das besser: Klaro!
Stellt euch vor, ihr habt eine etwas größere UniFi Umgebung mit 100 oder mehr Geräten. Will man sich wirklich auf unzähligen Geräten händisch einloggen, um die Registrierungs-URL anzupassen? Eher nicht. Wer eine entsprechend große Anzahl an Geräten hat, hat sicher auch eine weitergehende IT-Infrastruktur in Betrieb – inkl. einem eigenen internen DNS-Server.
Dieser kann entsprechend genutzt werden, um den Hostnamen UNIFI im Netzwerk verfügbar zu machen. Hierzu gibt es 2 Optionen:
- CNAME-Record UNIFI mit Alias auf den Hostname der Synology NAS
- A-/AAA-Record UNIFI mit der IPv4-/IPv6-Adresse der Synology NAS
Ist der Hostname UNIFI im Netzwerk verfügbar und auflösbar klappt’s auch mit dem automatischen Deployment von UniFi Geräten ohne manuelle Anpassungen.
Versionsupdate
Da der UniFi Controller jetzt ein Docker Image ist, lässt sich kein Update direkt in der UniFi Web UI durchführen. Stattdessen muss der Container selbst getauscht werden. Das funktioniert ähnlich wie die Neuinstallation und ist recht einfach:
- aktuelles (neues) Image für UniFi herunterladen
- UniFi Controller Konfiguration über die Web GUI sichern und herunterladen (zur Sicherheit)
- laufenden Container stoppen
- Container auswählen und mit Action -> Clear (seit DSM 7: Reset) alle Daten löschen (die Konfiguration bleibt erhalten durch den gemounteten Ordner!)
- Container wieder starten
Danach ist die UniFi Version des Containers aktualisiert.
Update 19.07.2021 – Geräteregistrierung
Nachdem einer meiner USW-Flex-Mini Switche den Geist aufgegeben, habe ich ein Austauschgerät bekommen und versucht es in meine Infrastruktur einzubinden. Was bisher mit dem DNS-Eintrag für den Controller geklappt hat, ging mit dem neuen Gerät ums Verrecken nicht. Habe alles ausprobiert, inkl. Firmware-Recovery – ohne Erfolg. Letzten Endes hat nur die Nutzung einer DHCP Adresszuweisung inkl. Option 43 funktioniert. Dazu habe ich in meinem DHCP Server (meine Fortigate Firewall) folgenden Eintrag für den DHCP-Scope gesetzt:
Code: 43 Typ: HEX Value: 0104C0A80001
Wie setzt sich der Wert für Option 43 zusammen:
01 -> Vendor Code (01 für Ubiquiti)
04 -> Länge des Payloads (Single IP, daher: 4)
C0A80001 -> HEX-Code für die IP UniFi Controller IP (in diesem Beispiel 192.168.0.1)
Update 11.10.2021 – Geräteregistrierung (Teil 2)
Eventuell konnte das Problem der nicht mehr funktionierenden Registrierung der Geräte per DNS gelöst werden. Ich hatte im Vorfeld des Problems den Container umgestellt von host-Network auf ein bridge-Network. Das o.g. Austauschgerät habe ich erst nach dieser Umstellung versucht zu registrieren. Ich konnte das noch nicht verifizieren, habe aber meinen Container wieder auf host-Network umgestellt. Aktuell warte ich (seit 3 Monaten!!!) auf ein anderes Austauschgerät; sobald das da ist, probiere ich aus, ob das jetzt wieder ohne die DHCP Option 43 funktioniert. Falls von euch Lesern jemand die Möglichkeit hat, das Verhalten zu testen, ist Feedback jederzeit willkommen.
Update 28.01.2022 – Geräteregistrierung (Teil 3)
Inzwischen konnte ich durch ein Austauschgerät selbst testen, ob das Problem mit der Geräteregistrierung per DNS an den Netzwerkeinstellungen des Containers liegt und es scheint so zu sein. Nachdem ich ja wieder auf host-Network zurückgestellt habe, konnte das Gerät auch ohne die DHCP-Option wieder den Controller finden und ich konnte es adopten.
Quellen:
https://help.ui.com/
https://registry.hub.docker.com/r/jacobalberty/unifi/
Klasse Anleitung auf einer betragten DS916+ (DSM 7.1.1-42962 Update 3) sofort zum Laufen bekommen.
Danke
Torsten
Gibt es eine Möglichkeit den Unifi Controller auf den DS118 zum laufen zu bocken, Docker wird mir nicht als App angeboten. Brauche unbedingt eine Alternative zum Cloud Key.
Hallo Sascha
Leider nein. Docker ist nur für Modelle mit Intel CPUs verfügbar. Die DS118 hat eine ARM CPU. Für Virtualisierungsfeatures wie Docker oder VMM musst halt leider ein paar Euro mehr in die Hand nehmen, als für eine inzwischen auch etwas ältere DS118.
Gruß
Andreas
Vielen Dank für die Anleitung.
Hallo Andreas,
danke für die tolle Anleitung.
Leider klappt es bei mir nicht, da der Port 8080 schon belegt ist.
Wie kann ich das Image trotzdem zum Laufen bekommen?
Falls ich den Port manuell ändere (z.B. 8686) wird das Image trotzdem immer beendet
(Port 8080 not available)
Über eine Lösung würde ich mich freuen.
Danke und LG
Hallo Meik
Das lässt sich i.d.R. auf mehrere Arten lösen.
Wenn du ein Bridge Network verwendest, dann mappe einfach einen anderen Port des externen Netzwerks auf Port 8080 des internen Container-Netzwerks.
Wenn du Host-Netzwerk verwendest, dann beende kurzzeitig den Container, der Port 8080 verwendet. Dann den Unifi Container einmal hochfahren (damit z.B. Config-Files, etc. angelegt werden) und anschließend wieder runterfahren. Jetzt kannst du über die system.properties Datei den HTTP Port ändern und danach die entsprechende Einstellung in der Container-Config selbst.
Gruß
Andreas
Hallo Andreas!
Danke für deine schnelle Antwort.
Das werde ich einmal versuchen.
LG
Hallo
Erstmals besten Dank für die tolle Anleitung. Der Unifi-Controller funktionierte bis heute einwandfrei.
Heute wurde ich aufgefordert folgendes Paket zu aktualisieren: Node.js v18
Wie es scheint, wurde der Web-Service aktualisiert und die Verlinkung zum Unfi-Image ging verloren.
Können Sie mir weiterhelfen?
Besten Dank.
Grüsse
Christian
DS918+
DSM 7.2.1-69057 Update 3
Hallo Christian
Sorry, ad-hoc fällt mir da keine zurverlässige Lösung ein. Ich würde den Container analog zu einem Update erst mal zurücksetzen und schauen, ob das hilft. Ansonsten, je nachdem für was du node.js brauchst, das Paket erst mal deinstallieren, aber vermutlich hast du es ja nicht aus Jux drauf.
Gruß
Andreas
Hallo Andreas
Besten Dank, mit zurücksetzen funktioniert der Container wieder, und ich habe wieder zugriff.
Grüsse
Christian