wg-dash

README

WireGuard Dashboard

---

• Binary: Releases
• Docker: Container Packages

Run WireGuard Dashboard

Default username and password are admin.

Quickstart

Prerequisities:

• docker
• docker-compose
• wireguard

git clone https://github.com/ss-o/wg-dash.git
cd wg-dash
docker-compose up

On Ubuntu Focal (x86_64):

• install docker
• install docker-compose
• install wireguard
• setup systemd

curl -L https://github.com/ss-o/wg-dash/raw/main/quickstart.sh | bash

Using docker-compose

docker-compose.yml

version: '3.3'

services:
  wg:
    image: ghcr.io/ss-o/wg-dash:latest
    container_name: wg-dash
    environment:
#   To use sendgrid uncomment and fill bellow.
#       SENDGRID_API_KEY: "Your sendgrid api key"
#       EMAIL_FROM: "the email address you registered on sendgrid"
#       EMAIL_FROM_NAME: "the sender's email address"
       SESSION_SECRET: "YourRandomSessionSecret"
    ports:
      - 5000:5000
    logging:
      driver: json-file
      options:
        max-size: 50m
    volumes:
      - ./db:/app/db
      - /etc/wireguard:/etc/wireguard # Recommended mount point
    restart: unless-stopped

Deploy: docker-compose up -d

Using binary file

Download the binary file from the release and run it with command:

sudo ./wg-dash

Setup Services

• Systemd
• Openrc

Build

Build docker image

docker build -t wg-dash .

Build binary file

# With NPM
npm run build
# With Yarn
yarn build

Or, append resources to executable as zip file

go build -o wg-dash
rice append --exec wg-dash

Screenshots

License

MIT. See LICENSE.

References

• Visit ngoduykhanh/wireguard-ui