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"
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.1.0.tar.gz (28.3 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.1.0-py3-none-any.whl (8.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for wgpeer-0.1.0.tar.gz
Algorithm Hash digest
SHA256 f272c49613d3587cdf408a67b077675869158c5cca767b1580e7888b7ed517bd
MD5 e7783140737605e60f97a40005c5ad04
BLAKE2b-256 7c863f5b6ba7100f71a5207c5866b89a21e21217dab498f6ad0de72d6834ae27

See more details on using hashes here.

Provenance

The following attestation bundles were made for wgpeer-0.1.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.1.0-py3-none-any.whl.

File metadata

  • Download URL: wgpeer-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 8.3 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.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ee6b52d51b5cb3a079789d259c608a63a04b56bf50ab9d64c563f85f63cc313d
MD5 57bf6e89673fa062ce6e83644a418288
BLAKE2b-256 ce4b9042c08092e92448123e68e24ade6584732de1d844fc0e4d10fcbefee681

See more details on using hashes here.

Provenance

The following attestation bundles were made for wgpeer-0.1.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