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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: wgtool-1.1.12.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.12.tar.gz
Algorithm Hash digest
SHA256 bda3aa350f1c57a3cf85b9300e5dbfbfa30c4c8c09adb3977b57355e610c9bf2
MD5 b41a6058b90a16b56b7a5830ccbcd6fc
BLAKE2b-256 6a33a4f8d31560b0764763430923e451cbe0c129779089aa986bbd56fe9ac782

See more details on using hashes here.

File details

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

File metadata

  • Download URL: wgtool-1.1.12-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.12-py3-none-any.whl
Algorithm Hash digest
SHA256 ec14b0936b91f8753ede8d5713c0d4783e140310e63aa85a9b1dfb263ffce7a2
MD5 037eec3cd0a4cc2f37f06d1fed87c80e
BLAKE2b-256 00ff1d8f87b324e5597287f6940239dd4d8ccc703d79d3f257182eb1de64329d

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