view @ 83:eb8f0bc5b246

added proxy65_acl config value.
author t.ephraim
date Sun, 01 Nov 2009 15:48:05 +0000
parents 7283d7817489
children 8ba753bfa3ab
line wrap: on
line source

#summary XEP-0065: SOCKS5 Bytestreams file transfer proxy
#labels Stage-Beta

= Introduction =

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 =
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 "" "proxy65"

= Configuration =
Although none are required, under the Component section mod_proxy65 understands several configuration options:

||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)||
||proxy65_acl||Access Control List, when specified all users will the access be denied, except they are on that list. The list can contain domains, bare_jids or full_jids (only usernames would work too). e.g. proxy65_acl = {"", "", ""}||

= Compatibility =
||0.5||Should work||

= Todo =
  * Optional support for UDP connections
  * Access control
  * Statistics, bandwidth limits/monitoring