From f7e8160f0d524e7c04f0d0b4ad475f25bd08250d Mon Sep 17 00:00:00 2001
From: octeep <74378430+octeep@users.noreply.github.com>
Date: Fri, 11 Mar 2022 12:44:41 +0000
Subject: [PATCH] Create README.md

---
 README.md | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 50 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ef74652
--- /dev/null
+++ b/README.md
@@ -0,0 +1,50 @@
+# wireproxy
+Wireguard client that exposes itself as a socks5 proxy or tunnels
+
+# What is this
+wireproxy is a completely userspace application that connects to a wireguard peer,
+and exposes a socks5 proxy or tunnels on the machine. This can be useful if you need
+to connect to certain sites via a wireguard peer, but do not want to setup a new network
+interface for whatever reasons. 
+
+# Usage
+`./wireproxy [config file path]`
+
+# Sample config file
+```
+# SelfSecretKey is the secret key of your wireguard peer
+SelfSecretKey = uCTIK+56CPyCvwJxmU5dBfuyJvPuSXAq1FzHdnIxe1Q=
+# SelfEndpoint is the IP of your wireguard peer
+SelfEndpoint = 172.16.31.2
+# PeerPublicKey is the public key of the wireguard server you want to connec to
+PeerPublicKey = QP+A67Z2UBrMgvNIdHv8gPel5URWNLS4B3ZQ2hQIZlg=
+# PeerEndpoint is the endpoint of the wireguard server you want to connec to
+PeerEndpoint = 172.16.0.1:53
+# DNS is the DNSs that will be used by wireproxy.
+# Multple DNSs can be specified as such: DNS = 1.1.1.1, 1.0.0.1
+DNS = 1.1.1.1
+# KeepAlive is the persistent keep alive interval of the wireguard device
+# usually not needed
+# KeepAlive = 25
+# PreSharedKey is the pre shared key of your wireguard device
+# if you don't know what this is you don't need it
+# PreSharedKey = UItQuvLsyh50ucXHfjF0bbR4IIpVBd74lwKc8uIPXXs=
+
+# TCPClientTunnel is a tunnel listening on your machine, and
+# forward any TCP traffic received to the specified target via wireguard
+# some applications on your LAN -> 127.0.0.1:25565 --wireguard--> play.cubecraft.net:25565
+[TCPClientTunnel]
+BindAddress = 127.0.0.1:25565
+Target = play.cubecraft.net:25565
+
+# TCPServerTunnel is a tunnel listening on wireguard, and
+# forward any TCP traffic received to the specified target via local network
+# some applications on your wireguard network --wireguard--> 172.16.31.2:3422 -> localhost:25545
+[TCPServerTunnel]
+ListenPort = 3422
+Target = localhost:25545
+
+# Socks5 create a socks5 proxy on your LAN, and any traffic would be routed via wireguard
+[Socks5]
+BindAddress = 127.0.0.1:25344
+```