mirror of
https://github.com/eduardogsilva/wireguard_webadmin.git
synced 2026-03-22 00:16:18 +00:00
Update README files with enhanced descriptions and installation instructions
This commit is contained in:
Eduardo Silva
@@ -7,214 +7,62 @@
|
||||
|
||||
✨ Se encontrar algum problema na tradução ou quiser solicitar um novo idioma, por favor abra uma [issue](https://github.com/eduardogsilva/wireguard_webadmin/issues).
|
||||
|
||||
|
||||
# wireguard_webadmin
|
||||
|
||||
**wireguard_webadmin** é uma interface web completa e fácil de configurar para gerenciar instâncias WireGuard VPN. Projetada para simplificar a administração de redes WireGuard, ela oferece uma interface amigável que suporta múltiplos usuários com diferentes níveis de acesso, várias instâncias WireGuard com gerenciamento individual de peers e suporte a *crypto‑key routing* para interconexões *site‑to‑site*.
|
||||
**Gerenciamento de VPN self-hosted e controle de acesso Zero Trust — tudo na sua infraestrutura.**
|
||||
|
||||
## Funcionalidades
|
||||
Mais do que um painel WireGuard: gerencie peers, regras de firewall, DNS, redirecionamento de portas e publique aplicações internas com autenticação — sem depender de serviços de terceiros. Roda em qualquer máquina Linux com Docker. Gratuito, open source, nada sai do seu servidor.
|
||||
|
||||
- **Histórico de Transferência de Cada Peer**: Acompanhe individualmente os volumes de download e upload de cada peer.
|
||||
- **Gerenciamento Avançado de Firewall**: Experimente um gerenciamento de firewall de VPN abrangente e sem complicações, projetado para ser simples e eficaz.
|
||||
- **Redirecionamento de Portas**: Redirecione portas TCP ou UDP para peers ou redes além desses peers com facilidade!
|
||||
- **Servidor DNS**: Suporte a hosts personalizados e listas de bloqueio DNS para maior segurança e privacidade.
|
||||
- **Suporte Multiusuário**: Gerencie o acesso com diferentes níveis de permissão para cada usuário.
|
||||
- **Múltiplas Instâncias WireGuard**: Permite o gerenciamento separado de peers em várias instâncias.
|
||||
- **Crypto‑Key Routing**: Simplifica a configuração de interconexões *site‑to‑site*.
|
||||
- **Compartilhamento de Convites VPN Sem Atrito**: Gere e distribua instantaneamente convites VPN seguros e com tempo de validade via e‑mail ou WhatsApp, contendo QR code e arquivo de configuração.
|
||||
- **Modelos de Roteamento por Peer**: Defina modelos de roteamento reutilizáveis por instância do WireGuard e aplique-os aos peers, garantindo um comportamento de roteamento consistente e previsível.
|
||||
- **Aplicação de Rota com Regras de Firewall Automáticas**: Imponha políticas de roteamento gerando automaticamente regras de firewall que restringem os peers às rotas explicitamente permitidas.
|
||||
- ⚙️ **Gerenciar** — Múltiplas instâncias WireGuard, gráficos de tráfego por peer, firewall, listas de bloqueio DNS, convites VPN com QR code
|
||||
- 🔒 **Proteger** — Gateway de aplicações Zero Trust com TOTP, ACL por IP e anti-força-bruta (Altcha PoW)
|
||||
- ⚡ **Automatizar** — Acesso agendado por peer, templates de roteamento, links de convite com expiração, API REST v2
|
||||
|
||||
Este projeto tem como objetivo oferecer uma solução intuitiva e fácil de usar para gerenciamento de VPN WireGuard sem comprometer o poder e a flexibilidade que o WireGuard oferece.
|
||||
### 📖 [Documentação completa, guia de instalação e dicas em wireguard-webadmin.com](https://wireguard-webadmin.com/)
|
||||
|
||||
---
|
||||
|
||||
## Instalação Rápida
|
||||
|
||||
```bash
|
||||
mkdir wireguard_webadmin && cd wireguard_webadmin
|
||||
wget -O docker-compose.yml https://raw.githubusercontent.com/eduardogsilva/wireguard_webadmin/main/docker-compose-caddy.yml
|
||||
# edite o .env com seu SERVER_ADDRESS
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
> Para instruções detalhadas, guia de upgrade e dicas de configuração acesse **[wireguard-webadmin.com](https://wireguard-webadmin.com/)**.
|
||||
|
||||
---
|
||||
|
||||
## Capturas de Tela
|
||||
|
||||
### Lista de Peers
|
||||
Status em tempo real e gráficos de banda ao vivo para cada peer em todas as instâncias WireGuard.
|
||||
|
||||
|
||||
### Detalhes do Peer
|
||||
Histórico de tráfego, último handshake, IPs permitidos e QR code — tudo em um só lugar.
|
||||
|
||||
|
||||
### Gateway de Aplicações Zero Trust
|
||||
Publique apps internas como Proxmox ou Grafana com autenticação TOTP na frente — sem abrir portas.
|
||||
|
||||
|
||||
### Gerenciamento de Firewall
|
||||
Regras iptables por instância, redirecionamento de portas e ACLs de saída gerenciados pela interface.
|
||||
|
||||
|
||||
### Convite VPN
|
||||
Gere um convite compartilhável com QR code e arquivo de configuração. O usuário escaneia ou importa direto no cliente WireGuard.
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Licença
|
||||
|
||||
Este projeto é licenciado sob a licença MIT – consulte o arquivo [LICENSE](../LICENSE) para detalhes.
|
||||
|
||||
## Capturas de Tela
|
||||
|
||||
### Lista de Peers
|
||||
Exibe uma lista abrangente de peers, incluindo seu status e outros detalhes, permitindo monitorar e gerenciar facilmente as conexões VPN do WireGuard.
|
||||
|
||||
|
||||
### Detalhes do Peer
|
||||
Mostra informações essenciais do peer, métricas detalhadas e um histórico completo de volume de tráfego. Inclui também um QR code para configuração fácil.
|
||||
|
||||
|
||||
### Convite VPN
|
||||
Gera convites VPN seguros e com tempo de validade para compartilhamento de configurações via e‑mail ou WhatsApp, com QR code e arquivo de configuração.
|
||||
|
||||
|
||||
### Filtragem DNS Avançada
|
||||
Bloqueie conteúdo indesejado com listas de filtragem DNS integradas. Categorias predefinidas como pornografia, jogos de azar, fake news, adware e malware estão incluídas, com a possibilidade de adicionar categorias personalizadas para uma experiência de segurança sob medida.
|
||||
|
||||
|
||||
### Gerenciamento de Firewall
|
||||
Oferece uma interface abrangente para gerenciar regras de firewall da VPN, permitindo criar, editar e excluir regras com sintaxe estilo *iptables*. Este recurso garante controle preciso do tráfego de rede, ampliando a segurança e a conectividade das instâncias WireGuard.
|
||||
|
||||
|
||||
|
||||
### Configurações da Instância WireGuard
|
||||
Um hub central para gerenciar configurações de uma ou várias instâncias WireGuard, possibilitando ajustes de configuração de forma simples.
|
||||
|
||||
|
||||
### Console
|
||||
Acesso rápido a ferramentas comuns de depuração, facilitando o diagnóstico e a resolução de possíveis problemas no ambiente VPN WireGuard.
|
||||
|
||||
|
||||
### Gerenciador de Usuários
|
||||
Suporta ambientes multiusuário permitindo atribuir níveis de permissão variados, desde acesso restrito até direitos administrativos completos, garantindo controle de acesso seguro e personalizado.
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Instruções de Implantação
|
||||
|
||||
Siga estes passos para implantar o WireGuard WebAdmin:
|
||||
|
||||
1. **Prepare o Ambiente:**
|
||||
|
||||
Primeiro, crie um diretório para o projeto WireGuard WebAdmin e navegue até ele. Este será o diretório de trabalho para a implantação.
|
||||
|
||||
```bash
|
||||
mkdir wireguard_webadmin && cd wireguard_webadmin
|
||||
```
|
||||
|
||||
2. **Obtenha o Arquivo Docker Compose:**
|
||||
|
||||
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 Caddy (Recomendado)
|
||||
|
||||
Para a implantação recomendada em produção com Caddy como *reverse proxy*, use:
|
||||
|
||||
```bash
|
||||
wget -O docker-compose.yml https://raw.githubusercontent.com/eduardogsilva/wireguard_webadmin/main/docker-compose-caddy.yml
|
||||
```
|
||||
|
||||
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.
|
||||
|
||||
> [!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.
|
||||
|
||||
### Opção 2: Sem Caddy
|
||||
|
||||
Se você preferir usar seu próprio proxy reverso ou executar a aplicação sem o Caddy, use:
|
||||
|
||||
```bash
|
||||
wget -O docker-compose.yml https://raw.githubusercontent.com/eduardogsilva/wireguard_webadmin/main/docker-compose-no-caddy.yml
|
||||
```
|
||||
|
||||
> [!CAUTION]
|
||||
> 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`:**
|
||||
|
||||
Crie um arquivo `.env` no mesmo diretório do seu `docker-compose.yml` com o conteúdo abaixo, ajustando `my_server_address` para o DNS ou endereço IP do seu servidor. Este passo é crucial para garantir o funcionamento correto da aplicação.
|
||||
|
||||
```env
|
||||
# Configure SERVER_ADDRESS para coincidir com o endereço do servidor. Se não tiver um nome DNS, você pode usar o IP.
|
||||
# Um SERVER_ADDRESS configurado incorretamente causará erros de CSRF na aplicação.
|
||||
SERVER_ADDRESS=my_server_address
|
||||
DEBUG_MODE=False
|
||||
|
||||
# Escolha um fuso horário em https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
|
||||
TIMEZONE=America/Sao_Paulo
|
||||
|
||||
# Configurações de cache de status do WireGuard
|
||||
# Isso melhora o desempenho reduzindo o número de chamadas ao comando `wg` e armazenando resultados recentes.
|
||||
# WIREGUARD_STATUS_CACHE_ENABLED=True
|
||||
#
|
||||
# Quantos instantâneos (snapshots) do status do WireGuard em cache devem ser pré-carregados ao carregar a página.
|
||||
# Isso permite que os gráficos de tráfego sejam exibidos já preenchidos em vez de começarem vazios.
|
||||
# Diminua este valor se a lista inicial de peers parecer lenta.
|
||||
# 0 = desativar pré-carregamento, 9 = preencher totalmente os gráficos de tráfego.
|
||||
# WIREGUARD_STATUS_CACHE_WEB_LOAD_PREVIOUS_COUNT=9
|
||||
#
|
||||
# Com que frequência (em segundos) o cache deve ser atualizado.
|
||||
# Valores permitidos: 30, 60, 150, 300. Padrão: 60.
|
||||
# WIREGUARD_STATUS_CACHE_REFRESH_INTERVAL=60
|
||||
|
||||
# Se você precisar de hosts adicionais permitidos, pode especificá-los aqui.
|
||||
# O SERVER_ADDRESS sempre será permitido.
|
||||
# Exemplo: EXTRA_ALLOWED_HOSTS=app1.exemplo.com,app2.exemplo.com:8443,app3.exemplo.com
|
||||
#EXTRA_ALLOWED_HOSTS=app1.exemplo.com,app2.exemplo.com:8443,app3.exemplo.com
|
||||
```
|
||||
|
||||
Substitua `my_server_address` pelo endereço real do seu servidor.
|
||||
|
||||
4. **Execute o Docker Compose:**
|
||||
|
||||
Execute o comando Docker Compose para iniciar sua implantação.
|
||||
|
||||
```bash
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
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.
|
||||
|
||||
---
|
||||
|
||||
## Instruções de Upgrade
|
||||
|
||||
Manter sua instalação do WireGuard WebAdmin atualizada garante acesso aos recursos mais recentes, melhorias de segurança e correções de bugs. Siga estas instruções para um upgrade tranquilo:
|
||||
|
||||
### Preparação para o Upgrade:
|
||||
|
||||
1. **Navegue até o Diretório do Projeto:**
|
||||
|
||||
Navegue até o diretório `wireguard_webadmin`:
|
||||
|
||||
```bash
|
||||
cd wireguard_webadmin
|
||||
```
|
||||
|
||||
2. **Desligue os Serviços:**
|
||||
|
||||
Pare todos os serviços em execução para evitar perda de dados durante o upgrade.
|
||||
|
||||
```bash
|
||||
docker compose down
|
||||
```
|
||||
|
||||
3. **Baixe as Imagens Mais Recentes:**
|
||||
|
||||
Atualize suas imagens locais:
|
||||
|
||||
```bash
|
||||
docker compose pull
|
||||
```
|
||||
|
||||
4. **Faça Backup dos Seus Dados:**
|
||||
|
||||
Antes de qualquer alteração, faça backup do banco de dados e de outros dados importantes. Este passo é essencial para restaurar sua configuração, se necessário.
|
||||
|
||||
```bash
|
||||
tar cvfz wireguard-webadmin-backup-$(date +%Y-%m-%d-%H%M%S).tar.gz /var/lib/docker/volumes/wireguard_webadmin_wireguard/_data/
|
||||
```
|
||||
|
||||
Substitua `/var/lib/docker/volumes/wireguard_webadmin_wireguard/_data/` pelo caminho real do volume Docker, se diferente. O comando salva o backup no diretório atual.
|
||||
|
||||
5. **Implante Usando Docker Compose:**
|
||||
|
||||
Siga as [Instruções de Implantação](#instruções-de-implantação) descritas anteriormente.
|
||||
|
||||
> **Observação:** Não se esqueça de atualizar o arquivo `docker-compose.yml` para a versão mais recente, baixando-o novamente do repositório.
|
||||
|
||||
### Verificações Pós‑Upgrade:
|
||||
|
||||
- **Verifique a Operação:** Após iniciar os serviços, acesse a interface web para garantir que o WireGuard WebAdmin esteja funcionando como esperado. Examine os logs da aplicação para possíveis problemas.
|
||||
- **Suporte e Solução de Problemas:** Em caso de complicações ou para mais informações, consulte a página de [Discussions](https://github.com/eduardogsilva/wireguard_webadmin/discussions) do projeto ou a documentação pertinente.
|
||||
|
||||
Seguindo estas instruções, você atualizará seu WireGuard WebAdmin para a versão mais recente, incorporando todas as melhorias e atualizações de segurança disponíveis. Lembre‑se, backups regulares e o cumprimento destes passos de upgrade ajudam a manter a saúde e a segurança da sua implantação.
|
||||
|
||||
---
|
||||
|
||||
## Contribuindo
|
||||
|
||||
Contribuições tornam a comunidade *open‑source* um lugar incrível para aprender, inspirar e criar. Suas contribuições são **muito bem‑vindas**.
|
||||
|
||||
## Suporte
|
||||
|
||||
Se encontrar qualquer problema ou precisar de assistência, abra uma *issue* na página GitHub do projeto.
|
||||
Contribuições são bem-vindas e muito apreciadas. Sinta-se à vontade para abrir issues ou pull requests no [GitHub](https://github.com/eduardogsilva/wireguard_webadmin).
|
||||
|
||||
Reference in New Issue
Block a user