-
-
Notifications
You must be signed in to change notification settings - Fork 503
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
d026c0f
commit 679dfb3
Showing
1 changed file
with
58 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,58 @@ | ||
# 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 | ||
``` | ||
|
||
## 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 | ||
|
||
![wireguard-ui](https://user-images.githubusercontent.com/6447444/80270680-76adf980-86e4-11ea-8ca1-9237f0dfa249.png) | ||
|
||
## License | ||
MIT. See [LICENSE](https://github.com/ngoduykhanh/wireguard-ui/blob/master/LICENSE). |