annotate mod_proxy65.wiki @ 416:b95d737dc014

show and tell, example invocation and description of fields
author Kim Alvefur <zash@zash.se>
date Fri, 17 Jan 2014 00:55:52 +0100
parents f7f2befb0f3e
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
77
85a049a790ed Expanded page to include intro, usage, configuration and compatibility sections. Added to Todo section.
MWild1
parents: 75
diff changeset
1 #summary XEP-0065: SOCKS5 Bytestreams file transfer proxy
374
f7f2befb0f3e Labels are apparently comma-separated
Kim Alvefur <zash@zash.se>
parents: 373
diff changeset
2 #labels Stage-Beta, Deprecated
50
6d2dd530e3bc start is done.
t.ephraim
parents:
diff changeset
3
6d2dd530e3bc start is done.
t.ephraim
parents:
diff changeset
4 = Introduction =
6d2dd530e3bc start is done.
t.ephraim
parents:
diff changeset
5
77
85a049a790ed Expanded page to include intro, usage, configuration and compatibility sections. Added to Todo section.
MWild1
parents: 75
diff changeset
6 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.
50
6d2dd530e3bc start is done.
t.ephraim
parents:
diff changeset
7
6d2dd530e3bc start is done.
t.ephraim
parents:
diff changeset
8 = Details =
77
85a049a790ed Expanded page to include intro, usage, configuration and compatibility sections. Added to Todo section.
MWild1
parents: 75
diff changeset
9 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 :)
85a049a790ed Expanded page to include intro, usage, configuration and compatibility sections. Added to Todo section.
MWild1
parents: 75
diff changeset
10
85a049a790ed Expanded page to include intro, usage, configuration and compatibility sections. Added to Todo section.
MWild1
parents: 75
diff changeset
11 = Usage =
85a049a790ed Expanded page to include intro, usage, configuration and compatibility sections. Added to Todo section.
MWild1
parents: 75
diff changeset
12 {{{
85a049a790ed Expanded page to include intro, usage, configuration and compatibility sections. Added to Todo section.
MWild1
parents: 75
diff changeset
13 Component "proxy.example.com" "proxy65"
85a049a790ed Expanded page to include intro, usage, configuration and compatibility sections. Added to Todo section.
MWild1
parents: 75
diff changeset
14 }}}
85a049a790ed Expanded page to include intro, usage, configuration and compatibility sections. Added to Todo section.
MWild1
parents: 75
diff changeset
15
85a049a790ed Expanded page to include intro, usage, configuration and compatibility sections. Added to Todo section.
MWild1
parents: 75
diff changeset
16 = Configuration =
85a049a790ed Expanded page to include intro, usage, configuration and compatibility sections. Added to Todo section.
MWild1
parents: 75
diff changeset
17 Although none are required, under the Component section mod_proxy65 understands several configuration options:
50
6d2dd530e3bc start is done.
t.ephraim
parents:
diff changeset
18
78
06542881ba44 That asterisk was not meant to imply boldness :/
florob@babelmonkeys.de
parents: 77
diff changeset
19 ||proxy65_interface||The server's interface (IP address) to bind (listen) on (default is "`*`", meaning all interfaces)||
77
85a049a790ed Expanded page to include intro, usage, configuration and compatibility sections. Added to Todo section.
MWild1
parents: 75
diff changeset
20 ||proxy65_address||The advertised address of the proxy, which clients use to connect to (default is the same as the hostname of the component)||
85a049a790ed Expanded page to include intro, usage, configuration and compatibility sections. Added to Todo section.
MWild1
parents: 75
diff changeset
21 ||proxy65_port||The port on the server to which clients should connect (default is port 5000)||
98
ee27befaf1fc Small English fix in option description
MWild1
parents: 97
diff changeset
22 ||proxy65_acl||Access Control List, when specified all users will be denied access unless in the list. The list can contain domains, bare jids (normal) or full jids (including a resource). e.g. proxy65_acl = {"example.com", "theadmin@anotherdomain.com", "only@fromwork.de/AtWork"}||
77
85a049a790ed Expanded page to include intro, usage, configuration and compatibility sections. Added to Todo section.
MWild1
parents: 75
diff changeset
23
85a049a790ed Expanded page to include intro, usage, configuration and compatibility sections. Added to Todo section.
MWild1
parents: 75
diff changeset
24 = Compatibility =
97
0f5256889fef Edited wiki page through web user interface.
MWild1
parents: 84
diff changeset
25 ||0.7 and above||Officially included in Prosody||
77
85a049a790ed Expanded page to include intro, usage, configuration and compatibility sections. Added to Todo section.
MWild1
parents: 75
diff changeset
26 ||0.6||Works||
85a049a790ed Expanded page to include intro, usage, configuration and compatibility sections. Added to Todo section.
MWild1
parents: 75
diff changeset
27 ||0.5||Should work||
85a049a790ed Expanded page to include intro, usage, configuration and compatibility sections. Added to Todo section.
MWild1
parents: 75
diff changeset
28
85a049a790ed Expanded page to include intro, usage, configuration and compatibility sections. Added to Todo section.
MWild1
parents: 75
diff changeset
29 = Todo =
85a049a790ed Expanded page to include intro, usage, configuration and compatibility sections. Added to Todo section.
MWild1
parents: 75
diff changeset
30 * Optional support for UDP connections
373
c929df198f10 Mark pages of modules no longer in the repo as Deprecated
Kim Alvefur <zash@zash.se>
parents: 98
diff changeset
31 * Statistics, bandwidth limits/monitoring