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

MIT

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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: wgtool-1.1.10.tar.gz
  • Upload date:
  • Size: 23.6 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.10.tar.gz
Algorithm Hash digest
SHA256 289baaa48f9cc514a19775532ef7e8577d683349e297845c8fe10c4ad686ffcd
MD5 8d20cfd97a6ebb0aeae878e192671ed9
BLAKE2b-256 ed0b9da88c3abb33d8f5d6264b05f534f9e69799196bf7b11bf328a15dc6762a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: wgtool-1.1.10-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.10-py3-none-any.whl
Algorithm Hash digest
SHA256 6ca05d03f8d2861a8fecf0fcbbbf00d17e13776f10d0fe6c042ea12106d07cc3
MD5 a1208fba660a784a371530128ce22aee
BLAKE2b-256 c4a53c00797232562fb4d57d2afe5faee1c7515ddd05812633fd86a565f3fa4e

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