Hexor/Wireguard-Peer-Manager
1
0
Fork 0
mirror of https://github.com/house-of-vanity/Wireguard-Peer-Manager.git synced 2025-07-06 17:24:07 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
House of Vanity
2021-06-15 16:11:06 +03:00
committed by GitHub
parent ced42bd30d
commit 350bbc7efa
1 changed files with 13 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -26,6 +26,9 @@ EOF
$ pip3 install -r requirements.txt
$ apt install qrencode
# Create config. It's optionally.
$ cp wpm_example.conf wpm.conf
# CLI usage. Client configs saved into `clients/peer_name.{conf,-qr.png,-qr.txt}`
$ python3 gen.py --peer my-pc # add a new peer `my-pc`
$ python3 gen.py --delete my-pc # delete peer `my-pc`
@ -34,6 +37,16 @@ $ python3 gen.py --update # just regenerate all configs in `clients/`
# Telegram bot usage
$ TG_TOKEN=1292121488:AAG... TG_ADMIN=<your_username> python3 bot.py
```
## Config
Key | Default | Description
------------ | ------------- | ------------
allowed_ips | 0.0.0.0 | allowed_ips for generated peer configs.
dns | 8.8.8.8 | DNS for peer configs
hostname | $(hostname -f) | server address for peer configs. May be an IP.
config | wg0 | WireGuard config to work with.
## Telegram Interface
<img src="https://user-images.githubusercontent.com/4666566/117370133-cc31f000-ae7a-11eb-93fd-a390d2616da8.png" alt="drawing" width="450"/> <img src="https://user-images.githubusercontent.com/4666566/117377076-48323500-ae87-11eb-9602-a0cd3072ff53.png" alt="drawing" width="350"/>