Skip to main content

WireGuard Configuration Tool

Project description

WireGuard Configuration Tool

WGTool is python script to perform basic configuration tasks in a WireGuard Server.

It is meant to be used in new deployments and supports the following action:

  • Configure wireguard server
  • Add peers
  • Remove peers
  • List peers

When a peer is added, the tool generates a file and displays a QR code with the configuration.

Requirements

  • Required:
    • python 3.8 or newer
    • Updated python pip
    • Dependencies from requirements.txt

Installation

python -m pip install wgtool

Commands

Configuring new server with default settings:

wgtool server myserver012.duckdns.org

Configuring new server with some custom settings:

wgtool server myserver012.duckdns.org --ip 192.168.254.1/24 --port 2345

Adding peer "PeerA":

wgtool add "PeerA"

Adding peer "PeerA" with custom DNS, split-tunnel:

wgtool add "PeerA" --dns 1.1.1.1 1.0.0.1 --split-tunnel

Listing peers:

wgtool list

Removing peer "PeerA":

wgtool delete "PeerA"

If WireGuard Server is on a Windows machine, you must provide the path to the configuration file. For linux users, the default path is /etc/wireguard/wg0.conf:

wgtool --file C:\Wireguard\wg0.conf <arguments>

License

GNU GPLv3

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

wgtool-1.1.14.tar.gz (24.0 kB view details)

Uploaded Source

Built Distribution

wgtool-1.1.14-py3-none-any.whl (25.5 kB view details)

Uploaded Python 3

File details

Details for the file wgtool-1.1.14.tar.gz.

File metadata

  • Download URL: wgtool-1.1.14.tar.gz
  • Upload date:
  • Size: 24.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.8.10

File hashes

Hashes for wgtool-1.1.14.tar.gz
Algorithm Hash digest
SHA256 25ee4fe7bf49a82fffb11d6a10f04cf0549666cb63caead0a9cfe966f84126ca
MD5 3bf0c46783c4c5c8727263e3063a000c
BLAKE2b-256 12a11b60e54c6709f23fe8d6985c1030d692170a613f6725b2c851a525b46bda

See more details on using hashes here.

File details

Details for the file wgtool-1.1.14-py3-none-any.whl.

File metadata

  • Download URL: wgtool-1.1.14-py3-none-any.whl
  • Upload date:
  • Size: 25.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.8.10

File hashes

Hashes for wgtool-1.1.14-py3-none-any.whl
Algorithm Hash digest
SHA256 d8bdeac9c3fcf914ee2c417c6d825469adff4afabac156d69438a1791eb0237f
MD5 b56e29558f7e4e4dd82c26e3e316a783
BLAKE2b-256 bd228b6ecaa1738909350ec25072988f0520f8f3c5f7401ee63eb988461225a4

See more details on using hashes here.

Supported by

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