Update 4.0 - Zusammenfuehrung AD/Local, Config-Datei, Ntfy-Support
Co-authored-by: Copilot <copilot@github.com>
This commit is contained in:
92
docs/configuration.md
Normal file
92
docs/configuration.md
Normal file
@@ -0,0 +1,92 @@
|
||||
# Konfiguration
|
||||
|
||||
Alle Einstellungen werden in der `config.conf` vorgenommen, die im selben Verzeichnis wie das Script liegen muss.
|
||||
|
||||
## Modus
|
||||
|
||||
| Wert | Beschreibung |
|
||||
|---|---|
|
||||
| `MODE=ad` | Empfaenger werden aus einer AD-Sicherheitsgruppe gelesen |
|
||||
| `MODE=local` | Empfaenger werden manuell in der Konfiguration definiert |
|
||||
|
||||
**RSAT-Modul installieren (nur fuer AD-Modus):**
|
||||
|
||||
```powershell
|
||||
Install-WindowsFeature RSAT-AD-PowerShell
|
||||
```
|
||||
|
||||
## Benachrichtigungsmethoden
|
||||
|
||||
Kommasepariert — einzeln oder kombiniert:
|
||||
|
||||
```
|
||||
NOTIFICATION_METHODS=email
|
||||
NOTIFICATION_METHODS=ntfy
|
||||
NOTIFICATION_METHODS=email,ntfy
|
||||
```
|
||||
|
||||
## E-Mail
|
||||
|
||||
| Key | Beschreibung |
|
||||
|---|---|
|
||||
| `SMTP_SERVER` | SMTP-Server Adresse |
|
||||
| `SMTP_FROM_NAME` | Anzeigename des Absenders |
|
||||
| `SMTP_FROM_EMAIL` | E-Mail-Adresse des Absenders |
|
||||
|
||||
Beispiel:
|
||||
|
||||
```
|
||||
SMTP_SERVER=smtp.example.com
|
||||
SMTP_FROM_NAME=Notification Service
|
||||
SMTP_FROM_EMAIL=noreply@example.com
|
||||
```
|
||||
|
||||
## AD-Modus
|
||||
|
||||
Nur relevant wenn `MODE=ad`.
|
||||
|
||||
| Key | Beschreibung |
|
||||
|---|---|
|
||||
| `AD_SECURITY_GROUP_DN` | Distinguished Name der AD-Sicherheitsgruppe, deren Mitglieder benachrichtigt werden |
|
||||
|
||||
Beispiel:
|
||||
|
||||
```
|
||||
AD_SECURITY_GROUP_DN=CN=Gruppe,OU=Gruppen,DC=domain,DC=local
|
||||
```
|
||||
|
||||
## Local-Modus
|
||||
|
||||
Nur relevant wenn `MODE=local`. Mehrere Empfaenger mit Semikolon trennen.
|
||||
|
||||
| Key | Beschreibung |
|
||||
|---|---|
|
||||
| `LOCAL_RECIPIENTS` | Empfaengerliste im Format `Name,Email;Name,Email` |
|
||||
|
||||
Beispiel:
|
||||
|
||||
```
|
||||
LOCAL_RECIPIENTS=Max Mustermann,max@example.com;Lisa Mueller,lisa@example.com
|
||||
```
|
||||
|
||||
## Ntfy Push-Benachrichtigung
|
||||
|
||||
Nur relevant wenn `ntfy` in `NOTIFICATION_METHODS` enthalten ist.
|
||||
|
||||
| Key | Beschreibung |
|
||||
|---|---|
|
||||
| `NTFY_SERVER` | URL des Ntfy-Servers |
|
||||
| `NTFY_TOPIC` | Ntfy-Topic |
|
||||
| `NTFY_PRIORITY` | Prioritaet 1-5 (1=min, 3=default, 5=max) |
|
||||
| `NTFY_TAGS` | Kommaseparierte Emoji-Tags |
|
||||
| `NTFY_AUTH_TOKEN` | Bearer-Token (leer lassen wenn nicht benoetigt) |
|
||||
|
||||
Beispiel:
|
||||
|
||||
```
|
||||
NTFY_SERVER=https://ntfy.sh
|
||||
NTFY_TOPIC=rdp-access
|
||||
NTFY_PRIORITY=3
|
||||
NTFY_TAGS=warning,computer
|
||||
NTFY_AUTH_TOKEN=tk_geheim123
|
||||
```
|
||||
Reference in New Issue
Block a user