Files
wireguard-ui-multi/examples/docker-compose/README.md
T
sysopsandClaude Sonnet 5 867dc7740a Replace from-scratch rewrite with real ngoduykhanh/wireguard-ui fork
The from-scratch Go rewrite had unresolved bugs (missing go.sum, UI
404s, path issues) from being built without a working local Go
toolchain to verify against. Switching strategy: use the actual
upstream wireguard-ui codebase (proven, battle-tested single-server
manager) as the base, and extend it for multi-server support instead
of re-deriving everything from zero.

Kept our own installers (bootstrap.sh, update.sh, scripts/install.sh,
scripts/proxmox-install.sh) - these still apply, just need updating
to build/install the upstream module layout instead of the old
cmd/wireguard-ui-multi structure.

Module path intentionally left as upstream's own
(github.com/ngoduykhanh/wireguard-ui) for now to avoid touching every
internal import; revisit if this needs to be fully rebranded.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
2026-07-10 18:34:44 +02:00

1.2 KiB

Prerequisites

Kernel Module

Depending on if the Wireguard kernel module is available on your system you have more or less choices which example to use.

You can check if the kernel modules are available via the following command:

modprobe wireguard

If the command exits successfully and doesn't print an error the kernel modules are available. If it does error, you either have to install them manually (or activate if deactivated) or use an userspace implementation. For an example of an userspace implementation, see borigtun.

Credentials

Username and password for all examples is admin by default. For security reasons it's highly recommended to change them before the first startup.

Examples

  • system

    If you have Wireguard already installed on your system and only want to run the UI in docker this might fit the most.

  • linuxserver

    If you have the Wireguard kernel modules installed (included in the mainline kernel since version 5.6) but want it running inside of docker, this might fit the most.

  • boringtun

    If Wireguard kernel modules are not available, you can switch to an userspace implementation like boringtun.