mirror of
https://github.com/ngoduykhanh/wireguard-ui
synced 2024-05-17 21:16:40 +02:00
61 lines
1.4 KiB
Markdown
61 lines
1.4 KiB
Markdown
# wireguard-ui
|
|
A web user interface to manage your WireGuard setup.
|
|
|
|
## Features
|
|
- Friendly UI
|
|
- Authentication
|
|
- Manage extra client's information (name, email, etc)
|
|
- Retrieve configs using QR code / file
|
|
|
|
## Run WireGuard-UI
|
|
Only docker option for now, please refer to this example of [docker-compose.yml](https://github.com/ngoduykhanh/wireguard-ui/blob/master/docker-compose.yaml).
|
|
|
|
Please adjust volume mount points to work with your setup. Then run it:
|
|
|
|
```
|
|
docker-compose up
|
|
```
|
|
|
|
Default username and password are `admin`.
|
|
|
|
## Auto restart WireGuard daemon
|
|
WireGuard-UI only takes care of configuration generation. You can use systemd to watch for the changes and restart the service. Following is an example:
|
|
|
|
Create /etc/systemd/system/wgui.service
|
|
|
|
```
|
|
[Unit]
|
|
Description=Restart WireGuard
|
|
After=network.target
|
|
|
|
[Service]
|
|
Type=oneshot
|
|
ExecStart=/usr/bin/systemctl restart wg-quick@wg0.service
|
|
```
|
|
|
|
Create /etc/systemd/system/wgui.path
|
|
|
|
```
|
|
[Unit]
|
|
Description=Watch /etc/wireguard/wg0.conf for changes
|
|
|
|
[Path]
|
|
PathModified=/etc/wireguard/wg0.conf
|
|
|
|
[Install]
|
|
WantedBy=multi-user.target
|
|
```
|
|
|
|
Apply it
|
|
```
|
|
systemctl enable wgui.{path,service}
|
|
systemctl start wgui.{path,service}
|
|
```
|
|
|
|
## Screenshot
|
|
|
|
|
|
|
|
## License
|
|
MIT. See [LICENSE](https://github.com/ngoduykhanh/wireguard-ui/blob/master/LICENSE).
|