Mirrors/wireguard_webadmin
1
0
Fork 0
mirror of https://github.com/eduardogsilva/wireguard_webadmin.git synced 2026-03-22 00:16:18 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

update readme files

Browse Source
This commit is contained in:
Eduardo Silva
2026-03-18 11:42:28 -03:00
parent 7ac1b1ae5d
commit 56fc0828bb
5 changed files with 68 additions and 53 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@@ -81,31 +81,34 @@ Follow these steps to deploy the WireGuard WebAdmin:
2.**Fetch the Docker Compose File:** 2.**Fetch the Docker Compose File:**
Depending on your deployment scenario, choose one of the following commands to download the appropriate `docker-compose.yml` file directly into your working directory. This approach ensures you're using the latest version of the deployment configuration. Depending on your deployment scenario, choose one of the following commands to download the appropriate compose file directly into your working directory. This approach ensures you're using the latest version of the deployment configuration.
### Option 1: With NGINX (Recommended) ### Option 1: With Caddy (Recommended)
For a production-ready deployment with NGINX as a reverse proxy (recommended for most users), use: For the recommended production deployment with Caddy as a reverse proxy, use:
```bash ```bash
wget -O docker-compose.yml https://raw.githubusercontent.com/eduardogsilva/wireguard_webadmin/main/docker-compose.yml wget -O docker-compose.yml https://raw.githubusercontent.com/eduardogsilva/wireguard_webadmin/main/docker-compose-caddy.yml
``` ```
This mode is recommended for running the web admin interface. The container deployment will automatically generate a self-signed certificate for you. If you want to update your certificates, simply navigate to the `certificates` volume and replace `nginx.pem` and `nginx.key` with your own certificates. This is the recommended way to run the web admin interface because it includes all supported reverse proxy features and provides automatic SSL certificate management through Caddy.
### Option 2: Without NGINX > [!IMPORTANT]
> Caddy requires a valid DNS name, either internal or public, pointing to your server so it can obtain and renew SSL certificates correctly.
If you prefer to use your own reverse proxy or run without one, use: ### Option 2: Without Caddy
If you prefer to use your own reverse proxy or run the application without Caddy, use:
```bash ```bash
wget -O docker-compose.yml https://raw.githubusercontent.com/eduardogsilva/wireguard_webadmin/main/docker-compose-no-nginx.yml wget -O docker-compose.yml https://raw.githubusercontent.com/eduardogsilva/wireguard_webadmin/main/docker-compose-no-caddy.yml
``` ```
> [!CAUTION] > [!CAUTION]
> Running the system without HTTPS (NGINX) is not recommended due to security risks. If you choose this option, ensure you are using a secure connection (e.g., through your own reverse proxy with SSL). > Running without Caddy means you lose the built-in secure publishing experience, including automatic SSL certificates and the recommended reverse proxy setup. If you choose this option, make sure you provide your own secure exposure layer.
3.**Create the `.env` File:** 3.**Create the `.env` File:**
Create a `.env` file in the same directory as your `docker-compose.yml` with the following content, adjusting `my_server_address` to your server's DNS name or IP address. This step is crucial for ensuring the application functions correctly. Create a `.env` file in the same directory as your `docker-compose.yml`, adjusting `my_server_address` to your server's DNS name or IP address. This step is crucial for ensuring the application functions correctly.
```env ```env
# Configure SERVER_ADDRESS to match the address of the server. If you don't have a DNS name, you can use the IP address. # Configure SERVER_ADDRESS to match the address of the server. If you don't have a DNS name, you can use the IP address.
@@ -146,7 +149,7 @@ This mode is recommended for running the web admin interface. The container depl
docker compose up -d docker compose up -d
``` ```
Access the web interface using `https://yourserver.example.com`. If you are using a self-signed certificate, you must accept the certificate exception that your browser will present. Access the web interface using `https://yourserver.example.com`. When using the recommended Caddy deployment, SSL certificates are obtained and renewed automatically.
After completing these steps, your WireGuard WebAdmin should be up and running. Begin the configuration by accessing your server's web interface. After completing these steps, your WireGuard WebAdmin should be up and running. Begin the configuration by accessing your server's web interface.
@@ -194,7 +197,7 @@ Upgrading your WireGuard WebAdmin installation ensures you have access to the la
Follow the previously outlined [Deployment Instructions](#deployment-instructions). Follow the previously outlined [Deployment Instructions](#deployment-instructions).
Don't forget to update the `docker-compose.yml` file to the latest version by re-downloading it from the repository. Don't forget to update your compose file to the latest version by re-downloading it from the repository.
### Post-Upgrade Checks: ### Post-Upgrade Checks:

23
docs/README.de.md
View File

@@ -85,28 +85,31 @@ Folge diesen Schritten, um WireGuard WebAdmin bereitzustellen:
2. **Docker‑Compose‑Datei herunterladen** 2. **Docker‑Compose‑Datei herunterladen**
Wähle je nach Szenario einen der folgenden Befehle, um die passende `docker-compose.yml` herunterzuladen. So nutzt du stets die aktuelle Version der Deployment‑Datei. Wähle je nach Szenario einen der folgenden Befehle, um die passende Compose-Datei herunterzuladen. So nutzt du stets die aktuelle Version der Deployment-Datei.
### Option 1: Mit NGINX (empfohlen) ### Option 1: Mit Caddy (empfohlen)
Für eine produktionsreife Bereitstellung mit NGINX als Reverse‑Proxy (empfohlen): Für das empfohlene produktive Deployment mit Caddy als Reverse-Proxy:
```bash ```bash
wget -O docker-compose.yml https://raw.githubusercontent.com/eduardogsilva/wireguard_webadmin/main/docker-compose.yml wget -O docker-compose.yml https://raw.githubusercontent.com/eduardogsilva/wireguard_webadmin/main/docker-compose-caddy.yml
``` ```
Im Standard generiert der Container ein selbstsigniertes Zertifikat. Eigene Zertifikate können durch Ersetzen von `nginx.pem` und `nginx.key` im Volume `certificates` hinterlegt werden. Dies ist die empfohlene Methode zum Betrieb der Web-Administrationsoberfläche, da sie alle unterstützten Reverse-Proxy-Funktionen umfasst und eine automatische SSL-Zertifikatsverwaltung über Caddy bietet.
### Option 2: Ohne NGINX > [!IMPORTANT]
> Caddy benötigt einen gültigen DNS-Namen, intern oder öffentlich, der auf Ihren Server zeigt, damit SSL-Zertifikate korrekt ausgestellt und erneuert werden können.
Wenn Sie Ihren eigenen Reverse-Proxy verwenden oder das System ohne einen solchen betreiben möchten, nutzen Sie: ### Option 2: Ohne Caddy
Wenn Sie Ihren eigenen Reverse-Proxy verwenden oder die Anwendung ohne Caddy betreiben möchten, nutzen Sie:
```bash ```bash
wget -O docker-compose.yml https://raw.githubusercontent.com/eduardogsilva/wireguard_webadmin/main/docker-compose-no-nginx.yml wget -O docker-compose.yml https://raw.githubusercontent.com/eduardogsilva/wireguard_webadmin/main/docker-compose-no-caddy.yml
``` ```
> [!CAUTION] > [!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). > Wenn Sie die Anwendung ohne Caddy betreiben, verlieren Sie die integrierte sichere Veröffentlichung, einschließlich automatischer SSL-Zertifikate und des empfohlenen Reverse-Proxy-Setups. Wenn Sie diese Option wählen, müssen Sie selbst für eine sichere Veröffentlichung sorgen.
3. **.env‑Datei erstellen** 3. **.env‑Datei erstellen**
@@ -149,7 +152,7 @@ Folge diesen Schritten, um WireGuard WebAdmin bereitzustellen:
docker compose up -d docker compose up -d
``` ```
Web‑Interface unter `https://yourserver.example.com` öffnen. Bei selbstsigniertem Zertifikat muss die Ausnahme akzeptiert werden. Öffnen Sie die Weboberfläche unter `https://yourserver.example.com`. Beim empfohlenen Deployment mit Caddy werden SSL-Zertifikate automatisch ausgestellt und erneuert.
Nach diesen Schritten sollte WireGuard WebAdmin laufen. Konfiguriere anschließend deine Instanzen über das Web‑Interface. Nach diesen Schritten sollte WireGuard WebAdmin laufen. Konfiguriere anschließend deine Instanzen über das Web‑Interface.

24
docs/README.es.md
View File

@@ -81,28 +81,31 @@ Siga estos pasos para desplegar WireGuard WebAdmin:
2. **Obtenga el Archivo Docker Compose:** 2. **Obtenga el Archivo Docker Compose:**
Según su escenario de despliegue, elija uno de los siguientes comandos para descargar el archivo `docker-compose.yml` correspondiente directamente en su directorio de trabajo. Este método garantiza que utilice la versión más reciente de la configuración. Según su escenario de despliegue, elija uno de los siguientes comandos para descargar el archivo compose correspondiente directamente en su directorio de trabajo. Este método garantiza que utilice la versión más reciente de la configuración.
### Opción 1: Con NGINX (Recomendado) ### Opción 1: Con Caddy (Recomendado)
Para un despliegue de producción con NGINX como *reverse proxy* (recomendado para la mayoría), use: Para el despliegue de producción recomendado con Caddy como *reverse proxy*, use:
```bash ```bash
wget -O docker-compose.yml https://raw.githubusercontent.com/eduardogsilva/wireguard_webadmin/main/docker-compose.yml wget -O docker-compose.yml https://raw.githubusercontent.com/eduardogsilva/wireguard_webadmin/main/docker-compose-caddy.yml
``` ```
Este modo es el recomendado para ejecutar la interfaz web de administración. El despliegue del contenedor generará automáticamente un certificado autofirmado para usted. Si desea actualizar sus certificados, acceda al volumen `certificates` y sustituya `nginx.pem` y `nginx.key` por sus propios certificados. Esta es la forma recomendada de ejecutar la interfaz web de administración porque incluye todas las funciones compatibles del proxy inverso y proporciona gestión automática de certificados SSL mediante Caddy.
### Opción 2: Sin NGINX > [!IMPORTANT]
> Caddy requiere un nombre DNS válido, interno o público, apuntando a su servidor para poder obtener y renovar correctamente los certificados SSL.
Si prefiere usar su propio proxy inverso o ejecutar el sistema sin uno, use: ### Opción 2: Sin Caddy
Si prefiere usar su propio proxy inverso o ejecutar la aplicación sin Caddy, use:
```bash ```bash
wget -O docker-compose.yml https://raw.githubusercontent.com/eduardogsilva/wireguard_webadmin/main/docker-compose-no-nginx.yml wget -O docker-compose.yml https://raw.githubusercontent.com/eduardogsilva/wireguard_webadmin/main/docker-compose-no-caddy.yml
``` ```
> [!CAUTION] > [!CAUTION]
> No se recomienda servir el sistema sin HTTPS (NGINX) debido a riesgos de seguridad. Si elige esta opción, asegúrese de utilizar una conexión segura (por ejemplo, a través de su propio proxy inverso con SSL). > Ejecutar sin Caddy significa perder la experiencia integrada de publicación segura, incluidos los certificados SSL automáticos y la configuración recomendada de proxy inverso. Si elige esta opción, asegúrese de proporcionar su propia capa segura de exposición.
3. **Cree el Archivo `.env`:** 3. **Cree el Archivo `.env`:**
@@ -147,7 +150,7 @@ Siga estos pasos para desplegar WireGuard WebAdmin:
docker compose up -d docker compose up -d
``` ```
Acceda a la interfaz web en `https://suserver.ejemplo.com`. Si utiliza un certificado autofirmado, acepte la excepción de seguridad en su navegador. Acceda a la interfaz web en `https://suserver.ejemplo.com`. Al usar el despliegue recomendado con Caddy, los certificados SSL se obtienen y renuevan automáticamente.
Tras completar estos pasos, WireGuard WebAdmin estará en funcionamiento. Comience la configuración accediendo a la interfaz web de su servidor. Tras completar estos pasos, WireGuard WebAdmin estará en funcionamiento. Comience la configuración accediendo a la interfaz web de su servidor.
@@ -215,4 +218,3 @@ Las contribuciones hacen que la comunidad *open‑source* sea un lugar increíbl
## Soporte ## Soporte
Si encuentra problemas o necesita ayuda, abra un *issue* en la página de GitHub del proyecto. Si encuentra problemas o necesita ayuda, abra un *issue* en la página de GitHub del proyecto.

24
docs/README.fr.md
View File

@@ -79,26 +79,31 @@ Suivez ces étapes pour déployer WireGuard WebAdmin:
2. **Télécharger le fichier Docker Compose** 2. **Télécharger le fichier Docker Compose**
Choisissez l’une des commandes suivantes pour récupérer la dernière version du `docker-compose.yml` directement depuis le dépôt GitHub. Choisissez l’une des commandes suivantes pour télécharger le fichier compose approprié directement dans votre répertoire de travail. Cela vous garantit d’utiliser la version la plus récente de la configuration de déploiement.
### Option 1 : Avec NGINX (recommandé) ### Option 1 : Avec Caddy (recommandé)
Pour le déploiement de production recommandé avec Caddy comme proxy inverse, utilisez :
```bash ```bash
wget -O docker-compose.yml https://raw.githubusercontent.com/eduardogsilva/wireguard_webadmin/main/docker-compose.yml wget -O docker-compose.yml https://raw.githubusercontent.com/eduardogsilva/wireguard_webadmin/main/docker-compose-caddy.yml
``` ```
Ce mode est recommandé pour exécuter l’interface web. Le déploiement générera automatiquement un certificat auto‑signé. Pour utiliser vos propres certificats, remplacez `nginx.pem` et `nginx.key` dans le volume `certificates`. C’est la manière recommandée d’exécuter l’interface d’administration web, car elle inclut toutes les fonctionnalités prises en charge du proxy inverse et fournit une gestion automatique des certificats SSL via Caddy.
### Option 2 : Sans NGINX > [!IMPORTANT]
> Caddy nécessite un nom DNS valide, interne ou public, pointant vers votre serveur afin de pouvoir obtenir et renouveler correctement les certificats SSL.
Si vous préférez utiliser votre propre proxy inverse ou exécuter le système sans proxy, utilisez : ### Option 2 : Sans Caddy
Si vous préférez utiliser votre propre proxy inverse ou exécuter l’application sans Caddy, utilisez :
```bash ```bash
wget -O docker-compose.yml https://raw.githubusercontent.com/eduardogsilva/wireguard_webadmin/main/docker-compose-no-nginx.yml wget -O docker-compose.yml https://raw.githubusercontent.com/eduardogsilva/wireguard_webadmin/main/docker-compose-no-caddy.yml
``` ```
> [!CAUTION] > [!CAUTION]
> Il n'est pas recommandé de servir le système sans HTTPS (NGINX) en raison de risques de sécurité. Si vous choisissez cette option, assurez-vous d'utiliser une connexion sécurisée (par exemple, via votre propre proxy inverse avec SSL). > Exécuter l’application sans Caddy signifie perdre l’expérience intégrée de publication sécurisée, y compris les certificats SSL automatiques et la configuration de proxy inverse recommandée. Si vous choisissez cette option, assurez-vous de fournir votre propre couche d’exposition sécurisée.
3. **Créer le fichier `.env`** 3. **Créer le fichier `.env`**
@@ -143,7 +148,7 @@ Suivez ces étapes pour déployer WireGuard WebAdmin:
docker compose up -d docker compose up -d
``` ```
Accédez à l’interface via `https://votreserveur.exemple.com`. Avec un certificat auto‑signé, votre navigateur demandera une exception. Accédez à l’interface via `https://votreserveur.exemple.com`. Avec le déploiement recommandé utilisant Caddy, les certificats SSL sont obtenus et renouvelés automatiquement.
Après ces étapes, WireGuard WebAdmin sera opérationnel. Après ces étapes, WireGuard WebAdmin sera opérationnel.
@@ -193,4 +198,3 @@ Les contributions sont **grandement appréciées**! Rejoignez‑nous pour améli
## Support ## Support
En cas de problème, ouvrez une *issue* sur la page GitHub du projet. En cas de problème, ouvrez une *issue* sur la page GitHub du projet.

23
docs/README.pt-br.md
View File

@@ -81,28 +81,31 @@ Siga estes passos para implantar o WireGuard WebAdmin:
2. **Obtenha o Arquivo Docker Compose:** 2. **Obtenha o Arquivo Docker Compose:**
Dependendo do seu cenário de implantação, escolha um dos comandos a seguir para baixar o arquivo `docker-compose.yml` apropriado diretamente no seu diretório de trabalho. Esse método garante que você está usando a versão mais recente da configuração de implantação. Dependendo do seu cenário de implantação, escolha um dos comandos a seguir para baixar o arquivo compose apropriado diretamente no seu diretório de trabalho. Esse método garante que você está usando a versão mais recente da configuração de implantação.
### Opção 1: Com NGINX (Recomendado) ### Opção 1: Com Caddy (Recomendado)
Para uma implantação pronta para produção com NGINX como *reverse proxy* (recomendado para a maioria dos usuários), use: Para a implantação recomendada em produção com Caddy como *reverse proxy*, use:
```bash ```bash
wget -O docker-compose.yml https://raw.githubusercontent.com/eduardogsilva/wireguard_webadmin/main/docker-compose.yml wget -O docker-compose.yml https://raw.githubusercontent.com/eduardogsilva/wireguard_webadmin/main/docker-compose-caddy.yml
``` ```
Este modo é recomendado para executar a interface web de administração. O *deployment* do contêiner gerará automaticamente um certificado autoassinado para você. Se desejar atualizar seus certificados, basta acessar o volume `certificates` e substituir `nginx.pem` e `nginx.key` pelos seus próprios certificados. Esta é a forma recomendada de executar a interface web de administração, pois inclui todos os recursos suportados de proxy reverso e oferece gerenciamento automático de certificados SSL através do Caddy.
### Opção 2: Sem NGINX > [!IMPORTANT]
> O Caddy precisa de um nome DNS válido, interno ou público, apontando para o seu servidor para obter e renovar os certificados SSL corretamente.
Se você preferir usar seu próprio proxy reverso ou rodar sem um, use: ### Opção 2: Sem Caddy
Se você preferir usar seu próprio proxy reverso ou executar a aplicação sem o Caddy, use:
```bash ```bash
wget -O docker-compose.yml https://raw.githubusercontent.com/eduardogsilva/wireguard_webadmin/main/docker-compose-no-nginx.yml wget -O docker-compose.yml https://raw.githubusercontent.com/eduardogsilva/wireguard_webadmin/main/docker-compose-no-caddy.yml
``` ```
> [!CAUTION] > [!CAUTION]
> Não é recomendado servir o sistema sem HTTPS (NGINX) devido a riscos de segurança. Se optar por esta opção, certifique-se de estar utilizando uma conexão segura (ex: através de seu próprio proxy reverso com SSL). > Executar sem o Caddy significa perder a experiência integrada de publicação segura, incluindo certificados SSL automáticos e a configuração recomendada de proxy reverso. Se optar por esta opção, garanta sua própria camada segura de exposição.
3. **Crie o Arquivo `.env`:** 3. **Crie o Arquivo `.env`:**
@@ -147,7 +150,7 @@ Siga estes passos para implantar o WireGuard WebAdmin:
docker compose up -d docker compose up -d
``` ```
Acesse a interface web em `https://seuservidor.exemplo.com`. Se estiver usando um certificado autoassinado, será necessário aceitar a exceção de certificado apresentada pelo navegador. Acesse a interface web em `https://seuservidor.exemplo.com`. Ao usar a implantação recomendada com Caddy, os certificados SSL são obtidos e renovados automaticamente.
Após concluir esses passos, o WireGuard WebAdmin deverá estar em execução. Inicie a configuração acessando a interface web do seu servidor. Após concluir esses passos, o WireGuard WebAdmin deverá estar em execução. Inicie a configuração acessando a interface web do seu servidor.