changeset 77:85a049a790ed

Expanded page to include intro, usage, configuration and compatibility sections. Added to Todo section.
author MWild1
date Sat, 31 Oct 2009 01:08:16 +0000
parents cde49830609d
children 06542881ba44
files mod_proxy65.wiki
diffstat 1 files changed, 23 insertions(+), 5 deletions(-) [+]
line wrap: on
line diff
--- a/mod_proxy65.wiki	Fri Oct 30 00:34:44 2009 +0000
+++ b/mod_proxy65.wiki	Sat Oct 31 01:08:16 2009 +0000
@@ -1,12 +1,30 @@
-#summary XEP-0065: SOCKS5 Bytestreams
+#summary XEP-0065: SOCKS5 Bytestreams file transfer proxy
 #labels Stage-Beta
 
 = Introduction =
 
-mod_proxy65 implements XEP-0065: SOCKS5 Bytestreams as a component.
+mod_proxy65 implements XEP-0065: SOCKS5 Bytestreams as a component. It allows the server to proxy file transfers between 2 clients that are behind NAT routers or firewalls, and otherwise wouldn't be able to transfer files.
 
 = Details =
-Done. should work as expected!
+Once set up, depending on which client you are using the proxy may be automatically used, or the client may have to be configured. Consult your client's friendly documentation for more information :)
+
+= Usage =
+{{{
+Component "proxy.example.com" "proxy65"
+}}}
+
+= Configuration =
+Although none are required, under the Component section mod_proxy65 understands several configuration options:
 
-= TODO =
-  * optional Support UDP
\ No newline at end of file
+||proxy65_interface||The server's interface (IP address) to bind (listen) on (default is "*", meaning all interfaces)||
+||proxy65_address||The advertised address of the proxy, which clients use to connect to (default is the same as the hostname of the component)||
+||proxy65_port||The port on the server to which clients should connect (default is port 5000)||
+
+= Compatibility =
+||0.6||Works||
+||0.5||Should work||
+
+= Todo =
+  * Optional support for UDP connections
+  * Access control
+  * Statistics, bandwidth limits/monitoring
\ No newline at end of file