Mercurial > prosody-modules

comparison mod_isolate_host/README.markdown @ 1803:4d73a1a6ba68

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Convert all wiki pages to Markdown
author Kim Alvefur <zash@zash.se>
date Fri, 28 Aug 2015 18:03:58 +0200
parents mod_isolate_host/README.wiki@29f3d6b7ad16
children 8de50be756e5
comparison
equal deleted inserted replaced
1802:0ab737feada6 1803:4d73a1a6ba68
1 ---
2 labels:
3 - 'Stage-Beta'
4 summary: Prevent communication between hosts
5 ...
6
7 Introduction
8 ============
9
10 In some environments it is desirable to isolate one or more hosts, and
11 prevent communication with external, or even other internal domains.
12
13 Loading mod\_isolate\_host on a host will prevent all communication with
14 JIDs outside of the current domain, though it is possible to configure
15 exceptions.
16
17 **Note:** if you just want to prevent communication with external
18 domains, this is possible without a plugin. See [Prosody: Disabling
19 s2s](http://prosody.im/doc/s2s#disabling) for more information.
20
21 This module was sponsored by [Exa Networks](http://exa-networks.co.uk/).
22
23 Configuration
24 =============
25
26 To isolate all hosts by default, add the module to your global
27 modules\_enabled:
28
29 modules_enabled = {
30 ...
31 "isolate_host";
32 ...
33 }
34
35 Alternatively you can isolate a single host by putting a
36 modules\_enabled line under the VirtualHost directive:
37
38 VirtualHost "example.com"
39 modules_enabled = { "isolate_host" }
40
41 After enabling the module, you can add further options to add exceptions
42 for the isolation:
43
44 Option Description
45 -------------------------- -----------------------------------------------------------------------------------------
46 isolate\_except\_domains A list of domains to allow communication with.
47 isolate\_except\_users A list of user JIDs allowed to bypass the isolation and communicate with other domains.
48
49 **Note:** Admins of hosts are always allowed to communicate with other
50 domains
51
52 Compatibility
53 =============
54
55 ----- -------
56 0.9 Works
57 ----- -------