Komm-Intern

<h1>UniFi Controller Installation auf einer Synology NAS</h1>
<div class="level1">

<p>
von <a href="https://blog.andreas-schreiner.de/author/andreas-schreiner/" class="urlextern" title="https://blog.andreas-schreiner.de/author/andreas-schreiner/" rel="ugc nofollow">Andreas Schreiner</a> · Veröffentlicht 13. Januar 2021· Aktualisiert 13. Juli 2023
</p>

<p>
<em>mit Anmerkungen von Gunter</em>
</p>

<p>
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 (<a href="https://unifi.ui.com" class="urlextern" title="https://unifi.ui.com" rel="ugc nofollow">https://unifi.ui.com</a>) oder als Software. Ich habe mit für die letzte Lösung entschieden, um den Controller On-Premise zu halten.
</p>

<p>
Basis für meine Installation in diesem Beitrag ist der UniFi Controller 6.0.43 und Synology DSM 6.2.3.
</p>

</div>

<h2>Docker / Container Manager Installation</h2>
<div class="level2">

<p>
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ü.
</p>

</div>

<h5>UniFi Container Installation</h5>
<div class="level5">

<p>
In der Docker Konsole lade ich mir als erstes das UniFi Image herunter. Dazu wechsle ich in den Menüpunkt <em>Registry</em> und suche im Search Fenster nach „unifi“. Eines der Ergebnisse lautet <em>jacobalberty/unifi</em>. Dieses Image lade ich jetzt herunter.
</p>

<p>
Ist der Download abgeschlossen, wechsle ich in den Menüpunkt <em>Image</em> und starte einen neuen Container mit <em>Launch</em>.
</p>

<p>
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 <em>Advanced Settings</em>.
</p>

<p>
Als erstes sorge ich im Reiter <em>Advanced Settings</em> dafür, dass der Container nach einem Neustart der Synology auch automatisch wieder mitgestartet wird.
</p>

<p>
Im Reiter <em>Volume</em> verbinde ich jetzt einen Ordner und mounte ihn in den Container als <em>/unifi</em>. In diesem Ordner werden persistente Container-Daten gespeichert, damit auch nach einem Versionsupdate (siehe später) die Konfiguration des Controllers erhalten bleibt.
</p>

<p>
Im Reiter <em>Network</em> wähle ich die Option <em>Use the same network as Docker Host</em> 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.<br/>

<b>Achtung: das geht nicht! Netzwerk muss auf Host stehen damit die Geräte den Server finden.<br/>

Die Ports können in den Umgebungsvariablen der Containers angepasst werden. Das ist auch nötig damit der Container selbst weiß welche Ports er den Geräten für eine Weiterleitung von http Port 8080 mitteilen muss. Wenn das falsch gemacht wurde siehe unten Wechsel der Netzwerkanbindung des Containers</b> <br/>

<p>
Jetzt wechsle ich noch auf den letzten Reiter <em>Environment</em> und ändere die 2 Parameter <em>BIND_PRIV</em> und <em>RUNAS_UID0</em> von <em>true</em> auf <em>false</em>.
</p>

<p>
Danach ist die Container Konfiguration beendet und kann mit <em>Apply</em> abgeschlossen werden. Den Container starte ich automatisch, wenn der Wizard beendet ist.
</p>

<p>
Ist der Container fertig hochgefahren, lässt sich das Webinterface des Controllers erreichen über die URL <code><a href="https:////&lt;Synology-IP" class="urlextern" title="https:////&lt;Synology-IP" rel="ugc nofollow">https:////&lt;Synology-IP</a>><em>:8443<code>.</code> </em></code>
</p>

</div>

<h1>Sonstige Anpassungen</h1>
<div class="level1">

<p>
<b>Ports</b>
</p>

<p>
Falls auf der Disk Station die Firewall aktiv ist, müssen im aktiven Profil folgende Ports freigeschaltet werden:
</p>
<ul>
<li class="level1"> TCP/8443: Web GUI</li>
<li class="level1"> TCP/8080: Device/Controller Communication</li>
<li class="level1"> TCP/8880: HTTP Portal Redirection</li>
<li class="level1"> TCP/8843: HTTPS Portal Redirection</li>
<li class="level1"> TCP/6789: UniFi Mobile Speed Test</li>
<li class="level1"> UDP/3478: STUN (optional, für UniFi VoIP Telefone)</li>
<li class="level1"> UDP/10001: Device Discovery</li>
<li class="level1"> UDP/1900: Layer 2 Network Discovery</li>
<li class="level1"> UDP/5514: Remote Syslog Capture (optional)</li>
</ul>

<p>
Zudem dürfen die Ports natürlich nicht anderweitig bereits in Verwendung sein (z.B. durch andere Synology Packages oder andere Docker Container).
</p>

<p>
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.
</p>

<p>
Sollte der Container nicht starten oder unerwartet sofort wieder stoppen, ist dies das häufigste Problem.
</p>

<p>
Da UniFi Controller nicht von den Geräten gefunden werden kann wenn als Netzwerktyp Bridge ausgewählt wird lässt sich auch keine Veränderung der Portzuordnung in Docker erreichen. <br/>
Die Ports können aber in den Umgebungsvariablen des Containers angepasst werden wenn nötig:
</p>

<p>
Aus der Doku von Jacob Alberty:
</p>

</div>

<h4>Environment Variables:</h4>
<div class="level4">

<p>
You can pass in environment variables using the <code>-e</code>  option when you invoke <code>docker run…</code>  See the <code>TZ</code>  in the example above. Other environment variables:
</p>
<ul>
<li class="level1"> <code>UNIFI_HTTP_PORT</code>  This is the HTTP port used by the Web interface. Browsers will be redirected to the <code>UNIFI_HTTPS_PORT</code>. <b>Default: 8080</b></li>
<li class="level1"> <code>UNIFI_HTTPS_PORT</code>  This is the HTTPS port used by the Web interface. <b>Default: 8443</b></li>
<li class="level1"> <code>PORTAL_HTTP_PORT</code>  Port used for HTTP portal redirection. <b>Default: 80</b></li>
<li class="level1"> <code>PORTAL_HTTPS_PORT</code>  Port used for HTTPS portal redirection. <b>Default: 8843</b></li>
</ul>

<p>
Es ist aber wichtig dass Port 8080 bleibt, da die Geräte sich automatisch dort melden!
</p>

<p>
Aus dem Grunde habe ich alle Ports gleich gelassen. <br/>
Es gab damit aber einen Port Konflikt mit Synology Contacts / CardDAV mit dem es möglich ist Kontakte z.B. mit Handys im Kommunenetz zu synchronisieren. <br/>
Daher habe ich CardDAV auf Port 8444 geändert, das muss dann natürlich auch auf allen Geräten zum Sync so angepasst werden. <br/>
(Mache aktuell nur ich (Gunter) um die Daten von dem Lineage OS Handy zu sichern)
</p>

<p>
Nach Änderung des Ports für CardDAV muss entweder die Diskstation oder zumindest Contacts, Calendar und ggf. Webstation neu gestartet werden.
</p>

</div>

<h2>Geräte-Registrierung</h2>
<div class="level2">

<p>
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 <em> <a href="http://unifi:8080/inform//" class="urlextern" title="http://unifi:8080/inform//" rel="ugc nofollow">http://unifi:8080/inform//</a> melden, die NAS aber in den seltensten Fällen den Hostnamen </em>UNIFI<em> hat. </em>
</p>

<p>
<em>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: &lt;wp-block-preformatted> set-inform <a href="http:////&lt;Synology-IP/-Hostname" class="urlextern" title="http:////&lt;Synology-IP/-Hostname" rel="ugc nofollow">http:////&lt;Synology-IP/-Hostname</a>></em>:8080/inform &lt;/wp-block-preformatted>
</p>

<p>
Funktioniert das: Yepp!<br/>

Ist das charmant: Nope!<br/>

Geht das besser: Klaro!
</p>

<p>
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.
</p>

<p>
Hierzu gibt es 2 Optionen:
</p>

<p>
* CNAME-Record <em>UNIFI</em> mit Alias auf den Hostname der Synology NAS
</p>

<p>
* A-/AAA-Record <em>UNIFI</em> mit der IPv4-/IPv6-Adresse der Synology NAS Ist der Hostname <em>UNIFI</em> im Netzwerk verfügbar und auflösbar klappt’s auch mit dem automatischen Deployment von UniFi Geräten ohne manuelle Anpassungen.
</p>

<p>
Bei uns habe ich ein A Record angelegt.
</p>

</div>

<h2>Reset der Geräte damit sie in einem neuen Netzwerk eingesetzt werden können</h2>
<div class="level2">

<p>
Gebrauchte Geräte müssen zurückgesetzt werden damit sie sich im Unifi Controller finden und adoptieren lassen.
</p>

</div>

<h2>Versionsupdate</h2>
<div class="level2">

<p>
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.
</p>

<p>
Das funktioniert ähnlich wie die Neuinstallation und ist recht einfach:
</p>

<p>
* aktuelles (neues) Image für UniFi herunterladen
</p>

<p>
* UniFi Controller Konfiguration über die Web GUI sichern und herunterladen (zur Sicherheit)
</p>

<p>
* laufenden Container stoppen
</p>

<p>
* Container auswählen und mit Action → Clear (seit DSM 7: Reset) alle Daten löschen (die Konfiguration bleibt erhalten durch den gemounteten Ordner!)
</p>

<p>
* Container wieder starten Danach ist die UniFi Version des Containers aktualisiert.
</p>

</div>

<h2>Update 19.07.2021 – Geräteregistrierung</h2>
<div class="level2">

<p>
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. <a href="https://help.ui.com/hc/en-us/articles/360045001914-UniFi-USW-Flex-Mini-Recovery" class="urlextern" title="https://help.ui.com/hc/en-us/articles/360045001914-UniFi-USW-Flex-Mini-Recovery" rel="ugc nofollow">Firmware-Recovery</a> – ohne Erfolg. Letzten Endes hat nur die Nutzung einer DHCP Adresszuweisung inkl. Option 43 funktioniert.
</p>

<p>
Dazu habe ich in meinem DHCP Server (meine Fortigate Firewall) folgenden Eintrag für den DHCP-Scope gesetzt:
</p>

<p>
Code: 43 Typ: HEX Value: 0104C0A80001
</p>

<p>
Wie setzt sich der Wert für Option 43 zusammen:
</p>

<p>
01 → Vendor Code (01 für Ubiquiti)<br/>

04 → Länge des Payloads (Single IP, daher: 4)<br/>

C0A80001 → HEX-Code für die IP UniFi Controller IP (in diesem Beispiel 192.168.0.1)
</p>

</div>

<h2>Update 11.10.2021 – Geräteregistrierung (Teil 2)</h2>
<div class="level2">

<p>
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.
</p>

</div>

<h2>Update 28.01.2022 – Geräteregistrierung (Teil 3)</h2>
<div class="level2">

<p>
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. <b>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.</b>
</p>

</div>

<h2>Anmerkungen von Gunter</h2>
<div class="level2">

<p>
Das das Host Netzwerk genutzt werden muss entspricht den Angaben von UniFi, die geben nämlich vor dass Unifi Controller im selben Level 2 Netzwerk, also IP Bereich sein muss wie die Access Points.<br/>

Und das ist bei einem Brige Netzwerk mit Portweiterleitung streng genommen nicht der Fall.
</p>

<p>
In der Dokumentation zum Docker Image von Jacob Alberty wird darauf hingewiesen dass noch eine weitere Einstellung vorzunehmen ist damit die Geräte den Server finden:
</p>

</div>

<h4>Adopting Access Points and Unifi Devices</h4>
<div class="level4">

<p>
<b>Override "Inform Host" IP</b>
</p>

<p>
For your Unifi devices to "find" the Unifi Controller running in Docker, you <em>MUST</em> override the Inform Host IP with the address of the Docker host computer. (By default, the Docker container usually gets the internal address 172.17.x.x while Unifi devices connect to the (external) address of the Docker host.) To do this:
</p>
<ul>
<li class="level1"> Find <b>Settings → System → Other Configuration → Override Inform Host:</b>  in the Unifi Controller web GUI. (It's near the bottom of that page.)</li>
<li class="level1"> Check the "Enable" box, and enter the IP address of the Docker host machine.</li>
<li class="level1"> Save settings in Unifi Controller</li>
<li class="level1"> Restart UniFi-in-Docker container with <code>docker stop …</code>  and <code>docker run …</code>  commands.</li>
</ul>

<p>
See <a href="https://registry.hub.docker.com/r/jacobalberty/unifi/Side-Projects.md#other-techniques-for-adoption" class="urlextern" title="https://registry.hub.docker.com/r/jacobalberty/unifi/Side-Projects.md#other-techniques-for-adoption" rel="ugc nofollow">Side Projects</a> for other techniques to get Unifi devices to adopt your new Unifi Controller.
</p>

</div>

<h3>Ändern der Netzwerkanbindung eines Docker Containers in Synology</h3>
<div class="level3">

<p>
Eine Änderung der Netzwerkverbindung von Bridge auf Host ist in der grafischen Oberfläche zumindest bei DSM 6.2. nicht möglich. <br/>
Es muss dazu nach Stoppen des Containers ein neuer Container erzeugt werden. Dieser behält die Daten des alten wenn der selbe Ordner wieder gemountet wird. <br/>
Vorher ist es sinnvoll ein Backup zu erstellen, wie bei Update beschrieben.
</p>

</div>

<h3>Komplette Neuinstallation</h3>
<div class="level3">

<p>
Wenn ALLES gelöscht werden soll und komplett neu installiert werden soll sollte auch der gemountete Ordner gelöscht werden. <br/>
<b>Wichtig ist dass die Mount Ordner immer in der Docker Oberfläche erstellt werden!</b> <br/>
<b>Sonst sind die Rechte möglicherweise so gesetzt dass nur der Benutzer der den Ordner erstellt hat zugreifen kann.</b>
</p>

<p>
<b>Damit ist der Container nicht funktionsfähig weil er nichts auf die Platte schreiben kann.</b>—- Quellen: <br/>
<a href="https://help.ui.com/hc/en-us/articles/218506997-UniFi-Ports-Used" class="urlextern" title="https://help.ui.com/hc/en-us/articles/218506997-UniFi-Ports-Used" rel="ugc nofollow">https://help.ui.com/</a> <br/>

<a href="https://registry.hub.docker.com/r/jacobalberty/unifi/" class="urlextern" title="https://registry.hub.docker.com/r/jacobalberty/unifi/" rel="ugc nofollow">https://registry.hub.docker.com/r/jacobalberty/unifi/</a> <em>'' </em>
</p>

</div>

Aktiviere komplexe Tabellen Editorhöhe px Zusätzliche Unterstützung beim Einfügen von Bildern aus der Zwischenablage Ein

Zusammenfassung: Kleine Änderungen