holm/wg-meshconf
1
0
Fork 0
forked from extern/wg-meshconf
Code Issues Pull Requests Packages Projects Releases Wiki Activity

updated usages

Browse Source
This commit is contained in:
k4yt3x 2018-10-15 13:35:18 -04:00
parent 3961a6570a
commit 29b5e427e7
1 changed files with 48 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
README.md
View File

@ -29,6 +29,8 @@ WireGuard mesh configurator is a tool that will help you generating peer configu
## Usages ## Usages
### Installing WGC
Clone the repository and enter it. Clone the repository and enter it.
``` ```
@ -36,16 +38,54 @@ $ git clone https://github.com/K4YT3X/wireguard-mesh-configurator.git
$ cd wireguard-mesh-configurator/ $ cd wireguard-mesh-configurator/
``` ```
Create a temporary folder for exporting configuration files.
```
$ mkdir /tmp/wireguard
```
Run the tool. Run the tool.
``` ```
$ python3 wireguard_mesh_configurator.py $ python3 wireguard_mesh_configurator.py interactive
``` ```
Then you will find all the generated configuration files under `/tmp/wireguard`. 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]
```