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 can display a QR code with the configuration if "qrencode" is available.

Requirements

  • Required:

    • python 3.7 or newer
    • Updated python pip
  • Optional:

    • qrencode 4 or newer

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 and showing QR code:

wgtool add "PeerA" --dns 1.1.1.1 1.0.0.1 --qrcode

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.0.tar.gz (20.7 kB view hashes)

Uploaded Source

Built Distribution

wgtool-1.1.0-py3-none-any.whl (20.7 kB view hashes)

Uploaded Python 3

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