mirror of
https://github.com/k4yt3x/wg-meshconf.git
synced 2024-11-23 08:03:07 +01:00
92 lines
2.1 KiB
Markdown
92 lines
2.1 KiB
Markdown
# WireGuard Mesh Configurator
|
|
|
|
## 1.1.3 (October 17, 2018)
|
|
|
|
1. Added warning before flushing configurations when creating a new profile.
|
|
1. Added descriptions in help command
|
|
1. 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.
|
|
|
|
## Gallery
|
|
|
|
|
|
*Creating a new mesh profile*
|
|
|
|
|
|
*Saving and Loading Profiles*
|
|
|
|
|
|
*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]
|
|
```
|