From b7740d309695dccabc42cfe65b3628eba45f4aac Mon Sep 17 00:00:00 2001 From: Shengjing Zhu Date: Thu, 14 Jul 2022 02:36:05 +0800 Subject: [PATCH] docs: options compared to wg configuration file --- docs/usage.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/docs/usage.md b/docs/usage.md index c68d72f..b8dd9f9 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -11,3 +11,31 @@ After setting the environment options in `wghttp.service`, run: systemctl --user daemon-reload systemctl --user enable --now wghttp ``` + +## Options compared to WireGuard configuration file + +For connecting as a client to a VPN gateway, you might have: + +```ini +[Interface] +Address = 10.200.100.8/24 +DNS = 10.200.100.1 +PrivateKey = oK56DE9Ue9zK76rAc8pBl6opph+1v36lm7cXXsQKrQM= + +[Peer] +PublicKey = GtL7fZc/bLnqZldpVofMCD6hDjrK28SsdLxevJ+qtKU= +AllowedIPs = 0.0.0.0/0 +Endpoint = demo.wireguard.com:51820 +``` + +The above configuration is equal to: + +```bash +wghttp \ + --peer-endpoint=demo.wireguard.com:51820 \ + --peer-key=GtL7fZc/bLnqZldpVofMCD6hDjrK28SsdLxevJ+qtKU= \ + --private-key=oK56DE9Ue9zK76rAc8pBl6opph+1v36lm7cXXsQKrQM= \ + --client-ip=10.200.100.8 \ + --dns=10.200.100.1 \ + --exit-mode=remote +```