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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: wgtool-1.1.11.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.11.tar.gz
Algorithm Hash digest
SHA256 b86262d0a28ea6493709f267ebb09727030993a263d353acff49a34f6d38d591
MD5 2283d598923479df869b8eedb5dc2e21
BLAKE2b-256 865dbabf2562999ff194274fcbceb78a278601fdca9f6f2464e402e8add659af

See more details on using hashes here.

File details

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

File metadata

  • Download URL: wgtool-1.1.11-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.11-py3-none-any.whl
Algorithm Hash digest
SHA256 96dafcb379776cdff43b4e2d2a745ffc58dec5b6b421e863e24a923d77c08964
MD5 735990fc9ea1b6b01240b415933dca1e
BLAKE2b-256 7d7e2674921adccc3d7d65ab41228b7915e56755ea53f5559763cabeabec5261

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