Merge pull request #932 from WGDashboard/dependabot/npm_and_yarn/src/static/app/npm-11.6.1

Bump npm from 11.6.0 to 11.6.1 in /src/static/app

.github/dependabot.yml

@@ -8,24 +8,24 @@ updates:
   - package-ecosystem: "pip"
     directory: "/src"
     schedule:
-      interval: "daily"
+      interval: "weekly"
 
   - package-ecosystem: "npm"
-    directory: "/"
+    directory: "/src/static/app"
     schedule:
-      interval: "daily"
+      interval: "weekly"
       
   - package-ecosystem: "github-actions"
     directory: "/.github"
     schedule:
-      interval: "daily"
+      interval: "weekly"
 
   - package-ecosystem: "docker"
     directory: "/docker"
     schedule:
-      interval: "daily"
+      interval: "weekly"
 
   - package-ecosystem: "docker-compose"
     directory: "/docker"
     schedule:
-      interval: "daily"
+      interval: "weekly"

README.md

@@ -26,6 +26,8 @@
   <a href="https://wakatime.com/badge/github/donaldzou/WGDashboard"><img src="https://wakatime.com/badge/github/donaldzou/WGDashboard.svg?style=for-the-badge" alt="wakatime"></a>
   <a href="https://hitscounter.dev"><img src="https://hitscounter.dev/api/hit?url=https%3A%2F%2Fgithub.com%2Fdonaldzou%2FWGDashboard&label=Visitor&icon=github&color=%230a58ca&style=for-the-badge"></a>
   <img src="https://img.shields.io/docker/pulls/donaldzou/wgdashboard?logo=docker&label=Docker%20Image%20Pulls&labelColor=ffffff&style=for-the-badge">
+  <img src="https://github.com/WGDashboard/WGDashboard/actions/workflows/docker.yml/badge.svg?style=for-the-badge">
+  <img src="https://github.com/WGDashboard/WGDashboard/actions/workflows/codeql-analyze.yaml/badge.svg">
 </p>
 <p align="center"><b>This project is supported by</b></p>
 <p align="center">

docker/Dockerfile

@@ -3,8 +3,10 @@
 # Base: Alpine
 #
 
+# Pull the current golang-alpine image.
 FROM golang:1.25-alpine AS awg-go
 
+# Install build-dependencies.
 RUN apk add --no-cache \
     git \
     gcc \
@@ -14,9 +16,12 @@ RUN apk add --no-cache \
 RUN mkdir -p /workspace && \
     git clone https://github.com/WGDashboard/amneziawg-go /workspace/awg
 
+# Enable CGO compilation for AmneziaWG
 ENV CGO_ENABLED=1
 
+# Change directory
 WORKDIR /workspace/awg
+# Compile the binaries
 RUN go mod download && \
     go mod verify && \
     go build -ldflags '-linkmode external -extldflags "-fno-PIC -static"' -v -o /usr/bin
@@ -26,6 +31,7 @@ RUN go mod download && \
 #
 FROM alpine:latest AS awg-tools
 
+# Install needed dependencies.
 RUN apk add --no-cache \
     make \
     git \
@@ -33,19 +39,24 @@ RUN apk add --no-cache \
     linux-headers \
     ca-certificates
 
+# Get the workspace ready
 RUN mkdir -p /workspace && \
     git clone https://github.com/WGDashboard/amneziawg-tools /workspace/awg-tools
 
+# Change directory
 WORKDIR /workspace/awg-tools/src
+# Compile and change permissions
 RUN make && chmod +x wg*
 
 #
 # PIP DEPENDENCY BUILDING
 # Base: Alpine
 #
+
+# Use the python-alpine image for building pip dependencies
 FROM python:3.13-alpine AS pip-builder
 
-
+# Add the build dependencies and create a Python virtual environment.
 RUN apk add --no-cache \
       build-base \
       pkgconfig \
@@ -57,7 +68,9 @@ RUN apk add --no-cache \
     && mkdir -p /opt/wgdashboard/src \
     && python3 -m venv /opt/wgdashboard/src/venv
 
+# Copy the requirements file into the build layer.
 COPY ./src/requirements.txt /opt/wgdashboard/src
+# Install the pip packages
 RUN . /opt/wgdashboard/src/venv/bin/activate && \
     pip3 install --upgrade pip && \
     pip3 install -r /opt/wgdashboard/src/requirements.txt
@@ -66,6 +79,8 @@ RUN . /opt/wgdashboard/src/venv/bin/activate && \
 # WGDashboard RUNNING STAGE
 # Base: Alpine
 #
+
+# Running with the python-alpine image.
 FROM python:3.13-alpine AS final
 LABEL maintainer="dselen@nerthus.nl"
 
@@ -78,7 +93,7 @@ RUN apk add --no-cache \
     tzdata wireguard-tools \
     openresolv openrc
 
-# Copy only the final binaries from the builders
+# Copy only the final binaries from the AWG builder stages
 COPY --from=awg-go /usr/bin/amneziawg-go /usr/bin/amneziawg-go
 COPY --from=awg-tools /workspace/awg-tools/src/wg /usr/bin/awg
 COPY --from=awg-tools /workspace/awg-tools/src/wg-quick/linux.bash /usr/bin/awg-quick
@@ -92,14 +107,14 @@ ENV TZ="Europe/Amsterdam" \
     public_ip="" \
     WGDASH=/opt/wgdashboard
 
-# Create directories
+# Create directories needed for operation
 RUN mkdir /data /configs -p ${WGDASH}/src /etc/amnezia/amneziawg
 
-# Copy app source and prebuilt venv only (no pip cache)
+# Copy the python virtual environment from the pip-builder stage
 COPY ./src ${WGDASH}/src
 COPY --from=pip-builder /opt/wgdashboard/src/venv /opt/wgdashboard/src/venv
 
-# WireGuard interface template
+# First WireGuard interface template
 SHELL ["/bin/bash", "-o", "pipefail", "-c"]
 RUN out_adapt=$(ip -o -4 route show to default | awk '{print $NF}') \
   && echo -e "[Interface]\n\
@@ -114,11 +129,14 @@ SaveConfig = true\n\
 DNS = ${global_dns}" > /configs/wg0.conf.template \
   && chmod 600 /configs/wg0.conf.template
 
+# Set a healthcheck to determine the container its health
 HEALTHCHECK --interval=30s --timeout=10s --start-period=5s --retries=3 \
   CMD sh -c 'pgrep gunicorn > /dev/null && pgrep tail > /dev/null' || exit 1
 
+# Copy in the runtime script, essential.
 COPY ./docker/entrypoint.sh /entrypoint.sh
 
+#
 EXPOSE 10086
 WORKDIR $WGDASH/src
 

docker/README.md

@@ -3,8 +3,8 @@ Author: @DaanSelen<br>
 
 This document delves into how the WGDashboard Docker container has been built.<br>
 Of course there are two stages (simply said), one before run-time and one at/after run-time.<br>
-The `Dockerfile` describes how the container image is made, and the `entrypoint.sh` is executed after running the container. <br>
+The `Dockerfile` describes how the container image is made, and the `entrypoint.sh` is executed after the container is started. <br>
-In this example, WireGuard is integrated into the container itself, so it should be a run-and-go(/out-of-the-box).<br>
+In this example, [WireGuard](https://www.wireguard.com/) is integrated into the container itself, so it should be a run-and-go(/out-of-the-box) experience.<br>
 For more details on the source-code specific to this Docker image, refer to the source files, they have lots of comments.
 
 <br>
@@ -18,20 +18,24 @@ For more details on the source-code specific to this Docker image, refer to the
 />
 <br>
 
-To get the container running you either pull the image from the repository, (docker.io)`donaldzou/wgdashboard:latest`.<br>
+To get the container running you either pull the pre-made image from a remote repository, there are 2 official options.<br>
-From there either use the environment variables describe below as parameters or use the Docker Compose file: `compose.yaml`.<br>
+
-Be careful, the default generated WireGuard configuration file uses port 51820/udp. So use this port if you want to use it out of the box.<br>
+- ghcr.io/wgdashboard/wgdashboard:<tag>
-Otherwise edit the configuration file in `/etc/wireguard/wg0.conf`.
+- docker.io/donaldzou/wgdashboard:<tag>
+
+> tags should be either: latest, main, <version> or <commit-sha>.
+
+From there either use the environment variables described below as parameters or use the Docker Compose file: `compose.yaml`.<br>
+Be careful, the default generated WireGuard configuration file uses port 51820/udp. So make sure to use this port if you want to use it out of the box.<br>
+Otherwise edit the configuration file in WGDashboard under `Configuration Settings` -> `Edit Raw Configuration File`.
+
+> Otherwise you need to enter the container and edit: `/etc/wireguard/wg0.conf`.
 
 # WGDashboard: 🐳 Docker Deployment Guide
 
-To run the container, you can either pull the image from Docker Hub or build it yourself. The image is available at:
+To run the container, you can either pull the image from the Github Container Registry (ghcr.io), Docker Hub (docker.io) or build it yourself. The image is available at:
 
-```
+> `docker.io` is in most cases automatically resolved by the Docker application. Therefor you can ofter specify: `donaldzou/wgdashboard:latest`
-docker.io/donaldzou/wgdashboard:latest
-```
-
-> `docker.io` is in most cases automatically resolved by the Docker application.
 
 ### 🔧 Quick Docker Run Command
 
@@ -44,7 +48,7 @@ docker run -d \
   -p 10086:10086/tcp \
   -p 51820:51820/udp \
   --cap-add NET_ADMIN \
-  donaldzou/wgdashboard:latest
+  ghcr.io/wgdashboard/wgdashboard:latest
 ```
 
 > ⚠️ The default WireGuard port is `51820/udp`. If you change this, update the `/etc/wireguard/wg0.conf` accordingly.
@@ -58,23 +62,24 @@ You can also use Docker Compose for easier configuration:
 ```yaml
 services:
   wgdashboard:
-    image: donaldzou/wgdashboard:latest
+    image: ghcr.io/wgdashboard/wgdashboard:latest
     restart: unless-stopped
     container_name: wgdashboard
-    environment:
+
-      # - tz=Europe/Amsterdam
-      # - global_dns=1.1.1.1
-      # - public_ip=YOUR_PUBLIC_IP
     ports:
       - 10086:10086/tcp
       - 51820:51820/udp
+
     volumes:
+      - aconf:/etc/amnezia/amneziawg
       - conf:/etc/wireguard
       - data:/data
+
     cap_add:
       - NET_ADMIN
 
 volumes:
+  aconf:
   conf:
   data:
 ```
@@ -85,7 +90,7 @@ volumes:
 
 ## 🔄 Updating the Container
 
-Updating WGDashboard is currently in **alpha** stage. While the update process may work, it's still under testing.
+Updating the WGDashboard container should be through 'The Docker Way' - by pulling the newest/newer image and replacing this old one.
 
 ---
 

docker/compose.yaml

@@ -1,22 +1,41 @@
 services:
-  wireguard-dashboard:
+  wgdashboard:
-    image: donaldzou/wgdashboard:latest
+    # Since the github organisation we recommend the ghcr.io.
+    # Alternatively we also still push to docker.io under donaldzou/wgdashboard.
+    # Both share the exact same tags. So they should be interchangable.
+    image: ghcr.io/wgdashboard/wgdashboard:latest
+
+    # Make sure to set the restart policy. Because for a VPN its important to come back IF it crashes.
     restart: unless-stopped
     container_name: wgdashboard
+
+    # Environment variables can be used to configure certain values at startup. Without having to configure it from the dashboard.
+    # By default its all disabled, but uncomment the following lines to apply these. (uncommenting is removing the # character)
+    # Refer to the documentation on https://wgdashboard.dev/ for more info on what everything means.
     #environment:
       #- tz=                # <--- Set container timezone, default: Europe/Amsterdam.
       #- public_ip=         # <--- Set public IP to ensure the correct one is chosen, defaulting to the IP give by ifconfig.me.
       #- wgd_port=          # <--- Set the port WGDashboard will use for its web-server.
+
+    # The following section, ports is very important for exposing more than one Wireguard/AmneziaWireguard interfaces.
+    # Once you create a new configuration and assign a port in the dashboard, don't forget to add it to the ports as well.
+    # Quick-tip: most Wireguard VPN tunnels use UDP. WGDashboard uses HTTP, so tcp.
     ports:
       - 10086:10086/tcp
       - 51820:51820/udp
+
+    # Volumes can be configured however you'd like. The default is using docker volumes.
+    # If you want to use local paths, replace the path before the : with your path.
     volumes:
       - aconf:/etc/amnezia/amneziawg
       - conf:/etc/wireguard
       - data:/data
+
+    # Needed for network administration.
     cap_add:
       - NET_ADMIN
 
+# The following configuration is linked to the above default volumes.
 volumes:
   aconf:
   conf:

docker/entrypoint.sh

@@ -105,7 +105,7 @@ ensure_installation() {
   echo "Looks like the installation succeeded. Moving on."
 
   # Setup WireGuard if needed
-  if [ ! -f "/etc/wireguard/wg0.conf" ]; then
+  if [ -z "$(ls -A /etc/wireguard)" ]; then
     cp -a "/configs/wg0.conf.template" "/etc/wireguard/wg0.conf"
 
     echo "Setting a secure private key."

src/modules/PeerJobs.py

@@ -184,7 +184,7 @@ class PeerJobs:
                                   f"Somehow can't find this peer {job.Peer} from {c.Name} failed {job.Action}ed."
                                   )
             else:
-                current_app.logger.warning(f"Somehow can't find this peer {job.Peer} from {c.Name} failed {job.Action}ed.")
+                current_app.logger.warning(f"Somehow can't find this peer {job.Peer} from {job.Configuration} failed {job.Action}ed.")
                 self.JobLogger.log(job.JobID, False,
                               f"Somehow can't find this peer {job.Peer} from {job.Configuration} failed {job.Action}ed."
                               )

src/static/app/package.json

@@ -13,7 +13,7 @@
   },
   "dependencies": {
     "@volar/language-server": "2.4.23",
-    "@vue/language-server": "3.0.5",
+    "@vue/language-server": "3.1.0",
     "@vuepic/vue-datepicker": "^11.0.2",
     "@vueuse/core": "^13.5.0",
     "@vueuse/shared": "^13.5.0",
@@ -27,20 +27,20 @@
     "fuse.js": "^7.0.0",
     "i": "^0.3.7",
     "is-cidr": "^5.0.3",
-    "npm": "^10.5.0",
+    "npm": "^11.6.1",
     "ol": "^10.2.1",
     "pinia": "^3.0.3",
     "pinia-plugin-persistedstate": "^4.5.0",
     "qrcode": "^1.5.3",
     "qrcodejs": "^1.0.0",
     "simple-code-editor": "^2.0.9",
-    "uuid": "^11.1.0",
+    "uuid": "^13.0.0",
-    "vue": "^3.5.17",
+    "vue": "^3.5.22",
     "vue-chartjs": "^5.3.0",
     "vue-router": "^4.2.5"
   },
   "devDependencies": {
     "@vitejs/plugin-vue": "^6.0.0",
-    "vite": "^7.0.5"
+    "vite": "^7.1.7"
   }
 }

src/wgd.sh

@@ -464,47 +464,6 @@ stop_wgd() {
 	fi
 }
 
-# ============= Docker Functions =============
-startwgd_docker() {
-	_checkWireguard
-	printf "[WGDashboard][Docker] WireGuard configuration started\n"
-	{ date; start_core ; printf "\n\n"; } >> ./log/install.txt
-    gunicorn_start
-}
-
-start_core() {
-	# Re-assign config_files to ensure it includes any newly created configurations
-	local config_files=$(find /etc/wireguard -type f -name "*.conf")
-	
-	# Set file permissions
-	find /etc/wireguard -type f -name "*.conf" -exec chmod 600 {} \;
-	find "$iptable_dir" -type f -name "*.sh" -exec chmod +x {} \;
-	
-	# Start WireGuard for each config file
-	for file in $config_files; do
-		config_name=$(basename "$file" ".conf")
-		wg-quick up "$config_name"
-	done
-}
-
-newconf_wgd() {
-    local wg_port_listen=$wg_port
-    local wg_addr_range=$wg_net
-    private_key=$(wg genkey)
-    public_key=$(echo "$private_key" | wg pubkey)
-    cat <<EOF >"/etc/wireguard/wg0.conf"
-[Interface]
-PrivateKey = $private_key
-Address = $wg_addr_range
-ListenPort = $wg_port_listen
-SaveConfig = true
-PostUp = /opt/wireguarddashboard/src/iptable-rules/postup.sh
-PreDown = /opt/wireguarddashboard/src/iptable-rules/postdown.sh
-EOF
-}
-
-# ============= Docker Functions =============
-
 start_wgd_debug() {
 	_checkWireguard
 	printf "[WGDashboard] Starting WGDashboard in the foreground.\n"

templates/wg-dashboard.ini.template

@@ -0,0 +1,59 @@
+[Peers]
+remote_endpoint = <your-public-ip>
+peer_global_dns = <your-chosen-dns>
+peer_endpoint_allowed_ip = 0.0.0.0/0
+peer_display_mode = grid
+peer_mtu = 1420
+peer_keep_alive = 21
+
+[Server]
+app_port = 10086
+wg_conf_path = /etc/wireguard
+awg_conf_path = /etc/amnezia/amneziawg
+app_prefix =
+app_ip = 0.0.0.0
+auth_req = true
+version = v4.3.0.1
+dashboard_refresh_interval = 60000
+dashboard_peer_list_display = grid
+dashboard_sort = status
+dashboard_theme = dark
+dashboard_api_key = false
+dashboard_language = en-US
+
+[Account]
+username = admin
+password = $2b$12$nWgPW.4adylN2oMhTyS5AeoiAvDj9SZxnXS.lCMkJYCV6jytmHKzu
+enable_totp = false
+totp_verified = false
+totp_key = UOXAUPDDUNFTTHXZNQI4J4BWCEJZ63HF
+
+[Other]
+welcome_session = true
+
+[Database]
+type = sqlite
+host =
+port =
+username =
+password =
+
+[Email]
+server =
+port =
+encryption =
+username =
+email_password =
+authentication_required = true
+send_from =
+email_template =
+
+[OIDC]
+admin_enable = false
+client_enable = false
+
+[Clients]
+enable = true
+
+[WireGuardConfiguration]
+autostart =