Best Practice: AdGuard Home Sync

plang.pl · 06. Dez 2023

Nach meinen Anleitungen rund zum Thema AdGuard Home + unbound und die Nutzung für die lokale Domainauflösung folgt nun mein Beitrag zum Thema Synchronisieren von zwei Instanzen des AdGuard Home. Warum braucht man das? Beispiel: Ich persönlich habe bei mir einen AdGuard laufen und bei meinen Eltern läuft ebenfalls einer. Wenn ich nun was an der Config anpasse oder Filterlisten hinzufüge, möchte ich das nicht immer 2x machen. Beide Standorte sind via S2S VPN verbunden und über diesen Tunnel erfolgt u.a. auch der Sync der beiden AdGuard Instanzen.

Voraussetzungen

In dieser Anleitung wird vorausgesetzt, dass der Umgang mit der FileStation und Hochladen von Dateien aufs NAS bekannt ist und auch, wie man mit Archiven umgeht.

Anleitung

Schritt 1: Docker vorbereiten
Als Erstes den „Container Manager“ aus dem Paket-Zentrum installieren. Vor DSM 7.2 heißt das Paket nicht „Container Manager“, sondern „Docker“.
Anschließend wechseln in die FileStation in den automatisch erstellten Ordner docker. In diesen Ordner muss das Archiv ProjektSync.zip aus dem Anhang entpackt werden. Achtung: Es muss danach so sein, dass unter dem freigegebenem Ordner docker direkt der Ordner adguardsync liegt.

Schritt 2: Compose-Datei anpassen
Da ich die Gegebenheiten bei euch nicht kenne, muss das Compose-File angepasst werden. Die entsprechenden Infos einfügen bei:
URL Master-Instanz - die URL der Instanz, von der die Daten gelesen werden sollen (mit vorangestelltem http/https und auch dem Port am Ende!)
User Master-Instanz - User der AdGuard Weboberfläche
PW Master-Instanz - und dessen Passwort
URL Slave-Instanz- die URL der Instanz, auf die die Daten geschrieben werden sollen
User Slave-Instanz
PW Slave-Instanz
User WebUI - Username zur Anmeldung an der WebUI des AdGuard Home Sync
PW WebUI - und dessen Passwort

Die Sync-Features: Alle auskommentierten Features sind an. Wenn etwas nicht gesynct werden soll, muss der # am Beginn der Zeile entfernt werden und am Ende der Zeile das true in false geändert werden. Ich habe in die Datei meine Einstellungen übernommen. Bitte bei Bedarf anpassen.
Der Port, auf den der Container lauschen soll, kann natürlich auch angepasst werden. Das ist der Port, über den dann die Web-Oberfläche erreichbar sein wird. In meiner Vorlage ist das 8081.

Schritt 3: Installation des AdGuard Home Sync Containers (via CLI)
Unter DSM 7.2 und dem Container-Manager kann der Inhalt der Datei in dem angehängten ZIP (docker-compose.yml) einfach eingefügt werden, wenn man im Container-Manager den Punkt "Projekte" und "Erstellen" anwählt. Dann entweder die Datei hochladen oder umstellen auf "docker-compose.yml erstellen" und nur den Inhalt einfügen.
Vor DSM 7.2:
Es muss sich via ssh als Root am NAS angemeldet werden. Wie das geht, beschreibt dieser KB-Artikel ganz gut.
Auszuführende Befehle:

Bash:

cd /volume1/docker/adguardsync
docker-compose up -d

Schritt 4: Abschließende Schritte
Zu guter letzt kann man einmal die Container Logs checken oder die Weboberfläche des Containers aufrufen (dort sieht man die Logs auch) - Voraussetzung für letzteres ist natürlich, dass der Container fehlerfrei gestartet ist.
Auf der Web Oberfläche kann man nur einen Sync anstoßen (was aber auch alle 15 Minuten automatisch geschieht - siehe yml Datei), die Logs leeren und die Master-Instanz per Knopfdruck aufrufen. Also eher einfach gehalten.

Mittlerweile macht man die Container-Config anders (GitHub). Doch die hier gezeigte Version funktioniert immer noch. Ich hab das bei mir schon ziemlich lange am Laufen. Wenn ich das bei mir selbst mal auf die "moderne Version" umgestellt habe, werde ich hier auch den Thread updaten.

Wenn es hierzu fragen gibt, könnt ihr euch gerne in diesem Thread melden!

-Aktualisierung des Aufbaus (ist aktuell eher "legacy")

v1.0

23-12-06 | v1
-erste Veröffentlichung