4f17f7ff81
BREAKING CHANGE: Die alte Shell-Version muss vor der Installation der Go-Version deinstalliert werden.
2.9 KiB
Dokumentation
Willkommen in der Dokumentation von AdGuard Shield.
AdGuard Shield ist ein Go-Daemon, der das Query Log von AdGuard Home auswertet, auffällige DNS-Clients erkennt und diese über eine eigene Firewall-Struktur sperrt. Die Dokumentation ist bewusst ausführlich gehalten: Sie soll nicht nur Befehle auflisten, sondern erklären, was im Hintergrund passiert, welche Werte sinnvoll sind und wie du Fehler sauber eingrenzt.
Schnellnavigation
| Dokument | Wofür es gedacht ist |
|---|---|
| Architektur & Funktionsweise | Erklärt den Aufbau, den Datenfluss, Firewall, SQLite, Hintergrundjobs und Sperrlogik |
| Befehle & Nutzung | Vollständige CLI-Referenz mit typischen Betriebsabläufen |
| Konfiguration | Alle Parameter aus adguard-shield.conf mit Beispielen und Empfehlungen |
| Docker-Installationen | Firewall-Modi für klassische Installation, Docker Host Network und veröffentlichte Docker-Ports |
| Benachrichtigungen | Einrichtung von Ntfy, Discord, Slack, Gotify und Generic Webhooks |
| E-Mail Report | Report-Inhalte, Mailversand, Cron-Job und manuelle Tests |
| Update-Anleitung | Update der Go-Version und Migration von alten Shell-Installationen |
| Tipps & Troubleshooting | Diagnosewege für API, Firewall, GeoIP, Reports, Listen und falsch gesetzte Sperren |
Wichtigster Unterschied zur alten Shell-Version
Die frühere Version bestand aus mehreren Shell-Skripten, Hilfs-Workern, Cron-Jobs und einem separaten Watchdog. Die Go-Version bündelt diese Aufgaben in einem einzelnen Binary:
/opt/adguard-shield/adguard-shield
Dieses Binary ist gleichzeitig:
- Daemon für den produktiven Betrieb
- CLI für Status, History, Logs, Firewall, Listen, GeoIP und Reports
- Installer, Updater und Uninstaller
- Report-Generator
- Hintergrundprozess für externe Whitelist, externe Blocklist, GeoIP und Offense-Cleanup
Die meisten Befehle beginnen daher mit:
sudo /opt/adguard-shield/adguard-shield <befehl>
Für Installation oder Update nutzt du das neue Binary aus dem Repository, Release oder Build-Verzeichnis:
sudo ./adguard-shield install
sudo ./adguard-shield update
Empfohlener Lesefluss
Wenn du AdGuard Shield neu einrichtest:
- Lies zuerst Architektur & Funktionsweise, damit klar ist, was genau gesperrt wird.
- Passe danach Konfiguration an, besonders API-Zugang, Whitelist und Rate-Limits.
- Nutze Befehle & Nutzung für Installation, Dry-Run und Service-Start.
- Richte optional Benachrichtigungen, Reports, GeoIP oder externe Listen ein.
- Bei Problemen hilft Tipps & Troubleshooting.
Wenn du von der alten Shell-Version kommst, beginne mit Update-Anleitung.