README.md ergänzung

This commit is contained in:
root
2026-01-29 09:57:28 +01:00
parent 3ec3115255
commit e49632f383

View File

@@ -48,6 +48,14 @@ Das Skript kann ohne Parameter zur vollständigen Inventarisierung oder mit Filt
### Parameter-Referenz
| Parameter | Beschreibung | Beispiel |
| :--- | :--- | :--- |
| `[DOMAIN]` | Filtert das Inventar nach Domainname (unterstützt Wildcards wie `*`). | `./proxy-inventory.sh "knut*"` |
| `ID <n>` | Filtert die Ergebnisliste nach einer spezifischen ISPConfig Server-ID. | `./proxy-inventory.sh ID 17` |
| `PROXY <status>` | Filtert nach dem Proxy-Status: `OK` (vorhanden) oder `FEHLT`. | `./proxy-inventory.sh PROXY FEHLT` |
| `DNS <status>` | Filtert nach dem DNS-Status: `OK` oder `N/A`. | `./proxy-inventory.sh DNS N/A` |
| `MODUS <typ>` | Filtert nach dem Modus: `NORMAL` oder `DUMMY`. | `./proxy-inventory.sh MODUS DUMMY` |
| `-h` / `--help` | Zeigt die Hilfe-Seite mit Beispielen für das Inventar-Script an. | `./proxy-inventory.sh --help` |
| Script | Parameter | Beschreibung | Beispiel |
| :--- | :--- | :--- | :--- |
| **`proxy-inventory.sh`** | `[DOMAIN]` | Filtert das Inventar nach Domainname; unterstützt Wildcards wie `*`. | `./proxy-inventory.sh "knut*"` |
@@ -57,6 +65,8 @@ Das Skript kann ohne Parameter zur vollständigen Inventarisierung oder mit Filt
| | `MODUS <typ>` | Filtert nach dem Modus: `NORMAL` oder `DUMMY`. | `./proxy-inventory.sh MODUS DUMMY` |
| | `-h` / `--help` | Zeigt die Hilfe-Seite mit Beispielen für das Inventar-Script an. | `./proxy-inventory.sh --help` |
#
# ISPConfig Proxy Sync Script (`sync-ispconfig-proxy.sh`)
## Beschreibung
@@ -81,15 +91,31 @@ Das Skript kann manuell oder via Cronjob aufgerufen werden:
```bash
./sync-ispconfig-proxy.sh [DOMAIN] [Optionen]
```
### Parameter-Referenz
| Script | Parameter | Beschreibung | Beispiel |
| :--- | :--- | :--- | :--- |
| **`sync-ispconfig-proxy.sh`** | `[DOMAIN]` | Synchronisiert gezielt nur eine bestimmte Domain oder deren Parent-Domain. | `./sync-ispconfig-proxy.sh example.com` |
| | `test` | Aktiviert den Test-Modus: Simuliert den Lauf ohne Änderungen an Nginx oder SSL. | `./sync-ispconfig-proxy.sh test` |
| | `force` | Erzwingt die Verarbeitung aller Domains, unabhängig vom Datalog-Status. | `./sync-ispconfig-proxy.sh force` |
| | `renew` / `repair` | Erzwingt eine Neuausstellung der SSL-Zertifikate via acme.sh. | `./sync-ispconfig-proxy.sh renew` |
| | `-debug` | Aktiviert den Debug-Modus und gibt u.a. die SQL-Queries in der Konsole aus. | `./sync-ispconfig-proxy.sh -debug` |
| Parameter | Beschreibung | Beispiel |
| :--- | :--- | :--- |
| `[DOMAIN]` | Beschränkt die Ausführung auf eine spezifische Domain. | `./sync-ispconfig-proxy.sh example.com` |
| `test` | **Dry-Run**: Simuliert alle Schritte ohne Nginx-Configs zu schreiben oder Dienste zu laden. | `./sync-ispconfig-proxy.sh test` |
| `force` | Ignoriert den Zeitstempel/ID der letzten Änderung und verarbeitet den gesamten Bestand. | `./sync-ispconfig-proxy.sh force` |
| `renew` / `repair` | Erzwingt die Neuausstellung aller betroffenen SSL-Zertifikate (acme.sh --force). | `./sync-ispconfig-proxy.sh renew` |
| `-debug` | Aktiviert detaillierte Ausgaben (z.B. SQL-Queries und interne Variablen). | `./sync-ispconfig-proxy.sh -debug` |
### Kombination & Priorität
Die Parameter können kombiniert werden, um das Verhalten präzise zu steuern. Dabei gilt folgende Priorisierung:
1. **Sicherheits-Priorität (`test`)**: Der Parameter `test` überschreibt alle schreibenden Aktionen. Auch wenn `force` oder `renew` gesetzt sind, wird im Testmodus nichts am System verändert.
2. **Scope-Priorität (`[DOMAIN]` vor `force`)**: Wenn eine spezifische `DOMAIN` angegeben wird, hat diese Vorrang. Der Parameter `force` wird in diesem Fall ignoriert, da das Skript gezielt nur diesen einen Datensatz anspricht.
3. **Aktions-Priorität (`renew`)**: Wird `renew` mit `force` kombiniert, werden konsequent für **alle** in ISPConfig aktiven Domains die Zertifikate neu angefordert.
**Gängige Kombinationen:**
* `./sync-ispconfig-proxy.sh example.com renew`: Erneuert gezielt nur das Zertifikat für `example.com`.
* `./sync-ispconfig-proxy.sh force -debug`: Verarbeitet alle Domains neu und zeigt dabei die SQL-Abfragen zur Fehleranalyse an.
* `./sync-ispconfig-proxy.sh renew test`: Simuliert die Erneuerung aller Zertifikate, ohne acme.sh tatsächlich aufzurufen.
# ISPConfig Proxy Cleanup Script (`sync-ispconfig-cleanup.sh`)