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.13.tar.gz (23.7 kB view details)

Uploaded Source

Built Distribution

wgtool-1.1.13-py3-none-any.whl (25.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: wgtool-1.1.13.tar.gz
  • Upload date:
  • Size: 23.7 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.13.tar.gz
Algorithm Hash digest
SHA256 5caa75328d13fe5e679c9bfa6c265bd7c0c95210d6dcb2c3eca455646e4040fd
MD5 6ce1092dbd36ba1dc6cc54f6b7f9471f
BLAKE2b-256 10c7fe8998a8fffbf288ae5df64e6281ed69701176ea80d01b015aac2ae874c4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: wgtool-1.1.13-py3-none-any.whl
  • Upload date:
  • Size: 25.4 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.13-py3-none-any.whl
Algorithm Hash digest
SHA256 12332ca0757c961480a7e72b54bb3a927ff3de2e1d3ddac44496d705ec15200b
MD5 d34a23a881be8ea852db9dbef090f62a
BLAKE2b-256 ae3f3a6646a5f45a7e3e6cb24f365ce8792e70ba5d45b2455acbb513e7dec108

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