Skip to main content

Manage WireGuard peers on a Debian VPS

Project description

wgpeer

Manage WireGuard peers on a Debian 12 VPS.

Installation

uv tool install wgpeer

Or run without installing:

uvx wgpeer --help

Usage

Must be run as root with WireGuard installed.

On first use, run init to create the config file:

sudo wgpeer init

This detects your server's public IP from ip a and writes /etc/wgpeer/config.toml. You'll be prompted to confirm or enter the IP manually if none is detected.

sudo wgpeer add <name>     # Add a new peer (auto-assigns IP, shows QR code)
sudo wgpeer remove <name>  # Remove an existing peer
sudo wgpeer list           # List all peers with IPs and public keys
sudo wgpeer qr <name>      # Display QR code for an existing peer

Configuration

Server settings are stored in /etc/wgpeer/config.toml (created by wgpeer init). All fields except server_ip have defaults:

server_ip = "1.2.3.4"
server_port = 51820
wg_interface = "wg0"
wg_dir = "/etc/wireguard"
subnet = "10.0.0.0/24"
dns = "10.0.0.1"
keepalive = 25

Template Override

To customise the client config template, place a Jinja2 template at /etc/wgpeer/client.conf.j2. Available variables: private_key, ip, dns, server_pub, server_ip, port, keepalive.

Building and Publishing

uv build
uv publish

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

wgpeer-0.4.0.tar.gz (29.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

wgpeer-0.4.0-py3-none-any.whl (10.0 kB view details)

Uploaded Python 3

File details

Details for the file wgpeer-0.4.0.tar.gz.

File metadata

  • Download URL: wgpeer-0.4.0.tar.gz
  • Upload date:
  • Size: 29.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for wgpeer-0.4.0.tar.gz
Algorithm Hash digest
SHA256 a081805683e6e8f2be4021e2f55d4e82c51793c351b7e0897f68a9f88bd7cd39
MD5 4c94f6131696a94ffea9c816ce2a1944
BLAKE2b-256 5bd9e2dcca35350c71d75498693928d36fc06e492c3fd3e151a2f99de3f7f8d0

See more details on using hashes here.

Provenance

The following attestation bundles were made for wgpeer-0.4.0.tar.gz:

Publisher: publish.yml on danohn/wgpeer

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file wgpeer-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: wgpeer-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 10.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for wgpeer-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f5e555d1b75dd3f9848d3d6fad70420a458454ea88bcd14c38aaa64f9778fccd
MD5 bee13353bb9785f3ffeffb9528351e1f
BLAKE2b-256 ce16c0c106db1df6343a78d2528b7d522c45ac56a48ae1aff10677f6a9a12b23

See more details on using hashes here.

Provenance

The following attestation bundles were made for wgpeer-0.4.0-py3-none-any.whl:

Publisher: publish.yml on danohn/wgpeer

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page