mirror of
https://github.com/eduardogsilva/wireguard_webadmin.git
synced 2026-01-01 06:16:16 +00:00
streamline deploy instructions for NGINX/non-NGINX options and simplify upgrade steps
This commit is contained in:
Eduardo Silva
@@ -79,58 +79,59 @@ Folge diesen Schritten, um WireGuard WebAdmin bereitzustellen:
|
||||
|
||||
```bash
|
||||
mkdir wireguard_webadmin && cd wireguard_webadmin
|
||||
```
|
||||
1. **Umgebung vorbereiten**
|
||||
|
||||
2. **Docker‑Compose‑Datei herunterladen**
|
||||
Erstelle zunächst ein Verzeichnis für WireGuard WebAdmin und wechsle hinein:
|
||||
|
||||
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.
|
||||
```bash
|
||||
mkdir wireguard_webadmin && cd wireguard_webadmin
|
||||
```
|
||||
|
||||
### Mit NGINX (empfohlen)
|
||||
2. **Docker‑Compose‑Datei herunterladen**
|
||||
|
||||
Für eine produktionsreife Bereitstellung mit NGINX als Reverse‑Proxy (empfohlen):
|
||||
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.
|
||||
|
||||
```bash
|
||||
wget -O docker-compose.yml https://raw.githubusercontent.com/eduardogsilva/wireguard_webadmin/main/docker-compose.yml
|
||||
```
|
||||
### Option 1: Mit NGINX (empfohlen)
|
||||
|
||||
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.
|
||||
Für eine produktionsreife Bereitstellung mit NGINX als Reverse‑Proxy (empfohlen):
|
||||
|
||||
### Ohne NGINX (nur Debug/Test)
|
||||
```bash
|
||||
wget -O docker-compose.yml https://raw.githubusercontent.com/eduardogsilva/wireguard_webadmin/main/docker-compose.yml
|
||||
```
|
||||
|
||||
Für eine reine Testumgebung ohne NGINX (nicht für Produktion empfohlen):
|
||||
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.
|
||||
|
||||
```bash
|
||||
wget -O docker-compose.yml https://raw.githubusercontent.com/eduardogsilva/wireguard_webadmin/main/docker-compose-no-nginx.yml
|
||||
```
|
||||
### Option 2: Ohne NGINX
|
||||
|
||||
3. **`.env`‑Datei erstellen**
|
||||
Wenn Sie Ihren eigenen Reverse-Proxy verwenden oder das System ohne einen solchen betreiben möchten, nutzen Sie:
|
||||
|
||||
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:
|
||||
```bash
|
||||
wget -O docker-compose.yml https://raw.githubusercontent.com/eduardogsilva/wireguard_webadmin/main/docker-compose-no-nginx.yml
|
||||
```
|
||||
|
||||
```env
|
||||
# SERVER_ADDRESS muss auf den Server zeigen. Ohne DNS‑Namen kann die IP genutzt werden.
|
||||
# Ein falsch konfigurierter SERVER_ADDRESS führt zu CSRF‑Fehlern.
|
||||
SERVER_ADDRESS=my_server_address
|
||||
DEBUG_MODE=False
|
||||
```
|
||||
> [!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).
|
||||
|
||||
4. **Docker Compose ausführen**
|
||||
3. **`.env`‑Datei erstellen**
|
||||
|
||||
### Mit NGINX (empfohlen)
|
||||
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:
|
||||
|
||||
```bash
|
||||
docker compose up -d
|
||||
```
|
||||
```env
|
||||
# SERVER_ADDRESS muss auf den Server zeigen. Ohne DNS‑Namen kann die IP genutzt werden.
|
||||
# Ein falsch konfigurierter SERVER_ADDRESS führt zu CSRF‑Fehlern.
|
||||
SERVER_ADDRESS=my_server_address
|
||||
DEBUG_MODE=False
|
||||
```
|
||||
|
||||
Web‑Interface unter `https://yourserver.example.com` öffnen. Bei selbstsigniertem Zertifikat muss die Ausnahme akzeptiert werden.
|
||||
4. **Docker Compose ausführen**
|
||||
|
||||
Führen Sie den Docker Compose-Befehl aus, um Ihr Deployment zu starten:
|
||||
|
||||
### Ohne NGINX (nur Debug/Test)
|
||||
|
||||
```bash
|
||||
docker compose -f docker-compose-no-nginx.yml up -d
|
||||
```
|
||||
|
||||
Web‑Interface unter `http://127.0.0.1:8000` öffnen.
|
||||
```bash
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
Web‑Interface unter `https://yourserver.example.com` öffnen. Bei selbstsigniertem Zertifikat muss die Ausnahme akzeptiert werden.
|
||||
|
||||
Nach diesen Schritten sollte WireGuard WebAdmin laufen. Konfiguriere anschließend deine Instanzen über das Web‑Interface.
|
||||
|
||||
@@ -140,15 +141,11 @@ Regelmäßige Upgrades stellen sicher, dass du die neuesten Funktionen, Sicherhe
|
||||
|
||||
### Vorbereitung
|
||||
|
||||
1. **Vom Git‑Clone‑Workflow umsteigen**
|
||||
|
||||
```bash
|
||||
cd /pfad/zu/wireguard_webadmin
|
||||
```
|
||||
Befindet sich deine Installation in einem Git‑Clone‑Verzeichnis, wechsle dorthin:
|
||||
```bash
|
||||
cd /pfad/zu/wireguard_webadmin_git_clone
|
||||
```
|
||||
1. **In das Projektverzeichnis wechseln**
|
||||
|
||||
```bash
|
||||
cd wireguard_webadmin
|
||||
```
|
||||
|
||||
2. **Dienste stoppen**
|
||||
|
||||
|
||||
@@ -81,23 +81,26 @@ Siga estos pasos para desplegar WireGuard WebAdmin:
|
||||
|
||||
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.
|
||||
|
||||
### Con NGINX (Recomendado)
|
||||
|
||||
Para un despliegue de producción con NGINX como *reverse proxy* (recomendado para la mayoría), use:
|
||||
|
||||
```bash
|
||||
wget -O docker-compose.yml https://raw.githubusercontent.com/eduardogsilva/wireguard_webadmin/main/docker-compose.yml
|
||||
```
|
||||
|
||||
Este modo es el recomendado para ejecutar la interfaz web de administración. El despliegue del contenedor generará automáticamente un certificado autofirmado. Si desea actualizar sus certificados, acceda al volumen `certificates` y sustituya `nginx.pem` y `nginx.key` por sus propios certificados.
|
||||
|
||||
### Sin NGINX (Solo para Depuración y Pruebas)
|
||||
|
||||
Para un entorno de depuración sin NGINX (no recomendado en producción), use:
|
||||
|
||||
```bash
|
||||
wget -O docker-compose.yml https://raw.githubusercontent.com/eduardogsilva/wireguard_webadmin/main/docker-compose-no-nginx.yml
|
||||
```
|
||||
### Opción 1: Con NGINX (Recomendado)
|
||||
|
||||
Para un despliegue de producción con NGINX como *reverse proxy* (recomendado para la mayoría), use:
|
||||
|
||||
```bash
|
||||
wget -O docker-compose.yml https://raw.githubusercontent.com/eduardogsilva/wireguard_webadmin/main/docker-compose.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.
|
||||
|
||||
### Opción 2: Sin NGINX
|
||||
|
||||
Si prefiere usar su propio proxy inverso o ejecutar el sistema sin uno, use:
|
||||
|
||||
```bash
|
||||
wget -O docker-compose.yml https://raw.githubusercontent.com/eduardogsilva/wireguard_webadmin/main/docker-compose-no-nginx.yml
|
||||
```
|
||||
|
||||
> [!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).
|
||||
|
||||
3. **Cree el Archivo `.env`:**
|
||||
|
||||
@@ -113,24 +116,14 @@ Siga estos pasos para desplegar WireGuard WebAdmin:
|
||||
Sustituya `my_server_address` por la dirección real de su servidor.
|
||||
|
||||
4. **Ejecute Docker Compose:**
|
||||
|
||||
### Con NGINX (Recomendado)
|
||||
|
||||
```bash
|
||||
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.
|
||||
|
||||
### Sin NGINX (Solo para Depuración y Pruebas)
|
||||
|
||||
Si eligió la configuración sin NGINX, ejecute el archivo descargado `docker-compose-no-nginx.yml`:
|
||||
|
||||
```bash
|
||||
docker compose -f docker-compose-no-nginx.yml up -d
|
||||
```
|
||||
|
||||
Acceda a la interfaz en `http://127.0.0.1:8000`.
|
||||
|
||||
Ejecute el comando Docker Compose para iniciar su despliegue.
|
||||
|
||||
```bash
|
||||
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.
|
||||
|
||||
Tras completar estos pasos, WireGuard WebAdmin estará en funcionamiento. Comience la configuración accediendo a la interfaz web de su servidor.
|
||||
|
||||
@@ -142,19 +135,13 @@ Actualizar su instalación de WireGuard WebAdmin garantiza acceso a nuevas funci
|
||||
|
||||
### Preparación para la Actualización:
|
||||
|
||||
1. **Transición desde un flujo de trabajo *git clone*:**
|
||||
|
||||
Acceda al directorio `wireguard_webadmin`:
|
||||
|
||||
```bash
|
||||
cd path/to/wireguard_webadmin
|
||||
```
|
||||
|
||||
Si actualiza desde una instalación realizada con *git clone*, vaya al directorio del proyecto:
|
||||
|
||||
```bash
|
||||
cd /path/to/wireguard_webadmin_git_clone
|
||||
```
|
||||
1. **Vaya al Directorio del Proyecto:**
|
||||
|
||||
Acceda al directorio `wireguard_webadmin`:
|
||||
|
||||
```bash
|
||||
cd wireguard_webadmin
|
||||
```
|
||||
|
||||
2. **Detenga los Servicios:**
|
||||
|
||||
|
||||
@@ -79,19 +79,24 @@ Suivez ces étapes pour déployer WireGuard WebAdmin:
|
||||
|
||||
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.
|
||||
|
||||
### Avec NGINX (recommandé)
|
||||
|
||||
```bash
|
||||
wget -O docker-compose.yml https://raw.githubusercontent.com/eduardogsilva/wireguard_webadmin/main/docker-compose.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`.
|
||||
|
||||
### Sans NGINX (mode debug/test uniquement)
|
||||
|
||||
```bash
|
||||
wget -O docker-compose.yml https://raw.githubusercontent.com/eduardogsilva/wireguard_webadmin/main/docker-compose-no-nginx.yml
|
||||
```
|
||||
### Option 1 : Avec NGINX (recommandé)
|
||||
|
||||
```bash
|
||||
wget -O docker-compose.yml https://raw.githubusercontent.com/eduardogsilva/wireguard_webadmin/main/docker-compose.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`.
|
||||
|
||||
### Option 2 : Sans NGINX
|
||||
|
||||
Si vous préférez utiliser votre propre proxy inverse ou exécuter le système sans proxy, utilisez :
|
||||
|
||||
```bash
|
||||
wget -O docker-compose.yml https://raw.githubusercontent.com/eduardogsilva/wireguard_webadmin/main/docker-compose-no-nginx.yml
|
||||
```
|
||||
|
||||
> [!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).
|
||||
|
||||
3. **Créer le fichier `.env`**
|
||||
|
||||
@@ -106,23 +111,15 @@ Suivez ces étapes pour déployer WireGuard WebAdmin:
|
||||
|
||||
Remplacez `my_server_address` par l’adresse réelle de votre serveur.
|
||||
|
||||
4. **Lancer Docker Compose**
|
||||
|
||||
#### Avec NGINX (recommandé)
|
||||
|
||||
```bash
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
Accédez à l’interface via `https://votreserveur.exemple.com`. Avec un certificat auto‑signé, votre navigateur demandera une exception.
|
||||
|
||||
#### Sans NGINX (mode debug/test)
|
||||
|
||||
```bash
|
||||
docker compose -f docker-compose-no-nginx.yml up -d
|
||||
```
|
||||
|
||||
Accédez à l’interface via `http://127.0.0.1:8000`.
|
||||
4. **Lancer Docker Compose**
|
||||
|
||||
Exécutez la commande Docker Compose pour démarrer votre déploiement.
|
||||
|
||||
```bash
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
Accédez à l’interface via `https://votreserveur.exemple.com`. Avec un certificat auto‑signé, votre navigateur demandera une exception.
|
||||
|
||||
Après ces étapes, WireGuard WebAdmin sera opérationnel.
|
||||
|
||||
@@ -130,11 +127,11 @@ Après ces étapes, WireGuard WebAdmin sera opérationnel.
|
||||
|
||||
Pour profiter des dernières fonctionnalités et correctifs:
|
||||
|
||||
1. **Si vous utilisiez un clone Git**
|
||||
|
||||
```bash
|
||||
cd /chemin/vers/wireguard_webadmin_git_clone
|
||||
```
|
||||
1. **Allez dans le répertoire du projet**
|
||||
|
||||
```bash
|
||||
cd wireguard_webadmin
|
||||
```
|
||||
|
||||
2. **Arrêter les services**
|
||||
|
||||
|
||||
@@ -81,23 +81,26 @@ Siga estes passos para implantar o WireGuard WebAdmin:
|
||||
|
||||
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.
|
||||
|
||||
### Com NGINX (Recomendado)
|
||||
|
||||
Para uma implantação pronta para produção com NGINX como *reverse proxy* (recomendado para a maioria dos usuários), use:
|
||||
|
||||
```bash
|
||||
wget -O docker-compose.yml https://raw.githubusercontent.com/eduardogsilva/wireguard_webadmin/main/docker-compose.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.
|
||||
|
||||
### Sem NGINX (Somente para Debug e Testes)
|
||||
|
||||
Para um ambiente de depuração sem NGINX, adequado apenas para testes (não recomendado em produção), use:
|
||||
|
||||
```bash
|
||||
wget -O docker-compose.yml https://raw.githubusercontent.com/eduardogsilva/wireguard_webadmin/main/docker-compose-no-nginx.yml
|
||||
```
|
||||
### Opção 1: Com NGINX (Recomendado)
|
||||
|
||||
Para uma implantação pronta para produção com NGINX como *reverse proxy* (recomendado para a maioria dos usuários), use:
|
||||
|
||||
```bash
|
||||
wget -O docker-compose.yml https://raw.githubusercontent.com/eduardogsilva/wireguard_webadmin/main/docker-compose.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.
|
||||
|
||||
### Opção 2: Sem NGINX
|
||||
|
||||
Se você preferir usar seu próprio proxy reverso ou rodar sem um, use:
|
||||
|
||||
```bash
|
||||
wget -O docker-compose.yml https://raw.githubusercontent.com/eduardogsilva/wireguard_webadmin/main/docker-compose-no-nginx.yml
|
||||
```
|
||||
|
||||
> [!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).
|
||||
|
||||
3. **Crie o Arquivo `.env`:**
|
||||
|
||||
@@ -112,25 +115,15 @@ Siga estes passos para implantar o WireGuard WebAdmin:
|
||||
|
||||
Substitua `my_server_address` pelo endereço real do seu servidor.
|
||||
|
||||
4. **Execute o Docker Compose:**
|
||||
4. **Execute o Docker Compose:**
|
||||
|
||||
Execute o comando Docker Compose para iniciar sua implantação.
|
||||
|
||||
### Com NGINX (Recomendado)
|
||||
|
||||
```bash
|
||||
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.
|
||||
|
||||
### Sem NGINX (Somente para Debug e Testes)
|
||||
|
||||
Caso tenha optado pela configuração sem NGINX, simplesmente execute o arquivo `docker-compose-no-nginx.yml` obtido anteriormente:
|
||||
|
||||
```bash
|
||||
docker compose -f docker-compose-no-nginx.yml up -d
|
||||
```
|
||||
|
||||
Acesse a interface web em `http://127.0.0.1:8000`.
|
||||
```bash
|
||||
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.
|
||||
|
||||
Após concluir esses passos, o WireGuard WebAdmin deverá estar em execução. Inicie a configuração acessando a interface web do seu servidor.
|
||||
|
||||
@@ -142,19 +135,13 @@ Manter sua instalação do WireGuard WebAdmin atualizada garante acesso aos recu
|
||||
|
||||
### Preparação para o Upgrade:
|
||||
|
||||
1. **Transição de um Workflow *git clone*:**
|
||||
|
||||
Navegue até o diretório `wireguard_webadmin`:
|
||||
|
||||
```bash
|
||||
cd path/to/wireguard_webadmin
|
||||
```
|
||||
|
||||
Se estiver atualizando a partir de uma instalação existente via *git clone*, navegue até o diretório do projeto atual.
|
||||
|
||||
```bash
|
||||
cd /path/to/wireguard_webadmin_git_clone
|
||||
```
|
||||
1. **Navegue até o Diretório do Projeto:**
|
||||
|
||||
Navegue até o diretório `wireguard_webadmin`:
|
||||
|
||||
```bash
|
||||
cd wireguard_webadmin
|
||||
```
|
||||
|
||||
2. **Desligue os Serviços:**
|
||||
|
||||
|
||||
Reference in New Issue
Block a user