wg ui

WG UI

Un servicio de gestión básico y autónomo para WireGuard con una interfaz de usuario web de autoservicio.
Lanzamiento estable actual: V1.3.0

Características

• Self-servidor y basado en la web
• Código QR para una conveniente configuración del cliente móvil
• Soporte de usuario múltiple opcional detrás de un proxy autenticador
• Soporte de autenticación simple
• Dependencias externas cero: solo un binario que usa el módulo de núcleo de SireGuard
• Despliegue binario y de contenedores

Correr

La forma más fácil de ejecutar WG-UI es usar la imagen del contenedor. Para probarlo, ejecutar:

docker run --rm -it --privileged --entrypoint "/wireguard-ui" -v /tmp/wireguard-ui:/data -p 8080:8080 embarkstudios/wireguard-ui:latest --data-dir=/data --log-level=debug

Cuando se ejecuta en producción, recomendamos usar el último lanzamiento en lugar de latest .

Es importante saber que necesita tener WireGuard instalado en la máquina para que esto funcione, ya que esta es "solo" una interfaz de usuario para administrar las configuraciones de WireGuard.

Configuración

Puede configurar WG-UI utilizando indicadores de línea de comandos o variables de entorno. Para ver todas las banderas disponibles en ejecución:

 docker run --rm -it embarkstudios/wireguard-ui:latest -h
./wireguard-ui -h

Alternativamente, puede especificar cada indicador a través de una variable de entorno de la forma WIREGUARD_UI_<FLAG_NAME> , donde <FLAG_NAME> se reemplaza con el nombre del indicador transformado en CONSTANT_CASE , por ejemplo

docker run --rm -it embarkstudios/wireguard-ui:latest --log-level=debug

y

docker run --rm -it -e WIREGUARD_UI_LOG_LEVEL=debug embarkstudios/wireguard-ui:latest

son los mismos.

Autenticación

Puede configurar la autenticación básica utilizando las variables Flags/Environment --auth-basic-user=<user> y --auth-basic-pass=<bcrypt hash> La contraseña es un hash bcrypt que puede generar usted mismo utilizando el contenedor Docker:

 $ docker run -it embarkstudios/wireguard-ui:latest passwd mySecretPass
INFO[0001] Password Hash: $2a$14$D2jsPnpJixC0U0lyaGUd0OatV7QGzQ08yKV.gsmITVZgNevfZXj36

Imágenes de Docker

Hay dos formas de ejecutar WG-UI hoy, puede ejecutarlo con el módulo de kernel instalado en su host, que es la mejor manera de hacerlo si desea rendimiento.

 docker pull embarkstudios/wireguard-ui:latest

Sin embargo, si no tiene la posibilidad o el interés de tener un módulo de kernel cargado en su host, ahora hay una solución para que use una imagen Docker basada en WireGuard-go. Tenga en cuenta que esto se ejecuta en el espacio de usuario y no en el módulo de kernel.

 docker pull embarkstudios/wireguard-ui:userspace

Ambas imágenes están construidas para linux/amd64 , linux/arm64 y linux/arm/v7 . Si lo necesita para cualquier otra plataforma, puede construir binarios WG-UI con ayuda de la documentación.

Instalar sin Docker

Debe tener WireGuard instalado en la máquina con wg-ui .

A menos que use la versión UserSpace con Docker, debe tener instalado WireGuard en su máquina host.

Algunas guías de instalación:
Ubuntu 20.04 LTS
Centos 8
Debian 10

Instalación de Go (Debian)

Instale la última versión de Go de (https://golang.org/dl/)

 sudo tar -C /usr/local -xzf go$VERSION.$OS-$ARCH.tar.gz

Entorno de configuración

Bash: ~/.bash_profile
Zsh: ~/.zshrc

 export PATH=$PATH:/usr/local/go/bin:$HOME/go/bin
export GOPATH=$HOME/go

Instale la versión LTS de NodeJS para Frontend.

 sudo apt-get install curl software-properties-common
curl -sL https://deb.nodesource.com/setup_12.x | sudo bash -
sudo apt-get install nodejs

Buscar wg-ui

 git clone https://github.com/EmbarkStudios/wg-ui.git && cd wg-ui

Construir binario con ui

 make build

Entrega cruzada

 make build-amd64

 make build-armv5

 make build-armv6

 make build-armv7

Construir paso a paso

 make ui
make build

Desarrollo

Iniciar servidor frontend

 npm install --prefix=ui
npm run --prefix=ui dev

Use el servidor frontend cuando ejecute el servidor

 make build
sudo ./bin/wireguard-ui --log-level=debug --dev-ui-server http://localhost:5000

Que contribuye

Agradecemos las contribuciones de la comunidad a este proyecto.

Lea nuestra guía de contribuyentes para obtener más información sobre cómo comenzar.

Licencia

Con licencia bajo cualquiera de

• Licencia Apache, versión 2.0, (licencia-apache o http://www.apache.org/licenses/license-2.0)
• Licencia MIT (licencia-mit o http://opensource.org/licenses/mit)

a tu opción.