wg-meshconf/README.md
2018-10-17 13:56:07 -04:00

2.1 KiB

WireGuard Mesh Configurator

1.1.3 (October 17, 2018)

  1. Added warning before flushing configurations when creating a new profile.
  2. Added descriptions in help command
  3. Added in-line documentation

1.1.2 (October 15, 2018)

  1. Added output path detection.
  2. Added profile exporting path detection.
  3. Ask user if a output directory should be made if it doesn't exist.

Introduction

WireGuard mesh configurator is a tool that will help you generating peer configuration files for wireguard mesh networks. You generate configuration files for a large amount of peers easily and quickly via this tool.

new_profile Creating a new mesh profile

save_load Saving and Loading Profiles

generated_configs Generated configuration files

Usages

Installing WGC

Clone the repository and enter it.

$ git clone https://github.com/K4YT3X/wireguard-mesh-configurator.git
$ cd wireguard-mesh-configurator/

Run the tool.

$ python3 wireguard_mesh_configurator.py interactive

or

$ python3 wireguard_mesh_configurator.py int

Creating a Profile

Run the NewProfile command to create a new profile.

[WGC]> NewProfile  # Create new profile

Then the peer enrolling wizard will ask you for all the information needed for all the peers. Select n when being asked if you want to add a new peer to end the wizard.

Generating Configurations

Run the following command to dump your currently-loaded profile into configuration files and export them to output path.

[WGC]> GenerateConfigurations [output path]

Viewing All Peers

To view all the peers configurations in the current profile:

[WGC]> ShowPeers

Saving / Loading Profiles

To save a profile:

[WGC]> SaveProfile [output path]

To load a profile:

[WGC]> LoadProfile [output path]