diff --git a/apps/wireguard-ui/0.6.2/.env.sample b/apps/wireguard-ui/0.6.2/.env.sample index 9258399b..d0245138 100644 --- a/apps/wireguard-ui/0.6.2/.env.sample +++ b/apps/wireguard-ui/0.6.2/.env.sample @@ -1,6 +1,5 @@ CONTAINER_NAME="wireguard-ui" -DATA_PATH="./data" PANEL_APP_PORT_HTTP="40073" WEBUI_PWD="password" WEBUI_USER="admin" -WIREGUARD_PORT="51820" +PANEL_APP_PORT_WIREGUARD="51820" diff --git a/apps/wireguard-ui/0.6.2/data.yml b/apps/wireguard-ui/0.6.2/data.yml index d24dad4b..339bc7b2 100644 --- a/apps/wireguard-ui/0.6.2/data.yml +++ b/apps/wireguard-ui/0.6.2/data.yml @@ -10,19 +10,12 @@ additionalProperties: type: number - default: 51820 edit: true - envKey: WIREGUARD_PORT + envKey: PANEL_APP_PORT_WIREGUARD labelEn: Wireguard port - labelZh: Wireguard端口 + labelZh: Wireguard 端口 required: true rule: paramPort type: number - - default: ./data - edit: true - envKey: DATA_PATH - labelEn: Data folder path - labelZh: 数据文件夹路径 - required: true - type: text - default: "admin" edit: true envKey: WEBUI_USER @@ -35,7 +28,7 @@ additionalProperties: envKey: WEBUI_PWD labelEn: Webui password labelZh: 网页密码 - random: false - required: false + random: true + required: true rule: paramComplexity type: password diff --git a/apps/wireguard-ui/0.6.2/data/.gitkeep b/apps/wireguard-ui/0.6.2/data/.gitkeep new file mode 100644 index 00000000..e69de29b diff --git a/apps/wireguard-ui/0.6.2/docker-compose.yml b/apps/wireguard-ui/0.6.2/docker-compose.yml index cd7b6f62..27612460 100644 --- a/apps/wireguard-ui/0.6.2/docker-compose.yml +++ b/apps/wireguard-ui/0.6.2/docker-compose.yml @@ -16,11 +16,13 @@ services: - WGUI_USERNAME=${WEBUI_USER} - WGUI_PASSWORD=${WEBUI_PWD} - WG_CONF_TEMPLATE - - WGUI_MANAGE_START=true + - WGUI_MANAGE_START=false - WGUI_MANAGE_RESTART=true + - WGUI_SERVER_LISTEN_PORT=${PANEL_APP_PORT_WIREGUARD} + - BIND_ADDRESS=0.0.0.0:${PANEL_APP_PORT_HTTP} volumes: - - ${DATA_PATH}/db:/app/db - - ${DATA_PATH}/config:/etc/wireguard + - ./data/db:/app/db + - ./data/config:/etc/wireguard image: ngoduykhanh/wireguard-ui:0.6.2 logging: driver: json-file @@ -37,10 +39,15 @@ services: cap_add: - NET_ADMIN volumes: - - ${DATA_PATH}/config:/config + - ./data/config:/config ports: - - "${PANEL_APP_PORT_HTTP}:5000" - - "${WIREGUARD_PORT}:51820/udp" + - "${PANEL_APP_PORT_HTTP}:${PANEL_APP_PORT_HTTP}" + - "${PANEL_APP_PORT_WIREGUARD}:${PANEL_APP_PORT_WIREGUARD}/udp" + environment: + - PUID=1000 + - PGID=1000 + - PEERS=1 + - SERVERPORT=${PANEL_APP_PORT_WIREGUARD} image: linuxserver/wireguard:latest labels: createdBy: "Apps" @@ -48,4 +55,3 @@ services: networks: 1panel-network: external: true - diff --git a/apps/wireguard-ui/0.6.2/scripts/init.sh b/apps/wireguard-ui/0.6.2/scripts/init.sh new file mode 100644 index 00000000..4e811c86 --- /dev/null +++ b/apps/wireguard-ui/0.6.2/scripts/init.sh @@ -0,0 +1,3 @@ +#!/bin/bash + +chown -R 1000:1000 data \ No newline at end of file diff --git a/apps/wireguard-ui/README.md b/apps/wireguard-ui/README.md index 0da4652b..dce34a27 100644 --- a/apps/wireguard-ui/README.md +++ b/apps/wireguard-ui/README.md @@ -1,3 +1,17 @@ +# 使用说明 + +新版本的镜像假如遇到网页登录存在问题，或许可以尝试重启应用再登录。 + +假如无效，则可以在 1Panel 高级设置里编辑应用`compose`文件调整以下参数，具体可以查看原项目说明。 + +``` + - WGUI_MANAGE_START=false + - WGUI_MANAGE_RESTART=true +``` + +# 原始相关 +*** + ![](https://github.com/ngoduykhanh/wireguard-ui/workflows/wireguard-ui%20build%20release/badge.svg) # wireguard-ui @@ -12,222 +26,3 @@ A web user interface to manage your WireGuard setup. - Retrieve client config using QR code / file / email ![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 | 0.0.0.0:80 | -| `SESSION_SECRET` | The secret key used to encrypt the session cookies. Set this to a random value | 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_HASH` | The password hash for the user on the login page. (alternative to `WGUI_PASSWORD`). Used for db initialization only | N/A | -| `WGUI_ENDPOINT_ADDRESS` | The default endpoint address used in global settings where clients should connect to | 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 | -| `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_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` | - -### 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 avaialble 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* ☕ - -Buy Me A Coffee diff --git a/apps/wireguard-ui/latest/.env.sample b/apps/wireguard-ui/latest/.env.sample index 9258399b..d0245138 100644 --- a/apps/wireguard-ui/latest/.env.sample +++ b/apps/wireguard-ui/latest/.env.sample @@ -1,6 +1,5 @@ CONTAINER_NAME="wireguard-ui" -DATA_PATH="./data" PANEL_APP_PORT_HTTP="40073" WEBUI_PWD="password" WEBUI_USER="admin" -WIREGUARD_PORT="51820" +PANEL_APP_PORT_WIREGUARD="51820" diff --git a/apps/wireguard-ui/latest/data.yml b/apps/wireguard-ui/latest/data.yml index d24dad4b..339bc7b2 100644 --- a/apps/wireguard-ui/latest/data.yml +++ b/apps/wireguard-ui/latest/data.yml @@ -10,19 +10,12 @@ additionalProperties: type: number - default: 51820 edit: true - envKey: WIREGUARD_PORT + envKey: PANEL_APP_PORT_WIREGUARD labelEn: Wireguard port - labelZh: Wireguard端口 + labelZh: Wireguard 端口 required: true rule: paramPort type: number - - default: ./data - edit: true - envKey: DATA_PATH - labelEn: Data folder path - labelZh: 数据文件夹路径 - required: true - type: text - default: "admin" edit: true envKey: WEBUI_USER @@ -35,7 +28,7 @@ additionalProperties: envKey: WEBUI_PWD labelEn: Webui password labelZh: 网页密码 - random: false - required: false + random: true + required: true rule: paramComplexity type: password diff --git a/apps/wireguard-ui/latest/data/.gitkeep b/apps/wireguard-ui/latest/data/.gitkeep new file mode 100644 index 00000000..e69de29b diff --git a/apps/wireguard-ui/latest/docker-compose.yml b/apps/wireguard-ui/latest/docker-compose.yml index 5ae90756..1b125c57 100644 --- a/apps/wireguard-ui/latest/docker-compose.yml +++ b/apps/wireguard-ui/latest/docker-compose.yml @@ -1,21 +1,5 @@ version: "3" services: - wireguard: - container_name: ${CONTAINER_NAME}-wireguard - restart: always - networks: - - 1panel-network - cap_add: - - NET_ADMIN - volumes: - - ${DATA_PATH}/config:/config - ports: - - "${PANEL_APP_PORT_HTTP}:5000" - - "${WIREGUARD_PORT}:51820/udp" - image: linuxserver/wireguard:latest - labels: - createdBy: "Apps" - wireguard-ui: container_name: ${CONTAINER_NAME} restart: always @@ -32,11 +16,13 @@ services: - WGUI_USERNAME=${WEBUI_USER} - WGUI_PASSWORD=${WEBUI_PWD} - WG_CONF_TEMPLATE - - WGUI_MANAGE_START=true + - WGUI_MANAGE_START=false - WGUI_MANAGE_RESTART=true + - WGUI_SERVER_LISTEN_PORT=${PANEL_APP_PORT_WIREGUARD} + - BIND_ADDRESS=0.0.0.0:${PANEL_APP_PORT_HTTP} volumes: - - ${DATA_PATH}/db:/app/db - - ${DATA_PATH}/config:/etc/wireguard + - ./data/db:/app/db + - ./data/config:/etc/wireguard image: ngoduykhanh/wireguard-ui:latest logging: driver: json-file @@ -45,7 +31,27 @@ services: labels: createdBy: "Apps" + wireguard: + container_name: ${CONTAINER_NAME}-wireguard + restart: always + networks: + - 1panel-network + cap_add: + - NET_ADMIN + volumes: + - ./data/config:/config + ports: + - "${PANEL_APP_PORT_HTTP}:${PANEL_APP_PORT_HTTP}" + - "${PANEL_APP_PORT_WIREGUARD}:${PANEL_APP_PORT_WIREGUARD}/udp" + environment: + - PUID=1000 + - PGID=1000 + - PEERS=1 + - SERVERPORT=${PANEL_APP_PORT_WIREGUARD} + image: linuxserver/wireguard:latest + labels: + createdBy: "Apps" + networks: 1panel-network: external: true - diff --git a/apps/wireguard-ui/latest/scripts/init.sh b/apps/wireguard-ui/latest/scripts/init.sh new file mode 100644 index 00000000..4e811c86 --- /dev/null +++ b/apps/wireguard-ui/latest/scripts/init.sh @@ -0,0 +1,3 @@ +#!/bin/bash + +chown -R 1000:1000 data \ No newline at end of file