Browse Source

Cleaner UpstreamProxyConfig, added package README

Eugene Fryntov 11 years ago
parent
commit
17ffdaa469
1 changed files with 22 additions and 0 deletions
  1. 22 0
      psiphon/upstreamproxy/README.md

+ 22 - 0
psiphon/upstreamproxy/README.md

@@ -0,0 +1,22 @@
+`upstreamproxy` Package
+=======================
+
+This provides upstream proxy support by extending golang.org/x/net/proxy package.
+
+Currently supported protocols:
+* SOCKS4 via `socks4a` URI scheme
+* SOCKS5 via `socks5` URI scheme
+* HTTP with Basic Auth via `http` URI scheme
+
+# Usage
+
+```
+var proxyDialer psiphon.Dialer 
+proxyDialer = NewProxyDialFunc((
+            ForwardDialFunc: psiphon.NewTCPDialer(tcpDialerConfig),
+            ProxyURIString: "http://user:password@proxyhost:8080"
+            })
+```
+
+
+