2020-01-30 06:45:49 +00:00
# Wg Gen Web
Simple Web based configuration generator for [WireGuard ](https://wireguard.com ).
2020-01-30 07:12:26 +00:00
---
2020-01-31 02:27:30 +00:00
[](https://gitlab.127-0-0-1.fr/vx3r/wg-gen-web/commits/master)
[](https://goreportcard.com/report/github.com/vx3r/wg-gen-web)
[](http://www.wtfpl.net/about/)
2020-01-30 07:12:26 +00:00
2020-01-31 04:06:39 +00:00
## Why another one ?
2020-01-30 06:45:49 +00:00
2020-01-30 08:34:54 +00:00
All WireGuard UI implementations are trying to manage the service by applying configurations and creating network rules.
2020-01-31 04:06:39 +00:00
This implementation only generates configuration and its up to you to create network rules and apply configuration to WireGuard.
For example by monitoring generated directory with [inotifywait ](https://github.com/inotify-tools/inotify-tools/wiki ).
2020-01-30 06:45:49 +00:00
The goal is to run Wg Gen Web in a container and WireGuard on host system.
## Features
2020-01-31 04:06:39 +00:00
* Self-hosted and web based
* Automatically select IP from the netowrk pool assigned to client
2020-01-30 06:45:49 +00:00
* QR-Code for convenient mobile client configuration
* Enable / Disable client
* Generation of `wg0.conf` after any modification
* Dockerized
* Pretty cool look
## Running
2020-01-30 08:34:54 +00:00
The easiest way to run Wg Gen Web is using the container image
2020-01-30 06:45:49 +00:00
```
docker run --rm -it -v /tmp/wireguard:/data -p 8080:8080 -e "WG_CONF_DIR=/data" vx3r/wg-gen-web:latest
```
2020-01-31 04:06:39 +00:00
Docker compose snippet
2020-01-30 06:45:49 +00:00
```
version: '3.6'
services:
wg-gen-web:
image: vx3r/wg-gen-web:latest
container_name: wg-gen-web
restart: unless-stopped
expose:
- "8080/tcp"
environment:
- WG_CONF_DIR=/data
- WG_INTERFACE_NAME=wg0.conf
volumes:
2020-01-31 04:06:39 +00:00
- /etc/wireguard:/data
2020-01-30 06:45:49 +00:00
```
2020-01-31 04:06:39 +00:00
Please note that mapping ```/etc/wireguard``` to ```/data``` inside the docker, will erase your host's current configuration.
If needed, please make sure to backup your files from ```/etc/wireguard```.
2020-01-30 08:16:10 +00:00
2020-01-31 04:06:39 +00:00
A workaround would be to change the ```WG_INTERFACE_NAME``` to something different, as it will create a new interface (```wg-auto.conf``` for example), note that if you do so, you will have to adapt your daemon accordingly.
### Automatically apply changes using ```systemd```
2020-01-30 08:16:10 +00:00
Using `systemd.path` monitor for directory changes see [systemd doc ](https://www.freedesktop.org/software/systemd/man/systemd.path.html )
```
# /etc/systemd/system/wg-gen-web.path
[Unit]
Description=Watch /etc/wireguard for changes
[Path]
PathModified=/etc/wireguard
[Install]
WantedBy=multi-user.target
```
This `.path` will activate unit file with the same name
```
# /etc/systemd/system/wg-gen-web.service
[Unit]
Description=Restart WireGuard
After=network.target
[Service]
Type=oneshot
ExecStart=/usr/bin/systemctl restart wg-quick@wg0.service
[Install]
WantedBy=multi-user.target
```
Which will restart WireGuard service
2020-01-31 04:06:39 +00:00
### Automatically apply changes using ```inotifywait```
For any other init system, create a daemon running this script
2020-01-30 08:16:10 +00:00
```
#!/bin/sh
while inotifywait -e modify -e create /etc/wireguard; do
wg-quick down wg0
wg-quick up wg0
done
```
2020-01-30 06:45:49 +00:00
2020-01-31 02:27:30 +00:00
## How to use with existing WireGuard configuration
2020-01-31 04:06:39 +00:00
After first run Wg Gen Web will create `server.json` in data directory with all server informations.
2020-01-31 02:27:30 +00:00
2020-01-31 04:06:39 +00:00
Feel free to modify this file in order to use your existing keys
2020-01-31 02:27:30 +00:00
2020-01-30 06:45:49 +00:00
## What is out of scope
* Generation or application of any `iptables` or `nftables` rules
2020-02-01 07:08:37 +00:00
* Application of configuration to WireGuard by Wg Gen Web itself
2020-01-30 06:45:49 +00:00
## TODO
* Multi-user support behind [Authelia ](https://github.com/authelia/authelia ) (suggestions / thoughts are welcome)
* Send configs by email to client
## License
2020-01-31 04:06:39 +00:00
* Do What the Fuck You Want to Public License. [LICENSE-WTFPL ](LICENSE-WTFPL ) or http://www.wtfpl.net
