wg easy Télécharger - wg easy Téléchargement du code source

wg easy

Autre code source

v14.0.0

Télécharger

WireGuard Facile

Créer et publier une image Docker sur Docker Hub Peluche

Vous avez trouvé le moyen le plus simple d'installer et de gérer WireGuard sur n'importe quel hôte Linux !

Caractéristiques

Tout-en-un : WireGuard + interface utilisateur Web.
Installation facile, simple à utiliser.
Répertoriez, créez, modifiez, supprimez, activez et désactivez les clients.
Afficher le code QR d'un client.
Téléchargez le fichier de configuration d'un client.
Statistiques pour lesquelles les clients sont connectés.
Graphiques Tx/Rx pour chaque client connecté.
Prise en charge de Gravatar.
Mode lumière/obscurité automatique
Prise en charge multilingue
Statistiques de trafic (désactivé par défaut)
Liens uniques (désactivés par défaut)
Expiration du client (désactivé par défaut)
Prise en charge des métriques Prometheus

Exigences

Un hôte avec un noyau prenant en charge WireGuard (tous les noyaux modernes).
Un hôte avec Docker installé.

Versions

Pour la version stable , veuillez lire les instructions sur la branche production !

Nous fournissons plus d'une balise d'image Docker, ce qui suit vous aidera à décider laquelle vous convient le mieux.

étiqueter	Bifurquer	Exemple	Description
`latest`	`production`	`ghcr.io/wg-easy/wg-easy:latest` ou `ghcr.io/wg-easy/wg-easy`	stable autant que possible, obtenez des corrections de bogues rapidement en cas de besoin, déployées en `production` .
`14`	`production`	`ghcr.io/wg-easy/wg-easy:14`	comme le dernier, respectez une balise de version.
`nightly`	`master`	`ghcr.io/wg-easy/wg-easy:nightly`	la plupart du temps, unstable reçoit des mises à jour fréquentes des packages et du code, déployées sur `master` .
`development`	demandes de tirage	`ghcr.io/wg-easy/wg-easy:development`	utilisé pour le développement, testant le code des PR avant d'atterrir dans `master` .

Installation

1. Installez Docker

Si vous n'avez pas encore installé Docker, installez-le en exécutant :

curl -sSL https://get.docker.com | sh
sudo usermod -aG docker $( whoami )
exit

Et reconnectez-vous.

2. Exécutez WireGuard Easy

Pour installer et exécuter automatiquement wg-easy, exécutez simplement :

docker run --detach 
  --name wg-easy 
  --env LANG=de 
  --env WG_HOST= < YOUR_SERVER_IP > 
  --env PASSWORD_HASH= ' <YOUR_ADMIN_PASSWORD_HASH> ' 
  --env PORT=51821 
  --env WG_PORT=51820 
  --volume ~ /.wg-easy:/etc/wireguard 
  --publish 51820:51820/udp 
  --publish 51821:51821/tcp 
  --cap-add NET_ADMIN 
  --cap-add SYS_MODULE 
  --sysctl ' net.ipv4.conf.all.src_valid_mark=1 ' 
  --sysctl ' net.ipv4.ip_forward=1 ' 
  --restart unless-stopped 
  ghcr.io/wg-easy/wg-easy

Remplacez <YOUR_SERVER_IP> par votre adresse IP WAN ou un nom d'hôte DNS dynamique.
Remplacez <YOUR_ADMIN_PASSWORD_HASH> par un hachage de mot de passe bcrypt pour vous connecter à l'interface utilisateur Web. Voir How_to_generate_an_bcrypt_hash.md pour obtenir des instructions sur la façon de générer un mot de passe haché.

L'interface utilisateur Web sera désormais disponible sur http://0.0.0.0:51821 .

Les métriques Prometheus seront désormais disponibles sur http://0.0.0.0:51821/metrics . Tableau de bord Grafana 21733

Vos fichiers de configuration seront enregistrés dans ~/.wg-easy

WireGuard Easy peut également être lancé avec Docker Compose - téléchargez simplement docker-compose.yml , effectuez les ajustements nécessaires et exécutez docker compose up --detach .

3. Parrainer

Aimez-vous ce projet? Achetez une bière à Emile ! ?
Don au composant principal : WireGuard

Possibilités

Ces options peuvent être configurées en définissant des variables d'environnement à l'aide -e KEY="VALUE" dans la commande docker run .

Env.	Défaut	Exemple	Description
`PORT`	`51821`	`6789`	Port TCP pour l'interface utilisateur Web.
`WEBUI_HOST`	`0.0.0.0`	`localhost`	Adresse IP à laquelle l’interface utilisateur Web se lie.
`PASSWORD_HASH`	-	`$2y$05$Ci...`	Lorsqu'il est défini, nécessite un mot de passe lors de la connexion à l'interface utilisateur Web. Voir Comment générer un hash.md bcrypt pour savoir comment générer le hachage.
`WG_HOST`	-	`vpn.myserver.com`	Le nom d'hôte public de votre serveur VPN.
`WG_DEVICE`	`eth0`	`ens6f0`	Périphérique Ethernet par lequel le trafic Wireguard doit être transféré.
`WG_PORT`	`51820`	`12345`	Le port UDP public de votre serveur VPN. WireGuard écoutera cela (sinon par défaut) à l'intérieur du conteneur Docker.
`WG_CONFIG_PORT`	`51820`	`12345`	Le port UDP utilisé sur le plugin Home Assistant
`WG_MTU`	`null`	`1420`	La MTU que les clients utiliseront. Le serveur utilise le MTU WG par défaut.
`WG_PERSISTENT_KEEPALIVE`	`0`	`25`	Valeur en secondes pour garder la « connexion » ouverte. Si cette valeur est 0, alors les connexions ne seront pas conservées.
`WG_DEFAULT_ADDRESS`	`10.8.0.x`	`10.6.0.x`	Plage d’adresses IP des clients.
`WG_DEFAULT_DNS`	`1.1.1.1`	`8.8.8.8, 8.8.4.4`	Les clients du serveur DNS utiliseront. S'il est défini sur une valeur vide, les clients n'utiliseront aucun DNS.
`WG_ALLOWED_IPS`	`0.0.0.0/0, ::/0`	`192.168.15.0/24, 10.0.1.0/24`	IP autorisées que les clients utiliseront.
`WG_PRE_UP`	`...`	-	Voir config.js pour la valeur par défaut.
`WG_POST_UP`	`...`	`iptables ...`	Voir config.js pour la valeur par défaut.
`WG_PRE_DOWN`	`...`	-	Voir config.js pour la valeur par défaut.
`WG_POST_DOWN`	`...`	`iptables ...`	Voir config.js pour la valeur par défaut.
`WG_ENABLE_EXPIRES_TIME`	`false`	`true`	Activer le délai d'expiration pour les clients
`LANG`	`en`	`de`	Langue de l'interface utilisateur Web (prise en charge : en, ua, ru, tr, no, pl, fr, de, ca, es, ko, vi, nl, is, pt, chs, cht, it, th, hi, ja, si) .
`UI_TRAFFIC_STATS`	`false`	`true`	Activer les statistiques détaillées du client RX/TX dans l'interface utilisateur Web
`UI_CHART_TYPE`	`0`	`1`	UI_CHART_TYPE=0 # Graphiques désactivés, UI_CHART_TYPE=1 # Graphique linéaire, UI_CHART_TYPE=2 # Graphique en aires, UI_CHART_TYPE=3 # Graphique à barres
`WG_ENABLE_ONE_TIME_LINKS`	`false`	`true`	Activer l'affichage et la génération de liens de téléchargement courts et uniques (expirent après 5 minutes)
`MAX_AGE`	`0`	`1440`	Âge maximum des sessions de l’interface utilisateur Web en minutes. `0` signifie que la session existera jusqu'à la fermeture du navigateur.
`UI_ENABLE_SORT_CLIENTS`	`false`	`true`	Activer l'interface utilisateur pour trier les clients par nom
`ENABLE_PROMETHEUS_METRICS`	`false`	`true`	Activer les métriques Prometheus `http://0.0.0.0:51821/metrics` et `http://0.0.0.0:51821/metrics/json`
`PROMETHEUS_METRICS_PASSWORD`	-	`$2y$05$Ci...`	Si elle est définie, l’authentification de base est requise lors de la demande de métriques. Voir Comment générer un hash.md bcrypt pour savoir comment générer le hachage.

Si vous modifiez WG_PORT , assurez-vous de modifier également le port exposé.

Mise à jour

Pour mettre à jour vers la dernière version, exécutez simplement :

docker stop wg-easy
docker rm wg-easy
docker pull ghcr.io/wg-easy/wg-easy

Et puis exécutez à nouveau la commande docker run -d ... ci-dessus.

Avec Docker Compose WireGuard Easy peut être mis à jour avec une seule commande : docker compose up --detach --pull always (si une balise d'image est spécifiée dans le fichier Compose et qu'elle n'est pas latest , assurez-vous qu'elle est remplacée par celle souhaitée ; par défaut, il est omis et la valeur par défaut est latest ).
Le conteneur WireGuared Easy sera automatiquement recréé si une image plus récente a été extraite.