annotate mod_cleanup_http.wiki @ 363:4a39ef28e2d9

slight change and fix syntax error in example config
author Kim Alvefur <zash@zash.se>
date Wed, 12 Jun 2013 18:01:46 +0200
parents d9709ca32230
children c929df198f10
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
262
dee8461071c2 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
1 #summary http "spring cleans" module
dee8461071c2 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
2 #labels Stage-Beta
dee8461071c2 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
3
dee8461071c2 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
4 = Details =
dee8461071c2 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
5
dee8461071c2 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
6 Auto cleans handlers and open unused http ports (only on server_select) for BOSH/HTTP modules.
dee8461071c2 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
7
dee8461071c2 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
8 = Usage =
dee8461071c2 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
9
dee8461071c2 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
10 Copy both files into prosody's module directory and place 'em into your enabled modules into the configuration file's global section.
dee8461071c2 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
11
dee8461071c2 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
12 Required parameters, example:
dee8461071c2 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
13 {{{
268
d9709ca32230 corrected wiki.
Marco Cirillo <maranda@lightwitch.org>
parents: 262
diff changeset
14 local bosh_mod_name_ports_conf_var_reference = { { interface = { "127.0.0.1" }, port = 5280 } }
262
dee8461071c2 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
15 cleanup_http_modules = { ["bosh_mod_name"] = bosh_mod_name_ports_conf_var_reference, ["bosh_mod_name_unreferenced"] = { { interface = { "127.0.0.1" }, port = 5280 } } }
dee8461071c2 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
16 }}}
dee8461071c2 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
17
268
d9709ca32230 corrected wiki.
Marco Cirillo <maranda@lightwitch.org>
parents: 262
diff changeset
18 You can either reference other local variables present in the configuration (see above, cleanup_http_modules needs to be placed after those in that case) or duplicate 'em (see bosh_mod_name_unreferenced).
262
dee8461071c2 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
19
dee8461071c2 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
20 = Compatibility =
dee8461071c2 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
21
dee8461071c2 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
22 * 0.9/trunk works
dee8461071c2 added wiki.
Marco Cirillo <maranda@lightwitch.org>
parents:
diff changeset
23 * 0.8 works