https://github.com/byjg/wireguard-ui-setup
Quick tool to setup wireguard-ui
https://github.com/byjg/wireguard-ui-setup
Last synced: 6 months ago
JSON representation
Quick tool to setup wireguard-ui
- Host: GitHub
- URL: https://github.com/byjg/wireguard-ui-setup
- Owner: byjg
- License: mit
- Created: 2022-07-27T17:49:03.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2024-04-19T01:13:57.000Z (over 1 year ago)
- Last Synced: 2025-02-03T00:00:06.362Z (8 months ago)
- Language: Shell
- Size: 16.6 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Wireguard-ui-setup
This scripts helps to setup the [wireguard-ui](https://github.com/ngoduykhanh/wireguard-ui) project into your machine. It enables:
- Setup the server interface
- Setup the clients interfaces
- Restart the server interface with no interruption
## Preparing
Open the file `config.env.sample` and edit the parameteres in the file according with your setup and save as `config.env`.
```
export WIREGUARD_UI_VERSION=0.4.0
export WIREGUARD_UI_PLATFORM=linux-amd64
export WG_INTERFACE=wg0
export WG_DIRECTORY=/opt/wireguard-ui
export WG_ARGS=''
```
The latest `WIREGUARD_UI_VERSION` can be found at [https://github.com/ngoduykhanh/wireguard-ui/releases](https://github.com/ngoduykhanh/wireguard-ui/releases)
Check the `WIREGUARD_UI_PLATFORM`. Available platforms are:
- linux-arm64
- linux-amd64
- linux-386
- linux-arm
- freebsd-386
- freebsd-amd64
- freebsd-arm
- freebsd-arm64
For the WG_ARGS the available arguments are:
```
Usage of /opt/wireguard-ui/wireguard-ui:
-bind-address string
Address:Port to which the app will be bound. (default "0.0.0.0:5000")
-disable-login
Disable authentication on the app. This is potentially dangerous.
-email-from string
'From' email address.
-email-from-name string
'From' email name. (default "WireGuard UI")
-sendgrid-api-key string
Your sendgrid api key.
-session-secret string
The key used to encrypt session cookies.
-smtp-auth-type string
SMTP Auth Type : Plain or None. (default "None")
-smtp-hostname string
SMTP Hostname (default "127.0.0.1")
-smtp-no-tls-check
Disable TLS verification for SMTP. This is potentially dangerous.
-smtp-password string
SMTP Password
-smtp-port int
SMTP Port (default 25)
-smtp-username string
SMTP Password
```
## Executing
```
sudo ./wireguard-ui-setup.sh
```
Once finished, connect to the admin interface, configure the interface and apply.
**After apply the new configuration, restart the computer**
## More information
[https://github.com/ngoduykhanh/wireguard-ui/](https://github.com/ngoduykhanh/wireguard-ui/)