From 350bbc7efa66d83f53312aead6f9e26db231712b Mon Sep 17 00:00:00 2001 From: House of Vanity Date: Tue, 15 Jun 2021 16:11:06 +0300 Subject: [PATCH] Update README.md --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 67b9d10..84cc497 100644 --- a/README.md +++ b/README.md @@ -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= 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 drawing drawing