Portainer Templates logo

Portainer Templates

Wireguard Server Wireguard Server

Stack

OtherVPN

Fast VPN Server with easy to use User Interface

Image details

Architecture: amd64, arm64, arm/v7, arm/v6
Image size: 58 MB
User: wg-easy

Source details

Repo: wg-easy/wg-easy
Stars: 26.7k
Forks: 3k
Language: TypeScript
License: AGPL-3.0
Latest: v15.4.0 · 1 day ago
Updated: 1 day ago
Website: wg-easy.github.io/wg-easy/latest/

Configuration

Type
Compose
Platform
linux
Image
ghcr.io/wg-easy/wg-easy:latest
Ports
${WG_PORT}:51820/udp51821:51821/tcp
Volumes
/etc/wireguard : /portainer/Files/AppData/Config/wireguard
Env vars
WG_HOST=${WG_HOST}PASSWORD=${PASSWORD}WG_PORT=${WG_PORT}WG_DEFAULT_ADDRESS=${WG_DEFAULT_ADDRESS}WG_DEFAULT_DNS=${WG_DEFAULT_DNS}WG_ALLOWED_IPS=${WG_ALLOWED_IPS}
Restart
unless-stopped
Source
Repo

Template by novaspirit·Source

Notes

Template created by Pi-Hosted Series
Check our Github page: https://github.com/pi-hosted/pi-hosted

Official Webpage: https://github.com/WeeJeWel/wg-easy/
Official Docker Documentation: https://github.com/WeeJeWel/wg-easy/#1-install-docker

Pi-Hosted dedicated documentation: wireguard-install.md




Youtube Video: Novaspirit Tech - Beginners Guide to WireGuard Docker and Installing Pi-OS 64bit

Standalone Install

Select an install method, to see config/commands for deploying Wireguard Server

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select Wireguard Server, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo
Original stackfile

The compose file this template deploys, straight from its repo:

version: "3.8"
services:
  wg-easy:
    environment:
      # ⚠️ Required:
      # Change this to your host's public address
      - WG_HOST=${WG_HOST}

      # Optional:
      - PASSWORD=${PASSWORD}
      - WG_PORT=${WG_PORT}
      - WG_DEFAULT_ADDRESS=${WG_DEFAULT_ADDRESS}
      - WG_DEFAULT_DNS=${WG_DEFAULT_DNS}
      - WG_ALLOWED_IPS=${WG_ALLOWED_IPS}
      
    image: ghcr.io/wg-easy/wg-easy:latest
    container_name: wg-easy
    volumes:
      - /portainer/Files/AppData/Config/wireguard:/etc/wireguard
    ports:
      - "${WG_PORT}:51820/udp"
      - "51821:51821/tcp"
    restart: unless-stopped
    cap_add:
      - NET_ADMIN
      - SYS_MODULE
    sysctls:
      - net.ipv4.ip_forward=1
      - net.ipv4.conf.all.src_valid_mark=1

Or deploy it directly from the source:

git clone https://github.com/pi-hosted/pi-hosted
cd pi-hosted
docker compose -f stack/wireguard-easy.yml up -d

More install options in our documentation, or see wg-easy/wg-easy for app-specific guidance.

WireGuard Easy

Build & Publish latest Image Lint GitHub Stars License GitHub Release Image Pulls
You have found the easiest way to install & manage WireGuard on any Linux host!

wg-easy Screenshot

Features

  • All-in-one: WireGuard + Web UI.
  • Easy installation, simple to use.
  • List, create, edit, delete, enable & disable clients.
  • Show a client's QR code.
  • Download a client's configuration file.
  • Statistics for which clients are connected.
  • Tx/Rx charts for each connected client.
  • Gravatar support.
  • Automatic Light / Dark Mode
  • Multilanguage Support
  • One Time Links
  • Client Expiration
  • Prometheus metrics support
  • IPv6 support
  • CIDR support
  • 2FA support
  • Per-client firewall filtering (requires iptables)
  • OIDC support (Google, GitHub, Authelia, Authentik, etc.)

!NOTE To better manage documentation for this project, it has its own site here: https://wg-easy.github.io/wg-easy/latest


!NOTE If you want to migrate from the old version to the new version, you can find the migration guide here: Migration Guide

Installation

This is a quick start guide to get you up and running with WireGuard Easy.
For a more detailed installation guide, please refer to the Getting Started page.

  1. Install Docker

If you haven't installed Docker yet, install it by running as root:
curl -sSL https://get.docker.com | sh
exit

And log in again.

  1. Run WireGuard Easy

The easiest way to run WireGuard Easy is with Docker Compose.
Just follow these steps in the detailed documentation.
You can also install WireGuard Easy with the docker run command or via podman.
Now setup a reverse proxy to be able to access the Web UI securely from the internet. This step is optional, just make sure to follow the guide here if you decide not to do it.

Donate

Are you enjoying this project? Consider donating.
Founder: Buy Emile a beer! 🍻
Maintainer: Buy kaaax0815 a coffee! ☕

Development

Prerequisites

  • Docker
  • Node LTS & corepack enabled
  • Visual Studio Code

Dev Server

This starts the development server with docker
pnpm dev

Update Auto Imports

If you add something that should be auto-importable and VSCode complains, run:
cd src
pnpm install
cd ..

Test Cli

This starts the cli with docker
pnpm cli:dev

License

This project is licensed under the AGPL-3.0-only License - see the LICENSE file for details
This project is not affiliated, associated, authorized, endorsed by, or in any way officially connected with Jason A. Donenfeld, ZX2C4 or Edge Security
"WireGuard" and the "WireGuard" logo are registered trademarks of Jason A. Donenfeld

Serve Wireguard Server on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying wireguard-server.example.com to http://wg-easy:51821

Add this to your Caddyfile

wireguard-server.example.com {
	reverse_proxy http://wg-easy:51821
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs <container>
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Port already in use

If deployment fails with "Bind for 0.0.0.0:51821 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :51821
  • Stop the other service, or pick a different host port. In 51821:51821 only the left number is yours to change, the right one belongs to the app.

Running but the page won't load

The container is up but nothing appears in your browser.

  • Use your server's real IP: http://your-server-ip:51821. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, wg-easy can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 51821

Permission denied on volumes

If the logs show "permission denied", the app can't write to its data folder on the host.

  • Fix the ownership: sudo chown -R 1000:1000 /portainer/Files/AppData/Config/wireguard

Image won't pull

Test the pull directly on the host: docker pull ghcr.io/wg-easy/wg-easy:latest

  • "manifest unknown" means the tag no longer exists. This template uses latest, so try pinning a specific version instead.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • This image supports: amd64, arm64, arm/v7, arm/v6
  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.

  • Check the logs right after a restart, the last few lines before it died are the useful ones.
  • Get the exit code with docker inspect <container> --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Stack won't deploy

Compose stacks fail fast on small mistakes, and Portainer shows the reason just above the editor.

  • YAML only accepts spaces for indentation, a single tab breaks the whole file.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A Compose stack

Wireguard Server is a Compose stack, a set of containers defined in one file and brought up together by Portainer, then started and stopped as a single app.

The app image

An image is the app packed up ready to go, everything Wireguard Server needs bundled into one download. This template pulls ghcr.io/wg-easy/wg-easy:latest, which Docker fetches once (about 58 MB) and then starts your own copy from.

Where the image comes from

Docker pulls its images from registries, public libraries of ready-built apps. Wireguard Server's comes from the GitHub Container Registry, published by wg-easy.

Version tags

The bit after the colon in the image name is the version tag. Here it's latest, which always points at the newest build, so a redeploy can bump you to a newer release without you asking. Pin a specific tag if you would rather stay on one version.

Which machines it runs on

Every image is built for particular CPU types. This one ships for amd64, arm64, arm/v7, arm/v6, so it runs on both regular x86 servers and ARM boards like a Raspberry Pi.

Ports

A port is the door the app answers on. A mapping like 51821:51821 means it's reachable on port 51821 of your server, where the left number is yours to change and the right one belongs to the app. It opens:

  • 51821:51821

Volumes

A volume is where Wireguard Server keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /etc/wireguard from /portainer/Files/AppData/Config/wireguard on the host

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Wireguard Server takes 6 of them, all with defaults you can leave alone or tweak:

  • WG_HOST, pulled from your own environment. Set here your DDNS domain
  • PASSWORD, pulled from your own environment. Leave blank to access WebUI without loggin
  • WG_PORT, pulled from your own environment
  • WG_DEFAULT_ADDRESS, pulled from your own environment
  • WG_DEFAULT_DNS, pulled from your own environment
  • WG_ALLOWED_IPS, pulled from your own environment

Restart policy

The restart policy here is unless-stopped, so Docker restarts Wireguard Server after a crash or reboot, but leaves it off when you stop it on purpose. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).

Networking

Nothing custom is set, so Wireguard Server sits on Docker's default bridge network: its own private space that reaches the outside world only through the ports it publishes.

Container name

Once it's deployed, Portainer names the container wg-easy. That's what you'll spot in the containers list and use in commands like docker logs wg-easy.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Open source license

Wireguard Server is open source, released under the AGPL-3.0 license. In plain terms the code is out in the open, so you're free to run it and change it to fit what you need.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Wireguard Server up. Add the template list to Portainer once, then deploying Wireguard Server is a click rather than a wall of config.