panel

Admin Panel

The Admin Panel is a web-based interface for managing WireGuard VPN servers and clients. It provides a user-friendly way to configure WireGuard, manage users, and monitor connections.

Overview

The Admin Panel offers the following features:

• WireGuard server configuration management
• Client configuration generation and management
• User authentication and authorization
• Email notifications
• API endpoints for integration with other systems
• QR code generation for easy client setup

Directory Structure

panel/
├── assets/              # Static assets (CSS, JS, images)
├── custom/              # Custom UI components
│   ├── img/             # Custom images
│   └── js/              # Custom JavaScript
├── db/                  # Database related code
├── emailer/             # Email sending functionality
├── handler/             # HTTP request handlers
├── model/               # Data models
├── router/              # HTTP routing
├── store/               # Data storage
│   └── jsondb/          # JSON database implementation
├── templates/           # HTML templates
├── util/                # Utility functions
├── Dockerfile           # Docker container definition
├── docker-compose.yaml  # Docker Compose configuration
├── go.mod               # Go module definition
├── go.sum               # Go module checksums
├── init.sh              # Initialization script
├── main.go              # Application entry point
├── package.json         # Node.js dependencies
├── prepare_assets.sh    # Asset preparation script
└── yarn.lock            # Yarn dependency lock file

Prerequisites

• Go 1.16 or later (for building from source)
• Docker and Docker Compose (for containerized deployment)
• WireGuard installed on the host system
• Node.js and Yarn (for frontend development)

Setup Instructions

Using Docker (Recommended)

1. Clone the repository

git clone <repository-url>
cd panel

1. Configure environment variables

Create a .env file with the necessary environment variables (see Environment Variables section below).

1. Start the container

docker compose up -d

Building from Source

1. Clone the repository

git clone <repository-url>
cd panel

1. Prepare assets

./prepare_assets.sh

1. Build the application

go build -o dedicated-ip-panel

1. Run the application

./dedicated-ip-panel

Usage

1. Access the web interface at http://localhost:80 (or the configured port)
2. Log in with the configured credentials
3. Configure your WireGuard server settings
4. Create and manage client configurations

Environment Variables

Defaults for server configuration

These environment variables are used to control the default server settings used when initializing the database.

Defaults for new clients

These environment variables are used to set the defaults used in New Client dialog.

Docker only

These environment variables only apply to the docker container.

Auto restart WireGuard daemon

dedicated-ip-panel 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

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

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

systemctl enable wgui.{path,service}
systemctl start wgui.{path,service}

Using openrc

Create /usr/local/bin/wgui file and make it executable

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

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

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:

docker build --build-arg=GIT_COMMIT=$(git rev-parse --short HEAD) -t dedicated-ip-panel .

or

docker compose build --build-arg=GIT_COMMIT=$(git rev-parse --short HEAD)

ℹ A container image is available on Docker Hub which you can pull and use

docker pull AshkanYarmoradi/dedicated-ip/panel

Build binary file

Prepare the assets directory

./prepare_assets.sh

Then build your executable

go build -o dedicated-ip-panel