Skip to content

Commit a7d9e8a

Browse files
committed
README.md update (caveats)
Signed-off-by: Alexey Cluster <cluster@cluster.wtf>
1 parent ababf8b commit a7d9e8a

1 file changed

Lines changed: 9 additions & 0 deletions

File tree

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,7 @@ wg-obfuscator --source-lport 13255 --target 10.13.1.100:13255 --key test
8383
Type `wg-obfuscator.exe --help` for more information.
8484

8585
### Settings diagram
86+
8687
```
8788
+------------------------------------------------------------------------------------------+
8889
| Source WireGuard peer |
@@ -136,6 +137,7 @@ Type `wg-obfuscator.exe --help` for more information.
136137
```
137138

138139
## How to build and install
140+
139141
On Linux:
140142
```bash
141143
make
@@ -152,7 +154,14 @@ You can also run it from the command line, type `wg-obfuscator --help` for more
152154

153155
On Windows and MacOS you can only run it from the command line.
154156

157+
## Caveats
158+
159+
WireGuard automatically excludes the IP address of the server specified in the Endpoint from the `AllowedIPs` list. This can cause a non-obvious issue: if the obfuscator is located on the local machine, after the handshake, the traffic to the VPN server will be routed through the VPN itself. Therefore, you need to manually exclude the real IP address of the VPN server from the `AllowedIPs` list.
160+
161+
Also, the obfuscator currently only supports point-to-point connections, meaning it does not allow multiple peers to connect to the same port simultaneously. If you plan to use multiple connections at the same time, each connection must have a separate `ListenPort` port opened.
162+
155163
## Donate
164+
156165
* [Buy Me A Coffee](https://www.buymeacoffee.com/cluster)
157166
* [Donation Alerts](https://www.donationalerts.com/r/clustermeerkat)
158167
* [Boosty](https://boosty.to/cluster)

0 commit comments

Comments
 (0)