WGDashboard

https://docs.wgdashboard.dev/
Admin
WGDashboard is a web-based dashboard application for managing and monitoring WireGuard VPN...
Tokens:28,937
Snippets:256
Trust Score:6.3
Update:1 week ago
Show doc for...
Tokens:
Raw
### Install WGDashboard

Source: https://docs.wgdashboard.dev/install

Makes the installation script executable and runs it with sudo to install WGDashboard.

```shell
sudo chmod u+x wgd.sh && \
sudo ./wgd.sh install
```

--------------------------------

### Enable and start the service

Source: https://docs.wgdashboard.dev/guides/Run-WGDashboard-As-A-System-Service.html

Set permissions, reload systemd, enable the service to start on boot, and start it immediately. The comment indicates the start command.

```bash
$ sudo chmod 664 /etc/systemd/system/wg-dashboard.service
$ sudo systemctl daemon-reload
$ sudo systemctl enable wg-dashboard.service
$ sudo systemctl start wg-dashboard.service  # <-- To start the service
```

--------------------------------

### Start WGDashboard with ./wgd.sh start

Source: https://docs.wgdashboard.dev/guides/Use-SSL-TLS-With-WGDashboard.html

Starts WGDashboard in the background with Gunicorn. The output shows the expected startup messages, including the Gunicorn URL (0.0.0.0:10086) and log file paths.

```bash
$ ./wgd.sh start
=================================================================================
+          <WGDashboard> by Donald Zou - https://github.com/donaldzou           +
=================================================================================
[WGDashboard] ✅ WireGuard is already installed.
[WGDashboard] Starting WGDashboard with Gunicorn in the background.
[WGDashboard] Initialized Configuration: wg1
[Gunicorn] WGDashboard w/ Gunicorn will be running on 0.0.0.0:10086
[Gunicorn] Access log file is at ./log/access_2025_04_23_21_55_34.log
[Gunicorn] Error log file is at ./log/error_2025_04_23_21_55_34.log
[WGDashboard] Checking if WGDashboard w/ Gunicorn started successfully
[WGDashboard] WGDashboard w/ Gunicorn started successfully
---------------------------------------------------------------------------------
```

--------------------------------

### Start WGDashboard

Source: https://docs.wgdashboard.dev/install

Starts the WGDashboard service using the wgd.sh script.

```shell
sudo ./wgd.sh start
```

--------------------------------

### Example service status output

Source: https://docs.wgdashboard.dev/guides/Run-WGDashboard-As-A-System-Service.html

Example output from the status command showing the service is active and running, with log lines indicating successful startup.

```shell
 ● wg-dashboard.service
 Loaded: loaded (/etc/systemd/system/wg-dashboard.service; enabled; vendor preset: enabled)
 Active: active (running) since Wed 2024-08-14 22:21:47 EDT; 55s ago
 Process: 494968 ExecStart=/root/WGDashboard/src/wgd.sh start (code=exited, status=0/SUCCESS)
 Main PID: 495005 (gunicorn)
 Tasks: 5 (limit: 4523)
 Memory: 36.8M
 CPU: 789ms
 CGroup: /system.slice/wg-dashboard.service
 ├─495005 /root/WGDashboard/src/venv/bin/python3 ./venv/bin/gunicorn --config ./gunicorn.conf.py
 └─495007 /root/WGDashboard/src/venv/bin/python3 ./venv/bin/gunicorn --config ./gunicorn.conf.py
 
 Aug 14 22:21:40 wg sudo[494978]:     root : PWD=/root/WGDashboard/src ; USER=root ; COMMAND=./venv/bin/gunicorn --config ./gunicorn.conf.py
 Aug 14 22:21:40 wg sudo[494978]: pam_unix(sudo:session): session opened for user root(uid=0) by (uid=0)
 Aug 14 22:21:40 wg wgd.sh[494979]: [WGDashboard] WGDashboard w/ Gunicorn will be running on 0.0.0.0:10086
 Aug 14 22:21:40 wg wgd.sh[494979]: [WGDashboard] Access log file is at ./log/access_2024_08_14_22_21_40.log
 Aug 14 22:21:40 wg wgd.sh[494979]: [WGDashboard] Error log file is at ./log/error_2024_08_14_22_21_40.log
 Aug 14 22:21:40 wg sudo[494978]: pam_unix(sudo:session): session closed for user root
 Aug 14 22:21:45 wg wgd.sh[494968]: [WGDashboard] Checking if WGDashboard w/ Gunicorn started successfully
 Aug 14 22:21:47 wg wgd.sh[494968]: [WGDashboard] WGDashboard w/ Gunicorn started successfully
 Aug 14 22:21:47 wg wgd.sh[494968]: ------------------------------------------------------------
 Aug 14 22:21:47 wg systemd[1]: Started wg-dashboard.service.
```

--------------------------------

### Install WGDashboard on Alpine Linux 3.20.2

Source: https://docs.wgdashboard.dev/install

For Alpine Linux 3.20.2, this command sets up interfaces, installs WireGuard tools, Python, and other dependencies, then clones and installs WGDashboard.

```shell
setup-interfaces -a ; \
rc-service networking --quiet start ; \
apk update ; \
apk add wireguard-tools python3 python3-dev git iptables net-tools gcc musl-dev linux-headers sudo ; \
git clone https://github.com/WGDashboard/WGDashboard.git ; \
cd ./WGDashboard/src ; \
chmod +x ./wgd.sh ; \
./wgd.sh install
```

--------------------------------

### Install WGDashboard on Fedora 38, 39, 40, 41

Source: https://docs.wgdashboard.dev/install

For Fedora versions 38-41, this command installs WireGuard tools, net-tools, and git, then clones and installs WGDashboard.

```shell
sudo yum install wireguard-tools net-tools git -y && \
git clone https://github.com/WGDashboard/WGDashboard.git && \
cd ./WGDashboard/src && \
chmod +x ./wgd.sh && \
./wgd.sh install && \
sudo echo "net.ipv4.ip_forward=1" >> /etc/sysctl.conf && \
sudo sysctl -p /etc/sysctl.conf
```

--------------------------------

### Install WGDashboard on Debian 11.10

Source: https://docs.wgdashboard.dev/install

For Debian 11.10, this command installs sudo, git, build tools, Python 3.10, and WGDashboard. It compiles Python from source and then runs the installation script.

```shell
apt-get install sudo -y && \ 
sudo apt-get update && \ 
sudo apt install -y git iptables build-essential zlib1g-dev libncurses5-dev libgdbm-dev libnss3-dev libssl-dev libreadline-dev libffi-dev libsqlite3-dev wget libbz2-dev wireguard-tools net-tools && \ 
wget https://www.python.org/ftp/python/3.10.0/Python-3.10.0.tgz && \ 
tar -xvf Python-3.10.0.tgz && \ 
cd Python-3.10.0 && \ 
sudo ./configure --enable-optimizations && \ 
sudo make && \ 
sudo make altinstall && \ 
cd .. && \ 
git clone https://github.com/WGDashboard/WGDashboard.git && \ 
cd ./WGDashboard/src && \ 
chmod +x ./wgd.sh && \ 
./wgd.sh install && \ 
sudo echo "net.ipv4.ip_forward=1" >> /etc/sysctl.conf && \
sudo sysctl -p /etc/sysctl.conf
```

--------------------------------

### Install WGDashboard on Debian 12.6 and 13.0

Source: https://docs.wgdashboard.dev/install

For Debian 12.6 and 13.0, this command installs sudo, git, iptables, WireGuard tools, and net-tools, then clones and installs WGDashboard.

```shell
apt-get install sudo git iptables -y && \ 
sudo apt-get update && \
sudo apt install wireguard-tools net-tools && \
git clone https://github.com/WGDashboard/WGDashboard.git && \
cd ./WGDashboard/src && \
chmod +x ./wgd.sh && \
./wgd.sh install && \
sudo echo "net.ipv4.ip_forward=1" >> /etc/sysctl.conf && \
sudo sysctl -p /etc/sysctl.conf
```

--------------------------------

### Install WGDashboard on Red Hat Enterprise Linux 9.4

Source: https://docs.wgdashboard.dev/install

For RHEL 9.4, this command installs WireGuard tools, net-tools, git, and Python 3.11, then clones and installs WGDashboard. It also opens firewall ports 10086/tcp and 51820/udp.

```shell
sudo yum install wireguard-tools net-tools git python3.11 -y && \
git clone https://github.com/WGDashboard/WGDashboard.git && \
cd ./WGDashboard/src && \
chmod +x ./wgd.sh && \
./wgd.sh install && \
sudo echo "net.ipv4.ip_forward=1" >> /etc/sysctl.conf && \
sudo sysctl -p /etc/sysctl.conf && \
firewall-cmd --add-port=10086/tcp --permanent && \
firewall-cmd --add-port=51820/udp --permanent && \
firewall-cmd --reload
```

--------------------------------

### Install WGDashboard on Ubuntu 22.04, 24.04, and 24.10

Source: https://docs.wgdashboard.dev/install

Run these commands to install WireGuard tools, net-tools, and WGDashboard on Ubuntu LTS versions. The script enables IP forwarding via sysctl.

```shell
sudo apt-get update -y && \
sudo apt install wireguard-tools net-tools --no-install-recommends -y && \
git clone https://github.com/WGDashboard/WGDashboard.git && \
cd ./WGDashboard/src && \
chmod +x ./wgd.sh && \
./wgd.sh install && \
sudo echo "net.ipv4.ip_forward=1" >> /etc/sysctl.conf && \
sudo sysctl -p /etc/sysctl.conf
```

--------------------------------

### Dockerfile Stage: Final Alpine Container Setup

Source: https://docs.wgdashboard.dev/install/Docker.html

Final stage of the Dockerfile that sets up the Alpine container, copies binaries and source files, installs dependencies, exposes port 10086, and sets the entrypoint.

```dockerfile
FROM alpine:latest
COPY --from=bins ...
RUN apk update && apk add --no-cache ...
COPY ./src ${WGDASH}/src
COPY ./docker/entrypoint.sh /entrypoint.sh
...
EXPOSE 10086
ENTRYPOINT ["/bin/bash", "/entrypoint.sh"]
```

--------------------------------

### Manual update steps (Solution 2)

Source: https://docs.wgdashboard.dev/Update.html

Use these commands if the script update fails. Change to the wgdashboard/src directory, pull the latest code with git, then run the install script.

```shell
cd wgdashboard/src
```

```shell
git pull https://github.com/WGDashboard/WGDashboard.git --force
```

```shell
sudo ./wgd.sh install
```

--------------------------------

### ifconfig output showing eth0 and lo interfaces

Source: https://docs.wgdashboard.dev/faq/WireGuard-Configuration-Example.html

Example output from running 'ifconfig'. Look for the interface with the IP address you want (inet); in the example it is eth0.

```bash
root@iZxpek3vn1di7xZ:~# ifconfig
eth0: flags=4163<UP,BROADCAST,RUNNING,MULTICAST>  mtu 1500
        inet 172.18.62.60  netmask 255.255.192.0  broadcast 172.18.63.255
        inet6 fe80::216:3eff:fe01:f43c  prefixlen 64  scopeid 0x20<link>
        ether 00:16:3e:01:f4:3c  txqueuelen 1000  (Ethernet)
        RX packets 858900  bytes 668327533 (668.3 MB)
        RX errors 0  dropped 0  overruns 0  frame 0
        TX packets 673313  bytes 409479887 (409.4 MB)
        TX errors 0  dropped 0 overruns 0  carrier 0  collisions 0

lo: flags=73<UP,LOOPBACK,RUNNING>  mtu 65536
        inet 127.0.0.1  netmask 255.0.0.0
        inet6 ::1  prefixlen 128  scopeid 0x10<host>
        loop  txqueuelen 1000  (Local Loopback)
        RX packets 212734  bytes 11607282 (11.6 MB)
        RX errors 0  dropped 0  overruns 0  frame 0
        TX packets 212734  bytes 11607282 (11.6 MB)
        TX errors 0  dropped 0 overruns 0  carrier 0  collisions 0
...
```

--------------------------------

### GET /api/handshake

Source: https://docs.wgdashboard.dev/api

Example of making a GET request to the handshake endpoint with an API key in the header. This demonstrates the authentication method for all API calls.

```APIDOC
## [GET] /api/handshake

### Description
Example of a GET request to the handshake endpoint, demonstrating the use of the API key in the HTTP header.

### Method
GET

### Endpoint
/api/handshake

### Parameters
#### Headers
- **wg-dashboard-apikey** (string) - Required - The API key obtained from the dashboard settings.

### Request Example
```javascript
fetch('http://server:10086/api/handshake', {
    headers: {
       'content-type': 'application/json',
        'wg-dashboard-apikey': 'insert your api key here'
    },
    method: "GET"
})
```

### Response
No response details provided in the source.
```

--------------------------------

### Example Output of docker images

Source: https://docs.wgdashboard.dev/install/Docker.html

Shows the expected output of the 'docker images' command after building the WGDashboard image, displaying the repository, tag, image ID, creation time, and size.

```shell
docker images

REPOSITORY           TAG       IMAGE ID       CREATED             SIZE
yourname/wgdashboard latest    c96fd96ee3b3   42 minutes ago      314MB
```

--------------------------------

### Rendered email body example

Source: https://docs.wgdashboard.dev/guides/Email-Service.html

Shows the output of the email body template after rendering with the example peer and configurationFile variables. Note that the peer name is empty and the configuration file content is displayed with actual newlines.

```text
Hi,

Your WireGuard configuration is ready with the name "", and its allowed IP address is: 10.0.0.3/32, 2001:db8:64:49::3/128.

Please see the attached configuration file "UntitledPeer" and open it on your iPhone with the WireGuard app. If you can't, please copy the following lines into a raw .conf file and send it to your phone:

------- Configuration start below this line -------

[Interface]
PrivateKey = ABgsivKkBd6K9LizqHm/pDjfq2HRNESjdJBIz4RMlkE=
Address = 10.0.0.3/32, 2001:db8:64:49::3/128
MTU = 1420

[Peer]
PublicKey = upH8PMbMzpcynJXz09Vldye09vzAmmNRV40hR+Vhbyw=
AllowedIPs = 0.0.0.0/0
Endpoint = vpn.example.com:51823
PersistentKeepalive = 21


------- Configuration end below this line -------

Best,
Donald Zou
```

--------------------------------

### Start WGDashboard in background

Source: https://docs.wgdashboard.dev/Usage.html

Runs WGDashboard in the background. Assumes you are in the WGDashboard/src directory.

```shell
./wgd.sh start
```

--------------------------------

### OIDC Provider Configuration Example with Authentik

Source: https://docs.wgdashboard.dev/guides/Client-Side-App.html

Example configuration for an OIDC provider using authentik. Replace 'Provider' with a custom name and provide valid client_id, client_secret, and issuer. Ensure redirect URL is set to http://wgd_host:port/client.

```json
{
    "Client": {
        "Provider": {
            "client_id": "1Iaesod8Cmqe660yxr3koyV1FxBnHGDjGR7fHlaw",
            "client_secret": "Xy6Lt9uYYLiurnK0UdjaEEdgmukiahFJ7jBXdxUzaWwvarG3JEdTxngQOs618yLCnegM4rYi1EyBSvMdkH2Dtwsu3B7qnaVQbOBoKFjlHIb0HLr0gAJ0SUnA4tP7vHq4",
            "issuer": "http://localhost:9000/application/o/wg-dashboard/"
        }
    }
}
```

--------------------------------

### Example of configurationFile variable JSON

Source: https://docs.wgdashboard.dev/guides/Email-Service.html

Shows the structure of the configurationFile variable available in the email template. Contains the file name and the raw configuration file content as a string with escaped newlines.

```json
{ 
  "fileName": "UntitledPeer", 
  "file": "[Interface]\nPrivateKey = ABgsivKkBd6K9LizqHm/pDjfq2HRNESjdJBIz4RMlkE=\nAddress = 10.0.0.3/32, 2001:db8:64:49::3/128\nMTU = 1420\n\n[Peer]\nPublicKey = upH8PMbMzpcynJXz09Vldye09vzAmmNRV40hR+Vhbyw=\nAllowedIPs = 0.0.0.0/0\nEndpoint = vpn.example.com:51823\nPersistentKeepalive = 21\n"
}
```

--------------------------------

### WireGuard server configuration (ini)

Source: https://docs.wgdashboard.dev/case-study/Case-Study-2-Split-Tunnel-with-WireGuard.html

Example WireGuard server configuration with private key, address, DNS, MTU, and peer settings. This is the base configuration managed by WGDashboard.

```ini
[Interface]
PrivateKey = QGA1K4NUMHa7HoYbI7Ppmmo39606xxkepvv0if++x3c=
Address = 10.20.0.1/32
DNS = 8.8.8.8
MTU = 1420

[Peer]
PublicKey = 4y1WQJ7As8Ttmc3nBkESZsaPTogSh/u+SX+ETg1CjCI=
AllowedIPs = 10.20.0.0/24
Endpoint = wg.server:51820
PersistentKeepalive = 21
```

--------------------------------

### Example of peer variable JSON

Source: https://docs.wgdashboard.dev/guides/Email-Service.html

Shows the structure of the peer variable available in the email template. Contains peer configuration details such as allowed IPs, endpoint, and keys.

```json
{
   "DNS": "",
   "ShareLink": [],
   "allowed_ip": "10.0.0.3/32, 2001:db8:64:49::3/128",
   "configuration": {
      "Address": "10.0.0.1/28, 2001:db8:64:49::1/64",
      "ConnectedPeers": 0,
      "DataUsage": {
         "Receive": 0,
         "Sent": 0,
         "Total": 0
      },
      "ListenPort": "51823",
      "Name": "wg-external",
      "PostDown": "",
      "PostUp": "",
      "PreDown": "",
      "PreUp": "",
      "PrivateKey": "aC98hORPAbbxXZmy8qy1JP9Ip3JtEhbjDTOGtgHvmmg=",
      "Protocol": "wg",
      "PublicKey": "upH8PMbMzpcynJXz09Vldye09vzAmmNRV40hR+Vhbyw=",
      "SaveConfig": true,
      "Status": true,
      "TotalPeers": 13
   },
   "cumu_data": 0,
   "cumu_receive": 0,
   "cumu_sent": 0,
   "endpoint": "(none)",
   "endpoint_allowed_ip": "0.0.0.0/0",
   "id": "Wu/0xCr+n/caqDVKtjG+C9UelAvY/beARX3cW1i7LUI=",
   "jobs": [],
   "keepalive": 21,
   "latest_handshake": "No Handshake",
   "mtu": 1420,
   "name": "",
   "preshared_key": "",
   "private_key": "ABgsivKkBd6K9LizqHm/pDjfq2HRNESjdJBIz4RMlkE=",
   "remote_endpoint": "wg.local",
   "status": "stopped",
   "total_data": 0,
   "total_receive": 0,
   "total_sent": 0
}
```

--------------------------------

### Restart WGDashboard in background

Source: https://docs.wgdashboard.dev/Usage.html

Stops and starts WGDashboard in the background. Assumes you are in the WGDashboard/src directory.

```shell
./wgd.sh restart
```

--------------------------------

### Fetch API handshake with API key header

Source: https://docs.wgdashboard.dev/api

Example of calling the /api/handshake endpoint using fetch with the required 'wg-dashboard-apikey' header. Replace 'insert your api key here' with your actual API key.

```javascript
fetch('http://server:10086/api/handshake', {
    headers: {
       'content-type': 'application/json',
        'wg-dashboard-apikey': 'insert your api key here'
    },
    method: "GET"
})
```

--------------------------------

### Dockerfile Stage: Build Tools and Go Compilation

Source: https://docs.wgdashboard.dev/install/Docker.html

First stage of the Dockerfile that uses golang:1.24 as the compiler, installs build tools, and compiles the Go components. The ellipses indicate omitted commands.

```dockerfile
FROM golang:1.24 AS compiler
WORKDIR /go

RUN apt-get update && apt-get install -y ...
RUN git clone ... && make
...
```

--------------------------------

### Email body template example

Source: https://docs.wgdashboard.dev/guides/Email-Service.html

A sample Jinja template for the email body. It uses the peer and configurationFile variables to generate a message with the peer name, allowed IP, and the configuration file content.

```text
Hi,

Your WireGuard configuration is ready with the name "{{ peer.name }}", and its allowed IP address is: {{ peer.allowed_ip }}.

Please see the attached configuration file "{{ configurationFile.fileName }}" and open it on your iPhone with the WireGuard app. If you can't, please copy the following lines into a raw .conf file and send it to your phone:

------- Configuration start below this line -------

{{ configurationFile.file }}

------- Configuration end below this line -------

Best,
Donald Zou
```

--------------------------------

### Get full path of dashboard directory

Source: https://docs.wgdashboard.dev/guides/Run-WGDashboard-As-A-System-Service.html

Print the current working directory to obtain the absolute path needed for the service file. The output shown is an example; your path may differ.

```shell
pwd
#Output: /root/WGDashboard/src
```

--------------------------------

### Enable Nginx site and test configuration

Source: https://docs.wgdashboard.dev/guides/Use-SSL-TLS-With-WGDashboard.html

Enables the WGDashboard Nginx site by creating a symbolic link and tests the Nginx configuration with `nginx -t`. If no errors are shown, proceed to restart Nginx.

```bash
$ sudo ln -s /etc/nginx/sites-available/wgdashboard /etc/nginx/sites-enabled
$ sudo nginx -t
```

--------------------------------

### Plugin entry point main.py

Source: https://docs.wgdashboard.dev/experimental-features/WGDashboard-Plugins.html

Create a Python file named main.py in your plugin folder. Define a function called main that takes one parameter, a dictionary of WireGuard configurations. This allows you to read the latest data of your WireGuard configurations.

```python
# main.py
def main(WireguardConfigurations: dict[str, object] = None):
   pass
```

--------------------------------

### Webhook Payload Example (JSON)

Source: https://docs.wgdashboard.dev/guides/WebHooks.html

Example JSON payload sent to the webhook URL when a subscribed event occurs. Contains configuration name, peer public keys, action type, timestamp, and webhook identifiers. Only public information is exposed.

```json
{
    "configuration": "Aa1",
    "peers": [
        "D2F7tP1sXbhT7ye2tl4aDoBk+tpiOZAvU4Jw8Jt3W0g="
    ],
    "action": "peer_created",
    "time": "2025-09-03 17:10:51",
    "webhook_id": "b1d5a1b1-b2e5-430d-a366-076a50300cdc",
    "webhook_session": "2d6d536d-2e7a-4382-9c20-339c68148cdc"
}
```

--------------------------------

### Build WGDashboard Docker Image from Source

Source: https://docs.wgdashboard.dev/install/Docker.html

Clones the WGDashboard repository and builds the Docker image using the provided Dockerfile. The resulting image is tagged as yourname/wgdashboard:latest.

```bash
git clone https://github.com/WGDashboard/WGDashboard.git
cd WGDashboard
docker build . -f docker/Dockerfile -t yourname/wgdashboard:latest
```

--------------------------------

### OIDC Provider Configuration Template

Source: https://docs.wgdashboard.dev/guides/Client-Side-App.html

Example JSON structure for wg-dashboard-oidc-providers.json. The 'Provider' object is a placeholder; rename it to a provider name and fill in client_id, client_secret, and issuer.

```json
{
    "Client": {
        "Provider": {
            "client_id": "",
            "client_secret": "",
            "issuer": ""
        }
    }
}
```

--------------------------------

### Create Nginx config for WGDashboard (HTTP)

Source: https://docs.wgdashboard.dev/guides/Use-SSL-TLS-With-WGDashboard.html

Creates a new Nginx site configuration file for WGDashboard. The server block listens on port 80 and proxies requests to WGDashboard running on 0.0.0.0:10086. Replace [your_domain] with your actual domain.

```bash
$ sudo nano /etc/nginx/sites-available/wgdashboard
```

```nginx
server {
    server_name [your_domain];
    listen 80;
    
    location / {
        proxy_pass http://0.0.0.0:10086;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
    }
}
```

--------------------------------

### Quick Docker Run Command

Source: https://docs.wgdashboard.dev/install/Docker.html

Runs the WGDashboard container with the necessary port mappings and NET_ADMIN capability. The default WireGuard port is 51820/udp; if changed, update /etc/wireguard/wg0.conf accordingly.

```bash
docker run -d \
  --name wgdashboard \
  --restart unless-stopped \
  -p 10086:10086/tcp \
  -p 51820:51820/udp \
  --cap-add NET_ADMIN \
  ghcr.io/wgdashboard/wgdashboard:latest
```

--------------------------------

### Change directory to WGDashboard/src

Source: https://docs.wgdashboard.dev/guides/Run-WGDashboard-As-A-System-Service.html

Navigate to the dashboard's source directory where the service file is located.

```shell
cd WGDashboard/src
```

--------------------------------

### Enable IP forwarding

Source: https://docs.wgdashboard.dev/install

Optional but recommended: enables IPv4 forwarding by appending to sysctl.conf and applying the change.

```shell
sudo echo "net.ipv4.ip_forward=1" >> /etc/sysctl.conf
sudo sysctl -p /etc/sysctl.conf
```

--------------------------------

### Update via wgd.sh script (Solution 1)

Source: https://docs.wgdashboard.dev/Update.html

Run this command in the wgdashboard directory to update WGDashboard to v4.0+. This is the recommended method for v4.0+ users.

```shell
sudo ./wgd.sh update
```
Tokens:
Raw