mirror of
https://github.com/eduardogsilva/wireguard_webadmin.git
synced 2026-01-10 01:46:17 +00:00
update README files with WireGuard status caching settings and explanations
This commit is contained in:
Eduardo Silva
15
README.md
15
README.md
@@ -110,12 +110,23 @@ This mode is recommended for running the web admin interface. The container depl
|
||||
# A missconfigured SERVER_ADDRESS will cause the app to have CSRF errors.
|
||||
SERVER_ADDRESS=my_server_address
|
||||
DEBUG_MODE=False
|
||||
|
||||
|
||||
# Choose a timezone from https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
|
||||
TIMEZONE=America/Sao_Paulo
|
||||
|
||||
|
||||
# WireGuard status caching settings
|
||||
# This improves performance by reducing the number of calls to `wg` command and storing recent results.
|
||||
# WIREGUARD_STATUS_CACHE_ENABLED=True
|
||||
#
|
||||
# How many cached WireGuard status snapshots should be preloaded on page load.
|
||||
# This allows traffic charts to be displayed already populated instead of starting empty.
|
||||
# Lower this value if the initial peer list feels slow.
|
||||
# 0 = disable preload, 9 = fully prefill traffic charts.#
|
||||
# WIREGUARD_STATUS_CACHE_WEB_LOAD_PREVIOUS_COUNT=9
|
||||
|
||||
# If you need additional hosts to be allowed, you can specify them here.
|
||||
# The SERVER_ADDRESS will always be allowed.
|
||||
# Example: EXTRA_ALLOWED_HOSTS=app1.example.com,app2.example.com:8443,app3.example.com
|
||||
#EXTRA_ALLOWED_HOSTS=app1.example.com,app2.example.com:8443,app3.example.com
|
||||
```
|
||||
|
||||
|
||||
@@ -79,13 +79,7 @@ Folge diesen Schritten, um WireGuard WebAdmin bereitzustellen:
|
||||
|
||||
```bash
|
||||
mkdir wireguard_webadmin && cd wireguard_webadmin
|
||||
1. **Umgebung vorbereiten**
|
||||
|
||||
Erstelle zunächst ein Verzeichnis für WireGuard WebAdmin und wechsle hinein:
|
||||
|
||||
```bash
|
||||
mkdir wireguard_webadmin && cd wireguard_webadmin
|
||||
```
|
||||
```
|
||||
|
||||
2. **Docker‑Compose‑Datei herunterladen**
|
||||
|
||||
@@ -112,7 +106,7 @@ Folge diesen Schritten, um WireGuard WebAdmin bereitzustellen:
|
||||
> [!CAUTION]
|
||||
> Es wird nicht empfohlen, das System ohne HTTPS (NGINX) zu betreiben, da dies Sicherheitsrisiken birgt. Wenn Sie diese Option wählen, stellen Sie sicher, dass Sie eine sichere Verbindung verwenden (z. B. über Ihren eigenen Reverse-Proxy mit SSL).
|
||||
|
||||
3. **`.env`‑Datei erstellen**
|
||||
3. **.env‑Datei erstellen**
|
||||
|
||||
Erstelle eine `.env`‑Datei im selben Verzeichnis wie deine `docker-compose.yml` und passe `my_server_address` an die DNS‑Adresse oder IP deines Servers an:
|
||||
|
||||
@@ -121,6 +115,24 @@ Folge diesen Schritten, um WireGuard WebAdmin bereitzustellen:
|
||||
# Ein falsch konfigurierter SERVER_ADDRESS führt zu CSRF‑Fehlern.
|
||||
SERVER_ADDRESS=my_server_address
|
||||
DEBUG_MODE=False
|
||||
|
||||
# Wähle eine Zeitzone aus https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
|
||||
TIMEZONE=Europe/Berlin
|
||||
|
||||
# WireGuard‑Status‑Caching‑Einstellungen
|
||||
# Dies verbessert die Leistung, indem die Anzahl der Aufrufe des `wg`-Befehls reduziert und aktuelle Ergebnisse gespeichert werden.
|
||||
# WIREGUARD_STATUS_CACHE_ENABLED=True
|
||||
#
|
||||
# Wie viele zwischengespeicherte WireGuard-Status-Snapshots beim Laden der Seite vorgeladen werden sollen.
|
||||
# Dies ermöglicht es, dass Traffic-Diagramme bereits ausgefüllt angezeigt werden, anstatt leer zu beginnen.
|
||||
# Verringern Sie diesen Wert, wenn sich die initiale Peer-Liste langsam anfühlt.
|
||||
# 0 = Vorladen deaktivieren, 9 = Traffic-Diagramme vollständig ausfüllen.
|
||||
# WIREGUARD_STATUS_CACHE_WEB_LOAD_PREVIOUS_COUNT=9
|
||||
|
||||
# Wenn Sie zusätzliche erlaubte Hosts benötigen, können Sie diese hier angeben.
|
||||
# Die SERVER_ADDRESS wird immer erlaubt sein.
|
||||
# Beispiel: EXTRA_ALLOWED_HOSTS=app1.beispiel.com,app2.beispiel.com:8443,app3.beispiel.com
|
||||
#EXTRA_ALLOWED_HOSTS=app1.beispiel.com,app2.beispiel.com:8443,app3.beispiel.com
|
||||
```
|
||||
|
||||
4. **Docker Compose ausführen**
|
||||
@@ -183,4 +195,3 @@ Beiträge machen die Open‑Source‑Community großartig. **Danke für jede Unt
|
||||
## Support
|
||||
|
||||
Bei Fragen oder Problemen eröffne bitte ein Issue auf GitHub.
|
||||
|
||||
|
||||
@@ -111,6 +111,24 @@ Siga estos pasos para desplegar WireGuard WebAdmin:
|
||||
# Una SERVER_ADDRESS mal configurada provocará errores CSRF.
|
||||
SERVER_ADDRESS=my_server_address
|
||||
DEBUG_MODE=False
|
||||
|
||||
# Elija una zona horaria de https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
|
||||
TIMEZONE=America/Sao_Paulo
|
||||
|
||||
# Configuración de caché de estado de WireGuard
|
||||
# Esto mejora el rendimiento al reducir el número de llamadas al comando `wg` y almacenar resultados recientes.
|
||||
# WIREGUARD_STATUS_CACHE_ENABLED=True
|
||||
#
|
||||
# Cuántas instantáneas del estado de WireGuard almacenadas en caché deben precargarse al cargar la página.
|
||||
# Esto permite que los gráficos de tráfico se muestren ya poblados en lugar de comenzar vacíos.
|
||||
# Reduzca este valor si la lista inicial de pares parece lenta.
|
||||
# 0 = desactivar precarga, 9 = completar totalmente los gráficos de tráfico.
|
||||
# WIREGUARD_STATUS_CACHE_WEB_LOAD_PREVIOUS_COUNT=9
|
||||
|
||||
# Si necesita hosts adicionales permitidos, puede especificarlos aquí.
|
||||
# El SERVER_ADDRESS siempre estará permitido.
|
||||
# Ejemplo: EXTRA_ALLOWED_HOSTS=app1.ejemplo.com,app2.ejemplo.com:8443,app3.ejemplo.com
|
||||
#EXTRA_ALLOWED_HOSTS=app1.ejemplo.com,app2.ejemplo.com:8443,app3.ejemplo.com
|
||||
```
|
||||
|
||||
Sustituya `my_server_address` por la dirección real de su servidor.
|
||||
|
||||
@@ -107,6 +107,24 @@ Suivez ces étapes pour déployer WireGuard WebAdmin:
|
||||
# Une mauvaise valeur provoquera des erreurs CSRF.
|
||||
SERVER_ADDRESS=my_server_address
|
||||
DEBUG_MODE=False
|
||||
|
||||
# Choisissez un fuseau horaire parmi https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
|
||||
TIMEZONE=Europe/Paris
|
||||
|
||||
# Paramètres de mise en cache de l'état WireGuard
|
||||
# Cela améliore les performances en réduisant le nombre d'appels à la commande `wg` et en stockant les résultats récents.
|
||||
# WIREGUARD_STATUS_CACHE_ENABLED=True
|
||||
#
|
||||
# Combien d'instantanés de statut WireGuard mis en cache doivent être préchargés lors du chargement de la page.
|
||||
# Cela permet d'afficher les graphiques de trafic déjà remplis au lieu de commencer vides.
|
||||
# Diminuez cette valeur si la liste initiale des pairs semble lente.
|
||||
# 0 = désactiver le préchargement, 9 = pré-remplir complètement les graphiques de trafic.
|
||||
# WIREGUARD_STATUS_CACHE_WEB_LOAD_PREVIOUS_COUNT=9
|
||||
|
||||
# Si vous avez besoin d'hôtes supplémentaires autorisés, vous pouvez les spécifier ici.
|
||||
# Le SERVER_ADDRESS sera toujours autorisé.
|
||||
# Exemple : EXTRA_ALLOWED_HOSTS=app1.exemple.com,app2.exemple.com:8443,app3.exemple.com
|
||||
#EXTRA_ALLOWED_HOSTS=app1.exemple.com,app2.exemple.com:8443,app3.exemple.com
|
||||
```
|
||||
|
||||
Remplacez `my_server_address` par l’adresse réelle de votre serveur.
|
||||
|
||||
@@ -111,6 +111,24 @@ Siga estes passos para implantar o WireGuard WebAdmin:
|
||||
# Um SERVER_ADDRESS configurado incorretamente causará erros de CSRF na aplicação.
|
||||
SERVER_ADDRESS=my_server_address
|
||||
DEBUG_MODE=False
|
||||
|
||||
# Escolha um fuso horário em https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
|
||||
TIMEZONE=America/Sao_Paulo
|
||||
|
||||
# Configurações de cache de status do WireGuard
|
||||
# Isso melhora o desempenho reduzindo o número de chamadas ao comando `wg` e armazenando resultados recentes.
|
||||
# WIREGUARD_STATUS_CACHE_ENABLED=True
|
||||
#
|
||||
# Quantos instantâneos (snapshots) do status do WireGuard em cache devem ser pré-carregados ao carregar a página.
|
||||
# Isso permite que os gráficos de tráfego sejam exibidos já preenchidos em vez de começarem vazios.
|
||||
# Diminua este valor se a lista inicial de peers parecer lenta.
|
||||
# 0 = desativar pré-carregamento, 9 = preencher totalmente os gráficos de tráfego.
|
||||
# WIREGUARD_STATUS_CACHE_WEB_LOAD_PREVIOUS_COUNT=9
|
||||
|
||||
# Se você precisar de hosts adicionais permitidos, pode especificá-los aqui.
|
||||
# O SERVER_ADDRESS sempre será permitido.
|
||||
# Exemplo: EXTRA_ALLOWED_HOSTS=app1.exemplo.com,app2.exemplo.com:8443,app3.exemplo.com
|
||||
#EXTRA_ALLOWED_HOSTS=app1.exemplo.com,app2.exemplo.com:8443,app3.exemplo.com
|
||||
```
|
||||
|
||||
Substitua `my_server_address` pelo endereço real do seu servidor.
|
||||
|
||||
Reference in New Issue
Block a user