Skip to main content

Manage WireGuard peers

Project description

wgpeer

Manage WireGuard peers.

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.6.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.6.0-py3-none-any.whl (9.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: wgpeer-0.6.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.6.0.tar.gz
Algorithm Hash digest
SHA256 14082f669f0c19d76a6294ade6579f464a49bd7d61c21d5c3a2ceefc7ec03e13
MD5 001d90a9c16abfcee7fa7eae4a194b61
BLAKE2b-256 0b2d871db08ab1733b9ae977124a87a7254a384f453c9e0e7a17c72617b168a6

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: wgpeer-0.6.0-py3-none-any.whl
  • Upload date:
  • Size: 9.9 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.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 24a5484e97115f07b9a1e117f2f092944009367d081e69c67ff42430ae0a2650
MD5 9e96705d164db2fd4ba54ce67978e2df
BLAKE2b-256 236fd4eb9f8b616fc359c84365acea1621035d6fb83a857e071bd121a810358c

See more details on using hashes here.

Provenance

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