wireguard-ui/README.md

![](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                      | Description                                                                                                                                                                                                                                                                         | Default                            |
|-------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------|
| `BASE_PATH`                   | Set this variable if you run wireguard-ui under a subpath of your reverse proxy virtual host (e.g. /wireguard)                                                                                                                                                                      | N/A                                |
| `BIND_ADDRESS`                | 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                         |
| `SESSION_SECRET`              | The secret key used to encrypt the session cookies. Set this to a random value                                                                                                                                                                                                      | N/A                                |
| `SESSION_SECRET_FILE`         | Optional filepath for the secret key used to encrypt the session cookies. Leave `SESSION_SECRET` blank to take effect                                                                                                                                                               | N/A                                |
| `SESSION_MAX_DURATION`        | 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                                 |
| `SUBNET_RANGES`               | 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                                |
| `WGUI_USERNAME`               | The username for the login page. Used for db initialization only                                                                                                                                                                                                                    | `admin`                            |
| `WGUI_PASSWORD`               | The password for the user on the login page. Will be hashed automatically. Used for db initialization only                                                                                                                                                                          | `admin`                            |
| `WGUI_PASSWORD_FILE`          | 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                                |
| `WGUI_PASSWORD_HASH`          | The password hash for the user on the login page. (alternative to `WGUI_PASSWORD`). Used for db initialization only                                                                                                                                                                 | N/A                                |
| `WGUI_PASSWORD_HASH_FILE`     | 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                                |
| `WGUI_ENDPOINT_ADDRESS`       | 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 |
| `WGUI_FAVICON_FILE_PATH`      | The file path used as website favicon                                                                                                                                                                                                                                               | Embedded WireGuard logo            |
| `WGUI_DNS`                    | The default DNS servers (comma-separated-list) used in the global settings                                                                                                                                                                                                          | `1.1.1.1`                          |
| `WGUI_MTU`                    | The default MTU used in global settings                                                                                                                                                                                                                                             | `1450`                             |
| `WGUI_PERSISTENT_KEEPALIVE`   | The default persistent keepalive for WireGuard in global settings                                                                                                                                                                                                                   | `15`                               |
| `WGUI_FIREWALL_MARK`          | The default WireGuard firewall mark                                                                                                                                                                                                                                                 | `0xca6c`  (51820)                  |
| `WGUI_TABLE`                  | The default WireGuard table value settings                                                                                                                                                                                                                                          | `auto`                             |
| `WGUI_CONFIG_FILE_PATH`       | The default WireGuard config file path used in global settings                                                                                                                                                                                                                      | `/etc/wireguard/wg0.conf`          |
| `WGUI_LOG_LEVEL`              | The default log level. Possible values: `DEBUG`, `INFO`, `WARN`, `ERROR`, `OFF`                                                                                                                                                                                                     | `INFO`                             |
| `WG_CONF_TEMPLATE`            | 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                                |
| `EMAIL_FROM_ADDRESS`          | The sender email address                                                                                                                                                                                                                                                            | N/A                                |
| `EMAIL_FROM_NAME`             | The sender name                                                                                                                                                                                                                                                                     | `WireGuard UI`                     |
| `SENDGRID_API_KEY`            | The SendGrid api key                                                                                                                                                                                                                                                                | N/A                                |
| `SENDGRID_API_KEY_FILE`       | Optional filepath for the SendGrid api key. Leave `SENDGRID_API_KEY` blank to take effect                                                                                                                                                                                           | N/A                                |
| `SMTP_HOSTNAME`               | The SMTP IP address or hostname                                                                                                                                                                                                                                                     | `127.0.0.1`                        |
| `SMTP_PORT`                   | The SMTP port                                                                                                                                                                                                                                                                       | `25`                               |
| `SMTP_USERNAME`               | The SMTP username                                                                                                                                                                                                                                                                   | N/A                                |
| `SMTP_PASSWORD`               | The SMTP user password                                                                                                                                                                                                                                                              | N/A                                |
| `SMTP_PASSWORD_FILE`          | Optional filepath for the SMTP user password. Leave `SMTP_PASSWORD` blank to take effect                                                                                                                                                                                            | N/A                                |
| `SMTP_AUTH_TYPE`              | The SMTP authentication type. Possible values: `PLAIN`, `LOGIN`, `NONE`                                                                                                                                                                                                             | `NONE`                             |
| `SMTP_ENCRYPTION`             | The encryption method. Possible values: `NONE`, `SSL`, `SSLTLS`, `TLS`, `STARTTLS`                                                                                                                                                                                                  | `STARTTLS`                         |
| `SMTP_HELO`                   | Hostname to use for the HELO message. smtp-relay.gmail.com needs this set to anything but `localhost`                                                                                                                                                                               | `localhost`                        |
| `TELEGRAM_TOKEN`              | Telegram bot token for distributing configs to clients                                                                                                                                                                                                                              | N/A                                |
| `TELEGRAM_ALLOW_CONF_REQUEST` | Allow users to get configs from the bot by sending a message                                                                                                                                                                                                                        | `false`                            |
| `TELEGRAM_FLOOD_WAIT`         | 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 wg-quick@wg0.service

[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 .
```

or

```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* ☕

<a href="https://www.buymeacoffee.com/khanhngo" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-orange.png" alt="Buy Me A Coffee" height="41" width="174"></a>
-												Update README.md
											
										
										
											2020-05-21 18:33:10 +02:00
+								![](https://github.com/ngoduykhanh/wireguard-ui/workflows/wireguard-ui%20build%20release/badge.svg)
-												Update README.md
											
										
										
											2020-05-21 18:33:46 +02:00
+								# wireguard-ui
-												Create README.md
											
										
										
											2020-04-25 06:13:29 +02:00
+								A web user interface to manage your WireGuard setup.
 								## Features
-												Update readme and code comments (#272)


											
										
										
											2022-12-13 22:44:11 +01:00
-												Create README.md
											
										
										
											2020-04-25 06:13:29 +02:00
+								- Friendly UI
 								- Authentication
-												add PersistentKeepalive config to server-side Peer config (#515)


											
										
										
											2023-12-31 21:08:13 +01:00
+								- Manage extra client information (name, email, etc.)
 								- Retrieve client config using QR code / file / email / Telegram
-												Update readme and code comments (#272)


											
										
										
											2022-12-13 22:44:11 +01:00
 								![wireguard-ui 0.3.7](https://user-images.githubusercontent.com/37958026/177041280-e3e7ca16-d4cf-4e95-9920-68af15e780dd.png)
-												Create README.md
											
										
										
											2020-04-25 06:13:29 +02:00
 								## Run WireGuard-UI
-												Update readme and code comments (#272)


											
										
										
											2022-12-13 22:44:11 +01:00
+								> ⚠️The default username and password are `admin`. Please change it to secure your setup.
-												Single binary build (#10)

Single binary build
Use go rice for embedding the static files and templates to the binary file

											
										
										
											2020-05-21 10:51:24 +02:00
-												Update README (#191)


											
										
										
											2022-04-26 21:04:22 +02:00
+								### Using binary file
-												Update readme and code comments (#272)


											
										
										
											2022-12-13 22:44:11 +01:00
+								Download the binary file from the release page and run it directly on the host machine
-												Update README (#191)


											
										
										
											2022-04-26 21:04:22 +02:00
 								```
 								./wireguard-ui
 								```
-												Single binary build (#10)

Single binary build
Use go rice for embedding the static files and templates to the binary file

											
										
										
											2020-05-21 10:51:24 +02:00
+								### Using docker compose
-												Add docker-compose examples (#339)


											
										
										
											2023-03-15 21:35:57 +01:00
+								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:
-												Create README.md
											
										
										
											2020-04-25 06:13:29 +02:00
 								```
 								docker-compose up
 								```
-												Abstracts database storage & Status page UI (#88)


											
										
										
											2021-08-28 15:10:30 +02:00
-												Update README (#191)


											
										
										
											2022-04-26 21:04:22 +02:00
+								## Environment Variables
-												Fixes security issue & Adds support to sent configuration via email (#83)


											
										
										
											2021-08-08 19:55:59 +02:00
-												Resolve conflict

											
										
										
											2023-12-29 10:13:30 +01:00
+								| Variable                      | Description                                                                                                                                                                                                                                                                         | Default                            |
 								|-------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------|
 								| `BASE_PATH`                   | Set this variable if you run wireguard-ui under a subpath of your reverse proxy virtual host (e.g. /wireguard)                                                                                                                                                                      | N/A                                |
 								| `BIND_ADDRESS`                | 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                         |
 								| `SESSION_SECRET`              | The secret key used to encrypt the session cookies. Set this to a random value                                                                                                                                                                                                      | N/A                                |
 								| `SESSION_SECRET_FILE`         | Optional filepath for the secret key used to encrypt the session cookies. Leave `SESSION_SECRET` blank to take effect                                                                                                                                                               | N/A                                |
-												Session improvements (#510)


											
										
										
											2024-01-06 09:11:20 +01:00
+								| `SESSION_MAX_DURATION`        | 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                                 |
-												Resolve conflict

											
										
										
											2023-12-29 10:13:30 +01:00
+								| `SUBNET_RANGES`               | 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                                |
 								| `WGUI_USERNAME`               | The username for the login page. Used for db initialization only                                                                                                                                                                                                                    | `admin`                            |
 								| `WGUI_PASSWORD`               | The password for the user on the login page. Will be hashed automatically. Used for db initialization only                                                                                                                                                                          | `admin`                            |
 								| `WGUI_PASSWORD_FILE`          | 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                                |
 								| `WGUI_PASSWORD_HASH`          | The password hash for the user on the login page. (alternative to `WGUI_PASSWORD`). Used for db initialization only                                                                                                                                                                 | N/A                                |
 								| `WGUI_PASSWORD_HASH_FILE`     | 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                                |
 								| `WGUI_ENDPOINT_ADDRESS`       | 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 |
 								| `WGUI_FAVICON_FILE_PATH`      | The file path used as website favicon                                                                                                                                                                                                                                               | Embedded WireGuard logo            |
 								| `WGUI_DNS`                    | The default DNS servers (comma-separated-list) used in the global settings                                                                                                                                                                                                          | `1.1.1.1`                          |
 								| `WGUI_MTU`                    | The default MTU used in global settings                                                                                                                                                                                                                                             | `1450`                             |
 								| `WGUI_PERSISTENT_KEEPALIVE`   | The default persistent keepalive for WireGuard in global settings                                                                                                                                                                                                                   | `15`                               |
 								| `WGUI_FIREWALL_MARK`          | The default WireGuard firewall mark                                                                                                                                                                                                                                                 | `0xca6c`  (51820)                  |
 								| `WGUI_TABLE`                  | The default WireGuard table value settings                                                                                                                                                                                                                                          | `auto`                             |
 								| `WGUI_CONFIG_FILE_PATH`       | The default WireGuard config file path used in global settings                                                                                                                                                                                                                      | `/etc/wireguard/wg0.conf`          |
 								| `WGUI_LOG_LEVEL`              | The default log level. Possible values: `DEBUG`, `INFO`, `WARN`, `ERROR`, `OFF`                                                                                                                                                                                                     | `INFO`                             |
 								| `WG_CONF_TEMPLATE`            | 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                                |
 								| `EMAIL_FROM_ADDRESS`          | The sender email address                                                                                                                                                                                                                                                            | N/A                                |
 								| `EMAIL_FROM_NAME`             | The sender name                                                                                                                                                                                                                                                                     | `WireGuard UI`                     |
 								| `SENDGRID_API_KEY`            | The SendGrid api key                                                                                                                                                                                                                                                                | N/A                                |
 								| `SENDGRID_API_KEY_FILE`       | Optional filepath for the SendGrid api key. Leave `SENDGRID_API_KEY` blank to take effect                                                                                                                                                                                           | N/A                                |
 								| `SMTP_HOSTNAME`               | The SMTP IP address or hostname                                                                                                                                                                                                                                                     | `127.0.0.1`                        |
 								| `SMTP_PORT`                   | The SMTP port                                                                                                                                                                                                                                                                       | `25`                               |
 								| `SMTP_USERNAME`               | The SMTP username                                                                                                                                                                                                                                                                   | N/A                                |
 								| `SMTP_PASSWORD`               | The SMTP user password                                                                                                                                                                                                                                                              | N/A                                |
 								| `SMTP_PASSWORD_FILE`          | Optional filepath for the SMTP user password. Leave `SMTP_PASSWORD` blank to take effect                                                                                                                                                                                            | N/A                                |
 								| `SMTP_AUTH_TYPE`              | The SMTP authentication type. Possible values: `PLAIN`, `LOGIN`, `NONE`                                                                                                                                                                                                             | `NONE`                             |
 								| `SMTP_ENCRYPTION`             | The encryption method. Possible values: `NONE`, `SSL`, `SSLTLS`, `TLS`, `STARTTLS`                                                                                                                                                                                                  | `STARTTLS`                         |
 								| `SMTP_HELO`                   | Hostname to use for the HELO message. smtp-relay.gmail.com needs this set to anything but `localhost`                                                                                                                                                                               | `localhost`                        |
 								| `TELEGRAM_TOKEN`              | Telegram bot token for distributing configs to clients                                                                                                                                                                                                                              | N/A                                |
 								| `TELEGRAM_ALLOW_CONF_REQUEST` | Allow users to get configs from the bot by sending a message                                                                                                                                                                                                                        | `false`                            |
 								| `TELEGRAM_FLOOD_WAIT`         | Time in minutes before the next conf request is processed                                                                                                                                                                                                                           | `60`                               |
-												Add environment variables for configuration (#189)


											
										
										
											2022-04-26 20:35:35 +02:00
-												Update README (#191)


											
										
										
											2022-04-26 21:04:22 +02:00
+								### Defaults for server configuration
-												Add environment variables for configuration (#189)


											
										
										
											2022-04-26 20:35:35 +02:00
 								These environment variables are used to control the default server settings used when initializing the database.
-												Update readme and code comments (#272)


											
										
										
											2022-12-13 22:44:11 +01:00
+								| 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             |
-												Add environment variables for configuration (#189)


											
										
										
											2022-04-26 20:35:35 +02:00
-												Update README (#191)


											
										
										
											2022-04-26 21:04:22 +02:00
+								### Defaults for new clients
-												Add environment variables for configuration (#189)


											
										
										
											2022-04-26 20:35:35 +02:00
 								These environment variables are used to set the defaults used in `New Client` dialog.
-												Update readme and code comments (#272)


											
										
										
											2022-12-13 22:44:11 +01:00
+								| 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`      |
-												Add environment variables for configuration (#189)


											
										
										
											2022-04-26 20:35:35 +02:00
-												Manage Wireguard restarts from docker container (#267)


											
										
										
											2022-12-13 19:50:14 +01:00
+								### Docker only
 								These environment variables only apply to the docker container.
-												Update readme

											
										
										
											2022-12-13 22:48:00 +01:00
+								| Variable              | Description                                                   | Default |
 								|-----------------------|---------------------------------------------------------------|---------|
-												WireGaurd --> WireGuard (Typo) (#281)


											
										
										
											2022-12-26 10:12:09 +01:00
+								| `WGUI_MANAGE_START`   | Start/stop WireGuard when the container is started/stopped    | `false` |
-												Update readme

											
										
										
											2022-12-13 22:48:00 +01:00
+								| `WGUI_MANAGE_RESTART` | Auto restart WireGuard when we Apply Config changes in the UI | `false` |
-												Manage Wireguard restarts from docker container (#267)


											
										
										
											2022-12-13 19:50:14 +01:00
-												Create README.md
											
										
										
											2020-04-25 06:13:29 +02:00
+								## Auto restart WireGuard daemon
-												Update readme and code comments (#272)


											
										
										
											2022-12-13 22:44:11 +01:00
+								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
-												added instructions for openrc inotifyd config watching on alpine to README.md (#27)


											
										
										
											2020-09-13 21:39:18 +02:00
-												README improvements. (#268)


											
										
										
											2022-12-13 21:31:19 +01:00
+								Create `/etc/systemd/system/wgui.service`
-												Create README.md
											
										
										
											2020-04-25 06:13:29 +02:00
-												README improvements. (#268)


											
										
										
											2022-12-13 21:31:19 +01:00
+								```bash
 								cd /etc/systemd/system/
 								cat << EOF > wgui.service
-												Create README.md
											
										
										
											2020-04-25 06:13:29 +02:00
+								[Unit]
 								Description=Restart WireGuard
 								After=network.target
 								[Service]
 								Type=oneshot
 								ExecStart=/usr/bin/systemctl restart wg-quick@wg0.service
-												Updated README (#80)


											
										
										
											2021-08-05 19:46:11 +02:00
 								[Install]
 								RequiredBy=wgui.path
-												README improvements. (#268)


											
										
										
											2022-12-13 21:31:19 +01:00
+								EOF
-												Create README.md
											
										
										
											2020-04-25 06:13:29 +02:00
+								```
-												README improvements. (#268)


											
										
										
											2022-12-13 21:31:19 +01:00
+								Create `/etc/systemd/system/wgui.path`
-												Create README.md
											
										
										
											2020-04-25 06:13:29 +02:00
-												README improvements. (#268)


											
										
										
											2022-12-13 21:31:19 +01:00
+								```bash
 								cd /etc/systemd/system/
 								cat << EOF > wgui.path
-												Create README.md
											
										
										
											2020-04-25 06:13:29 +02:00
+								[Unit]
 								Description=Watch /etc/wireguard/wg0.conf for changes
 								[Path]
 								PathModified=/etc/wireguard/wg0.conf
 								[Install]
 								WantedBy=multi-user.target
-												README improvements. (#268)


											
										
										
											2022-12-13 21:31:19 +01:00
+								EOF
-												Create README.md
											
										
										
											2020-04-25 06:13:29 +02:00
+								```
 								Apply it
-												added instructions for openrc inotifyd config watching on alpine to README.md (#27)


											
										
										
											2020-09-13 21:39:18 +02:00
-												README improvements. (#268)


											
										
										
											2022-12-13 21:31:19 +01:00
+								```sh
-												Create README.md
											
										
										
											2020-04-25 06:13:29 +02:00
+								systemctl enable wgui.{path,service}
 								systemctl start wgui.{path,service}
 								```
-												Update readme and code comments (#272)


											
										
										
											2022-12-13 22:44:11 +01:00
+								### Using openrc
-												added instructions for openrc inotifyd config watching on alpine to README.md (#27)


											
										
										
											2020-09-13 21:39:18 +02:00
-												Update readme

											
										
										
											2022-12-13 22:48:00 +01:00
+								Create `/usr/local/bin/wgui` file and make it executable
-												Update readme and code comments (#272)


											
										
										
											2022-12-13 22:44:11 +01:00
-												README improvements. (#268)


											
										
										
											2022-12-13 21:31:19 +01:00
+								```sh
 								cd /usr/local/bin/
 								cat << EOF > wgui
-												added instructions for openrc inotifyd config watching on alpine to README.md (#27)


											
										
										
											2020-09-13 21:39:18 +02:00
+								#!/bin/sh
 								wg-quick down wg0
 								wg-quick up wg0
-												README improvements. (#268)


											
										
										
											2022-12-13 21:31:19 +01:00
+								EOF
 								chmod +x wgui
-												added instructions for openrc inotifyd config watching on alpine to README.md (#27)


											
										
										
											2020-09-13 21:39:18 +02:00
+								```
-												Update readme

											
										
										
											2022-12-13 22:48:00 +01:00
+								Create `/etc/init.d/wgui` file and make it executable
-												Update readme and code comments (#272)


											
										
										
											2022-12-13 22:44:11 +01:00
-												README improvements. (#268)


											
										
										
											2022-12-13 21:31:19 +01:00
+								```sh
 								cd /etc/init.d/
 								cat << EOF > wgui
-												added instructions for openrc inotifyd config watching on alpine to README.md (#27)


											
										
										
											2020-09-13 21:39:18 +02:00
+								#!/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
-												README improvements. (#268)


											
										
										
											2022-12-13 21:31:19 +01:00
+								EOF
 								chmod +x wgui
-												added instructions for openrc inotifyd config watching on alpine to README.md (#27)


											
										
										
											2020-09-13 21:39:18 +02:00
+								```
 								Apply it
-												README improvements. (#268)


											
										
										
											2022-12-13 21:31:19 +01:00
+								```sh
-												added instructions for openrc inotifyd config watching on alpine to README.md (#27)


											
										
										
											2020-09-13 21:39:18 +02:00
+								rc-service wgui start
 								rc-update add wgui default
 								```
-												Update readme and code comments (#272)


											
										
										
											2022-12-13 22:44:11 +01:00
+								### Using Docker
-												Manage Wireguard restarts from docker container (#267)


											
										
										
											2022-12-13 19:50:14 +01:00
 								Set `WGUI_MANAGE_RESTART=true` to manage Wireguard interface restarts.
-												Update readme and code comments (#272)


											
										
										
											2022-12-13 22:44:11 +01:00
+								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
-												Update readme

											
										
										
											2022-12-13 22:48:00 +01:00
+								Path, after restarting the container. Please make sure you have `--cap-add=NET_ADMIN` in your container config to make
-												add PersistentKeepalive config to server-side Peer config (#515)


											
										
										
											2023-12-31 21:08:13 +01:00
+								this feature work.
-												Manage Wireguard restarts from docker container (#267)


											
										
										
											2022-12-13 19:50:14 +01:00
-												Single binary build (#10)

Single binary build
Use go rice for embedding the static files and templates to the binary file

											
										
										
											2020-05-21 10:51:24 +02:00
+								## Build
 								### Build docker image
 								Go to the project root directory and run the following command:
-												README improvements. (#268)


											
										
										
											2022-12-13 21:31:19 +01:00
+								```sh
-												GHA fixes

											
										
										
											2023-05-24 21:21:44 +02:00
+								docker build --build-arg=GIT_COMMIT=$(git rev-parse --short HEAD) -t wireguard-ui .
-												Stamp git commit into docker builds. (#325)


											
										
										
											2023-03-15 21:39:20 +01:00
+								```
 								or
 								```sh
-												GHA fixes

											
										
										
											2023-05-24 21:21:44 +02:00
+								docker compose build --build-arg=GIT_COMMIT=$(git rev-parse --short HEAD)
-												Single binary build (#10)

Single binary build
Use go rice for embedding the static files and templates to the binary file

											
										
										
											2020-05-21 10:51:24 +02:00
+								```
-												add PersistentKeepalive config to server-side Peer config (#515)


											
										
										
											2023-12-31 21:08:13 +01:00
+								:information_source: A container image is available on [Docker Hub](https://hub.docker.com/r/ngoduykhanh/wireguard-ui)
 								which you can pull and use
-												Update README.md
											
										
										
											2023-03-17 09:53:57 +01:00
+								```
 								docker pull ngoduykhanh/wireguard-ui
 								````
-												Single binary build (#10)

Single binary build
Use go rice for embedding the static files and templates to the binary file

											
										
										
											2020-05-21 10:51:24 +02:00
+								### Build binary file
 								Prepare the assets directory
-												README improvements. (#268)


											
										
										
											2022-12-13 21:31:19 +01:00
+								```sh
-												Single binary build (#10)

Single binary build
Use go rice for embedding the static files and templates to the binary file

											
										
										
											2020-05-21 10:51:24 +02:00
+								./prepare_assets.sh
 								```
-												Replace go.rice with native go embedding (#331)


											
										
										
											2023-03-16 08:40:04 +01:00
+								Then build your executable
-												add PersistentKeepalive config to server-side Peer config (#515)


											
										
										
											2023-12-31 21:08:13 +01:00
-												README improvements. (#268)


											
										
										
											2022-12-13 21:31:19 +01:00
+								```sh
-												Single binary build (#10)

Single binary build
Use go rice for embedding the static files and templates to the binary file

											
										
										
											2020-05-21 10:51:24 +02:00
+								go build -o wireguard-ui
 								```
-												Create README.md
											
										
										
											2020-04-25 06:13:29 +02:00
+								## License
-												Update readme and code comments (#272)


											
										
										
											2022-12-13 22:44:11 +01:00
-												Create README.md
											
										
										
											2020-04-25 06:13:29 +02:00
+								MIT. See [LICENSE](https://github.com/ngoduykhanh/wireguard-ui/blob/master/LICENSE).
-												Update README.md
											
										
										
											2020-05-17 09:38:26 +02:00
 								## Support
-												Update readme and code comments (#272)


											
										
										
											2022-12-13 22:44:11 +01:00
-												Update README.md
											
										
										
											2020-05-17 09:38:26 +02:00
+								If you like the project and want to support it, you can *buy me a coffee* ☕
 								<a href="https://www.buymeacoffee.com/khanhngo" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-orange.png" alt="Buy Me A Coffee" height="41" width="174"></a>