mirror of
https://github.com/eduardogsilva/wireguard_webadmin.git
synced 2025-04-19 00:45:16 +00:00
Update readme
This commit is contained in:
parent
3cd1b47fc5
commit
4c038b97c0
17
README.md
17
README.md
@ -4,6 +4,7 @@ wireguard_webadmin is a full-featured yet easy-to-configure web interface for ma
|
||||
|
||||
## Features
|
||||
|
||||
- **Individual Peer Transfer History**: Track individual download and upload volumes for each peer.
|
||||
- **Advanced Firewall Management**: Experience effortless and comprehensive VPN firewall management, designed for simplicity and effectiveness.
|
||||
- **Port Forwarding**: Seamlessly redirect TCP or UDP ports to peers or networks located beyond those peers with ease!
|
||||
- **DNS Server**: DNS Service included for static DNS entries and improved privacy.
|
||||
@ -22,6 +23,10 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
|
||||
### Peer List
|
||||
Displays a comprehensive list of peers, including their status and other details, allowing for easy monitoring and management of WireGuard VPN connections.
|
||||

|
||||
|
||||
### Peer Details:
|
||||
Displays key peer information, detailed metrics, and a complete traffic volume history. Also includes a QR code for easy configuration.
|
||||

|
||||
### Firewall Management
|
||||
Offers a comprehensive interface for managing VPN firewall rules, enabling users to easily create, edit, and delete rules with iptables-style syntax. This feature ensures precise control over network traffic, enhancing security and connectivity for WireGuard VPN instances.
|
||||

|
||||
@ -134,7 +139,15 @@ Begin by navigating to your wireguard_webadmin directory:
|
||||
docker compose down
|
||||
```
|
||||
|
||||
3.**Backup Your Data:**
|
||||
3.**Pull latest images:**
|
||||
|
||||
Update your local images
|
||||
```bash
|
||||
docker compose pull
|
||||
```
|
||||
|
||||
|
||||
4.**Backup Your Data:**
|
||||
|
||||
Before making any changes, back up your database and any other important data. This step is crucial for restoring your setup if needed.
|
||||
|
||||
@ -146,7 +159,7 @@ Begin by navigating to your wireguard_webadmin directory:
|
||||
Replace `/var/lib/docker/volumes/wireguard_webadmin_wireguard/_data/` with the actual path to your Docker volume data if it's different. This command saves the backup to the current directory.
|
||||
|
||||
|
||||
4.**Deploy Using Docker Compose:**
|
||||
5.**Deploy Using Docker Compose:**
|
||||
|
||||
Follow the previously outlined [Deployment Instructions](#deployment-instructions).
|
||||
|
||||
|
BIN
screenshots/peerinfo.png
Normal file
BIN
screenshots/peerinfo.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 126 KiB |
Binary file not shown.
Before Width: | Height: | Size: 127 KiB After Width: | Height: | Size: 186 KiB |
Loading…
x
Reference in New Issue
Block a user