feat: adguard-shield als globalen CLI-Befehl registrieren + Doku
This commit is contained in:
Patrick Asmus
@@ -88,13 +88,13 @@ REPORT_MAIL_CMD="msmtp"
|
||||
### Konfiguration und Cron-Status anzeigen
|
||||
|
||||
```bash
|
||||
sudo /opt/adguard-shield/adguard-shield report-status
|
||||
sudo adguard-shield report-status
|
||||
```
|
||||
|
||||
### HTML-Report in Datei schreiben
|
||||
|
||||
```bash
|
||||
sudo /opt/adguard-shield/adguard-shield report-generate html /tmp/adguard-shield-report.html
|
||||
sudo adguard-shield report-generate html /tmp/adguard-shield-report.html
|
||||
```
|
||||
|
||||
Die Datei kann im Browser geöffnet werden, um das Ergebnis zu prüfen.
|
||||
@@ -102,13 +102,13 @@ Die Datei kann im Browser geöffnet werden, um das Ergebnis zu prüfen.
|
||||
### Text-Report auf stdout ausgeben
|
||||
|
||||
```bash
|
||||
sudo /opt/adguard-shield/adguard-shield report-generate txt
|
||||
sudo adguard-shield report-generate txt
|
||||
```
|
||||
|
||||
### Testmail senden
|
||||
|
||||
```bash
|
||||
sudo /opt/adguard-shield/adguard-shield report-test
|
||||
sudo adguard-shield report-test
|
||||
```
|
||||
|
||||
Sendet eine einfache Testmail. Erst wenn diese ankommt, lohnt sich die Fehlersuche am eigentlichen Report.
|
||||
@@ -116,19 +116,19 @@ Sendet eine einfache Testmail. Erst wenn diese ankommt, lohnt sich die Fehlersuc
|
||||
### Aktuellen Report erzeugen und versenden
|
||||
|
||||
```bash
|
||||
sudo /opt/adguard-shield/adguard-shield report-send
|
||||
sudo adguard-shield report-send
|
||||
```
|
||||
|
||||
### Cron-Job installieren
|
||||
|
||||
```bash
|
||||
sudo /opt/adguard-shield/adguard-shield report-install
|
||||
sudo adguard-shield report-install
|
||||
```
|
||||
|
||||
### Cron-Job entfernen
|
||||
|
||||
```bash
|
||||
sudo /opt/adguard-shield/adguard-shield report-remove
|
||||
sudo adguard-shield report-remove
|
||||
```
|
||||
|
||||
---
|
||||
@@ -148,7 +148,7 @@ REPORT_MAIL_CMD="msmtp"
|
||||
sudo apt install msmtp msmtp-mta
|
||||
|
||||
# Testmail senden
|
||||
sudo /opt/adguard-shield/adguard-shield report-test
|
||||
sudo adguard-shield report-test
|
||||
```
|
||||
|
||||
### Eigene Mailprogramm-Argumente
|
||||
@@ -175,7 +175,7 @@ REPORT_MAIL_CMD="msmtp --account=default"
|
||||
### Cron-Job installieren
|
||||
|
||||
```bash
|
||||
sudo /opt/adguard-shield/adguard-shield report-install
|
||||
sudo adguard-shield report-install
|
||||
```
|
||||
|
||||
Dadurch wird diese Datei geschrieben:
|
||||
@@ -184,12 +184,14 @@ Dadurch wird diese Datei geschrieben:
|
||||
/etc/cron.d/adguard-shield-report
|
||||
```
|
||||
|
||||
Der Cron-Eintrag ruft das installierte Binary mit der installierten Konfiguration auf:
|
||||
Der Cron-Eintrag ruft den globalen CLI-Befehl mit der installierten Konfiguration auf, sofern er registriert ist:
|
||||
|
||||
```text
|
||||
/opt/adguard-shield/adguard-shield -config /opt/adguard-shield/adguard-shield.conf report-send
|
||||
/usr/local/bin/adguard-shield -config /opt/adguard-shield/adguard-shield.conf report-send
|
||||
```
|
||||
|
||||
Falls die Installation mit `--no-register` erfolgt ist, verwendet `report-install` stattdessen `/opt/adguard-shield/adguard-shield`.
|
||||
|
||||
### Zeitplan nach Intervall
|
||||
|
||||
| Intervall | Cron-Verhalten |
|
||||
@@ -202,7 +204,7 @@ Der Cron-Eintrag ruft das installierte Binary mit der installierten Konfiguratio
|
||||
### Cron-Job entfernen
|
||||
|
||||
```bash
|
||||
sudo /opt/adguard-shield/adguard-shield report-remove
|
||||
sudo adguard-shield report-remove
|
||||
```
|
||||
|
||||
---
|
||||
@@ -212,33 +214,33 @@ sudo /opt/adguard-shield/adguard-shield report-remove
|
||||
### Schritt 1: Status prüfen
|
||||
|
||||
```bash
|
||||
sudo /opt/adguard-shield/adguard-shield report-status
|
||||
sudo adguard-shield report-status
|
||||
```
|
||||
|
||||
### Schritt 2: Report lokal erzeugen
|
||||
|
||||
```bash
|
||||
# HTML-Report zum Ansehen im Browser
|
||||
sudo /opt/adguard-shield/adguard-shield report-generate html /tmp/adguard-shield-report.html
|
||||
sudo adguard-shield report-generate html /tmp/adguard-shield-report.html
|
||||
|
||||
# Text-Report in der Konsole
|
||||
sudo /opt/adguard-shield/adguard-shield report-generate txt
|
||||
sudo adguard-shield report-generate txt
|
||||
```
|
||||
|
||||
### Schritt 3: Versand testen
|
||||
|
||||
```bash
|
||||
# Einfache Testmail
|
||||
sudo /opt/adguard-shield/adguard-shield report-test
|
||||
sudo adguard-shield report-test
|
||||
|
||||
# Vollständigen Report senden
|
||||
sudo /opt/adguard-shield/adguard-shield report-send
|
||||
sudo adguard-shield report-send
|
||||
```
|
||||
|
||||
### Schritt 4: Logs prüfen
|
||||
|
||||
```bash
|
||||
sudo /opt/adguard-shield/adguard-shield logs --level warn --limit 100
|
||||
sudo adguard-shield logs --level warn --limit 100
|
||||
sudo journalctl -u cron --no-pager -n 100
|
||||
```
|
||||
|
||||
@@ -277,7 +279,7 @@ Oder setze `REPORT_MAIL_CMD` auf dein vorhandenes Mailprogramm.
|
||||
Prüfe die Konfiguration und den Cron-Job:
|
||||
|
||||
```bash
|
||||
sudo /opt/adguard-shield/adguard-shield report-send
|
||||
sudo adguard-shield report-send
|
||||
sudo cat /etc/cron.d/adguard-shield-report
|
||||
```
|
||||
|
||||
@@ -296,6 +298,6 @@ sudo cat /etc/cron.d/adguard-shield-report
|
||||
Du kannst das Format unabhängig von der Konfiguration wählen:
|
||||
|
||||
```bash
|
||||
sudo /opt/adguard-shield/adguard-shield report-generate txt
|
||||
sudo /opt/adguard-shield/adguard-shield report-generate html /tmp/report.html
|
||||
sudo adguard-shield report-generate txt
|
||||
sudo adguard-shield report-generate html /tmp/report.html
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user