Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ngoduykhanh/wireguard-ui

Wireguard web interface
https://github.com/ngoduykhanh/wireguard-ui

wireguard wireguard-admin wireguard-config-gen wireguard-go wireguard-ui wireguard-vpn wireguard-web

Last synced: 10 days ago
JSON representation

Wireguard web interface

Host: GitHub
URL: https://github.com/ngoduykhanh/wireguard-ui
Owner: ngoduykhanh
License: mit
Created: 2020-04-17T05:05:36.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2024-08-09T14:26:26.000Z (3 months ago)
Last Synced: 2024-10-14T15:21:29.465Z (25 days ago)
Topics: wireguard, wireguard-admin, wireguard-config-gen, wireguard-go, wireguard-ui, wireguard-vpn, wireguard-web
Language: Go
Homepage:
Size: 6.56 MB
Stars: 4,076
Watchers: 52
Forks: 503
Open Issues: 177
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

awesome-repositories - ngoduykhanh/wireguard-ui - Wireguard web interface (Go)
awesome-starred - ngoduykhanh/wireguard-ui - Wireguard web interface (others)
awesome-wireguard - wireguard-ui - Simple, have empty interfaces for authentication (Projects / User Interface)

README

![](https://github.com/ngoduykhanh/wireguard-ui/workflows/wireguard-ui%20build%20release/badge.svg)

# wireguard-ui

A web user interface to manage your WireGuard setup.

## Features

- Friendly UI
- Authentication
- Manage extra client information (name, email, etc.)
- Retrieve client config using QR code / file / email / Telegram

![wireguard-ui 0.3.7](https://user-images.githubusercontent.com/37958026/177041280-e3e7ca16-d4cf-4e95-9920-68af15e780dd.png)

## Run WireGuard-UI

> ⚠️The default username and password are `admin`. Please change it to secure your setup.

### Using binary file

Download the binary file from the release page and run it directly on the host machine

```
./wireguard-ui
```

### Using docker compose

The [examples/docker-compose](examples/docker-compose) folder contains example docker-compose files.
Choose the example which fits you the most, adjust the configuration for your needs, then run it like below:

```
docker-compose up
```

## Environment Variables

| Variable
|------------------
| `BASE_PATH`
| `BIND_ADDRESS`
| `SESSION_SECRET`
| `SESSION_SECRET_FILE`
| `SESSION_MAX_DURATION`
| `SUBNET_RANGES`
| `WGUI_USERNAME`
| `WGUI_PASSWORD`
| `WGUI_PASSWORD_FILE`
| `WGUI_PASSWORD_HASH`
| `WGUI_PASSWORD_HASH_FILE`
| `WGUI_ENDPOINT_ADDRESS`
| `WGUI_FAVICON_FILE_PATH`
| `WGUI_DNS`
| `WGUI_MTU`
| `WGUI_PERSISTENT_KEEPALIVE`
| `WGUI_FIREWALL_MARK`
| `WGUI_TABLE`
| `WGUI_CONFIG_FILE_PATH`
| `WGUI_LOG_LEVEL`
| `WG_CONF_TEMPLATE`
| `EMAIL_FROM_ADDRESS`
| `EMAIL_FROM_NAME`
| `SENDGRID_API_KEY`
| `SENDGRID_API_KEY_FILE`
| `SMTP_HOSTNAME`
| `SMTP_PORT`
| `SMTP_USERNAME`
| `SMTP_PASSWORD`
| `SMTP_PASSWORD_FILE`
| `SMTP_AUTH_TYPE`
| `SMTP_ENCRYPTION`
| `SMTP_HELO`
| `TELEGRAM_TOKEN`
| `TELEGRAM_ALLOW_CONF_REQUEST`
| `TELEGRAM_FLOOD_WAIT` | Description | Default | -------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------| | Set this variable if you run wireguard-ui under a subpath of your reverse proxy virtual host (e.g. /wireguard) | N/A | | The addresses that can access to the web interface and the port, use unix:///abspath/to/file.socket for unix domain socket. | 0.0.0.0:80 | | The secret key used to encrypt the session cookies. Set this to a random value | N/A | | Optional filepath for the secret key used to encrypt the session cookies. Leave `SESSION_SECRET` blank to take effect | N/A | | Max time in days a remembered session is refreshed and valid. Non-refreshed session is valid for 7 days max, regardless of this setting. | 90 | | The list of address subdivision ranges. Format: `SR Name:10.0.1.0/24; SR2:10.0.2.0/24,10.0.3.0/24` Each CIDR must be inside one of the server interfaces. | N/A | | The username for the login page. Used for db initialization only | `admin` | | The password for the user on the login page. Will be hashed automatically. Used for db initialization only | `admin` | | Optional filepath for the user login password. Will be hashed automatically. Used for db initialization only. Leave `WGUI_PASSWORD` blank to take effect | N/A | | The password hash for the user on the login page. (alternative to `WGUI_PASSWORD`). Used for db initialization only | N/A | | Optional filepath for the user login password hash. (alternative to `WGUI_PASSWORD_FILE`). Used for db initialization only. Leave `WGUI_PASSWORD_HASH` blank to take effect | N/A | | The default endpoint address used in global settings where clients should connect to. The endpoint can contain a port as well, useful when you are listening internally on the `WGUI_SERVER_LISTEN_PORT` port, but you forward on another port (ex 9000). Ex: myvpn.dyndns.com:9000 | Resolved to your public ip address | | The file path used as website favicon | Embedded WireGuard logo | | The default DNS servers (comma-separated-list) used in the global settings | `1.1.1.1` | | The default MTU used in global settings | `1450` | | The default persistent keepalive for WireGuard in global settings | `15` | | The default WireGuard firewall mark | `0xca6c` (51820) | | The default WireGuard table value settings | `auto` | | The default WireGuard config file path used in global settings | `/etc/wireguard/wg0.conf` | | The default log level. Possible values: `DEBUG`, `INFO`, `WARN`, `ERROR`, `OFF` | `INFO` | | The custom `wg.conf` config file template. Please refer to our [default template](https://github.com/ngoduykhanh/wireguard-ui/blob/master/templates/wg.conf) | N/A | | The sender email address | N/A | | The sender name | `WireGuard UI` | | The SendGrid api key | N/A | | Optional filepath for the SendGrid api key. Leave `SENDGRID_API_KEY` blank to take effect | N/A | | The SMTP IP address or hostname | `127.0.0.1` | | The SMTP port | `25` | | The SMTP username | N/A | | The SMTP user password | N/A | | Optional filepath for the SMTP user password. Leave `SMTP_PASSWORD` blank to take effect | N/A | | The SMTP authentication type. Possible values: `PLAIN`, `LOGIN`, `NONE` | `NONE` | | The encryption method. Possible values: `NONE`, `SSL`, `SSLTLS`, `TLS`, `STARTTLS` | `STARTTLS` | | Hostname to use for the HELO message. smtp-relay.gmail.com needs this set to anything but `localhost` | `localhost` | | Telegram bot token for distributing configs to clients | N/A | | Allow users to get configs from the bot by sending a message | `false` | | Time in minutes before the next conf request is processed | `60` |

### Defaults for server configuration

These environment variables are used to control the default server settings used when initializing the database.

| Variable | Description | Default |
|-----------------------------------|-----------------------------------------------------------------------------------------------|-----------------|
| `WGUI_SERVER_INTERFACE_ADDRESSES` | The default interface addresses (comma-separated-list) for the WireGuard server configuration | `10.252.1.0/24` |
| `WGUI_SERVER_LISTEN_PORT` | The default server listen port | `51820` |
| `WGUI_SERVER_POST_UP_SCRIPT` | The default server post-up script | N/A |
| `WGUI_SERVER_POST_DOWN_SCRIPT` | The default server post-down script | N/A |

### Defaults for new clients

These environment variables are used to set the defaults used in `New Client` dialog.

| Variable | Description | Default |
|---------------------------------------------|-------------------------------------------------------------------------------------------------|-------------|
| `WGUI_DEFAULT_CLIENT_ALLOWED_IPS` | Comma-separated-list of CIDRs for the `Allowed IPs` field. (default ) | `0.0.0.0/0` |
| `WGUI_DEFAULT_CLIENT_EXTRA_ALLOWED_IPS` | Comma-separated-list of CIDRs for the `Extra Allowed IPs` field. (default empty) | N/A |
| `WGUI_DEFAULT_CLIENT_USE_SERVER_DNS` | Boolean value [`0`, `f`, `F`, `false`, `False`, `FALSE`, `1`, `t`, `T`, `true`, `True`, `TRUE`] | `true` |
| `WGUI_DEFAULT_CLIENT_ENABLE_AFTER_CREATION` | Boolean value [`0`, `f`, `F`, `false`, `False`, `FALSE`, `1`, `t`, `T`, `true`, `True`, `TRUE`] | `true` |

### Docker only

These environment variables only apply to the docker container.

| Variable | Description | Default |
|-----------------------|---------------------------------------------------------------|---------|
| `WGUI_MANAGE_START` | Start/stop WireGuard when the container is started/stopped | `false` |
| `WGUI_MANAGE_RESTART` | Auto restart WireGuard when we Apply Config changes in the UI | `false` |

## 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:

### Using systemd

Create `/etc/systemd/system/wgui.service`

```bash
cd /etc/systemd/system/
cat << EOF > wgui.service
[Unit]
Description=Restart WireGuard
After=network.target

[Service]
Type=oneshot
ExecStart=/usr/bin/systemctl restart [email protected]

[Install]
RequiredBy=wgui.path
EOF
```

Create `/etc/systemd/system/wgui.path`

```bash
cd /etc/systemd/system/
cat << EOF > wgui.path
[Unit]
Description=Watch /etc/wireguard/wg0.conf for changes

[Path]
PathModified=/etc/wireguard/wg0.conf

[Install]
WantedBy=multi-user.target
EOF
```

Apply it

```sh
systemctl enable wgui.{path,service}
systemctl start wgui.{path,service}
```

### Using openrc

Create `/usr/local/bin/wgui` file and make it executable

```sh
cd /usr/local/bin/
cat << EOF > wgui
#!/bin/sh
wg-quick down wg0
wg-quick up wg0
EOF
chmod +x wgui
```

Create `/etc/init.d/wgui` file and make it executable

```sh
cd /etc/init.d/
cat << EOF > wgui
#!/sbin/openrc-run

command=/sbin/inotifyd
command_args="/usr/local/bin/wgui /etc/wireguard/wg0.conf:w"
pidfile=/run/${RC_SVCNAME}.pid
command_background=yes
EOF
chmod +x wgui
```

Apply it

```sh
rc-service wgui start
rc-update add wgui default
```

### Using Docker

Set `WGUI_MANAGE_RESTART=true` to manage Wireguard interface restarts.
Using `WGUI_MANAGE_START=true` can also replace the function of `wg-quick@wg0` service, to start Wireguard at boot, by
running the container with `restart: unless-stopped`. These settings can also pick up changes to Wireguard Config File
Path, after restarting the container. Please make sure you have `--cap-add=NET_ADMIN` in your container config to make
this feature work.

## Build

### Build docker image

Go to the project root directory and run the following command:

```sh
docker build --build-arg=GIT_COMMIT=$(git rev-parse --short HEAD) -t wireguard-ui .
```

```sh
docker compose build --build-arg=GIT_COMMIT=$(git rev-parse --short HEAD)
```

:information_source: A container image is available on [Docker Hub](https://hub.docker.com/r/ngoduykhanh/wireguard-ui)
which you can pull and use

```
docker pull ngoduykhanh/wireguard-ui
````

### Build binary file

Prepare the assets directory

```sh
./prepare_assets.sh
```

Then build your executable

```sh
go build -o wireguard-ui
```

## License

MIT. See [LICENSE](https://github.com/ngoduykhanh/wireguard-ui/blob/master/LICENSE).

## Support

If you like the project and want to support it, you can *buy me a coffee* ☕