Metadata-Version: 2.1
Name: wgtool
Version: 1.1.0
Summary: WireGuard Configuration Tool
Home-page: https://github.com/rpcsp/wgtool
Author: rpcsp
Author-email: pcunha@hotmail.com
License: https://github.com/rpcsp/wgtool/blob/main/LICENSE
Project-URL: Project page, https://github.com/rpcsp/wgtool
Platform: UNKNOWN
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE

# 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


