wg ui

WG UI

Um serviço de gerenciamento básico e independente para Wireguard com uma interface da web de autoatendimento.
Lançamento estável atual: v1.3.0

Características

• Auto-serviço e baseado na Web
• Código QR para configuração conveniente do cliente móvel
• Suporte opcional de vários usuários por trás de um proxy de autenticação
• Suporte simples de autenticação
• Zero dependências externas - apenas um único binário usando o módulo Wireguard Kernel
• Implantação binária e de contêineres

Correndo

A maneira mais fácil de executar o WG-UI é usar a imagem do contêiner. Para testá -lo, execute:

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

Ao executar em produção, recomendamos o uso da versão mais recente, em oposição ao latest .

Importante saber é que você precisa instalar o Wireguard na máquina para que isso funcione, pois é "apenas" uma interface do usuário para gerenciar as configurações do Wireguard.

Configuração

Você pode configurar o WG-UI usando sinalizadores de comando ou variáveis ​​de ambiente. Para ver todas as bandeiras disponíveis executar:

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

WIREGUARD_UI_<FLAG_NAME> <FLAG_NAME> CONSTANT_CASE

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

e

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

são iguais.

Autenticação

Você pode configurar a autenticação básica usando as bandeiras/variáveis ​​de ambiente --auth-basic-user=<user> e --auth-basic-pass=<bcrypt hash> A senha é um hash bcrypt que você pode gerar usando o contêiner do docker:

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

Imagens do Docker

Existem duas maneiras de executar o WG-UI hoje, você pode executá-lo com o módulo do kernel instalado no seu host, que é a melhor maneira de fazê-lo, se desejar desempenho.

 docker pull embarkstudios/wireguard-ui:latest

Se você não tiver a possibilidade ou interesse em carregar o módulo do kernel no seu host, agora existe uma solução para isso usando uma imagem do Docker baseada no Wireguard-Go. Lembre -se de que isso é executado no espaço dos usuários e não no módulo do kernel.

 docker pull embarkstudios/wireguard-ui:userspace

Ambas as imagens são construídas para linux/amd64 , linux/arm64 e linux/arm/v7 . Se você precisar de qualquer outra plataforma, poderá criar binários WG-UI com a ajuda da documentação.

Instale sem Docker

Você precisa instalar o Wireguard na máquina com wg-ui .

A menos que você use a versão do espaço do usuário com o Docker, você deve instalar o Wireguard na sua máquina host.

Alguns guias de instalação:
Ubuntu 20.04 LTS
CENTOS 8
Debian 10

INSTALAÇÃO GO (Debian)

Instale a versão mais recente de Go de (https://golang.org/dl/)

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

Ambiente de configuração

BASH: ~/.bash_profile
Zsh: ~/.zshrc

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

Instale a versão LTS do NodeJS para o front -end.

 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

Construa binário com UI

 make build

CrossCompiling

 make build-amd64

 make build-armv5

 make build-armv6

 make build-armv7

Construir passo a passo

 make ui
make build

Em desenvolvimento

Inicie o servidor front -end

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

Use o servidor de front -end ao executar o servidor

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

Contribuindo

Congratulamo -nos com contribuições da comunidade para este projeto.

Leia nosso guia colaborador para obter mais informações sobre como começar.

Licença

Licenciado sob qualquer um de

• Licença Apache, versão 2.0, (licença-apache ou http://www.apache.org/license/license-2.0)
• MIT Licença (licença-mit ou http://opensource.org/license/mit)

por sua opção.