Mercurial > sat_docs
comparison docker/prosody/prosody.cfg.lua @ 79:694fd34ff0b3
docker (prosody): added some comments to prosody.cfg.lua
author | Goffi <goffi@goffi.org> |
---|---|
date | Wed, 10 Feb 2016 18:22:56 +0100 |
parents | 3e8ddbc6c603 |
children | 697d7234d2ed |
comparison
equal
deleted
inserted
replaced
78:3e8ddbc6c603 | 79:694fd34ff0b3 |
---|---|
1 -- Prosody configuration for SàT Docker image | 1 -- Prosody configuration for SàT Docker image |
2 | 2 |
3 ---------- Server-wide settings ---------- | 3 ---------- Server-wide settings ---------- |
4 | 4 |
5 -- we use environment variable to get the domain | |
5 local domain = os.getenv("DOMAIN") or "libervia.int" | 6 local domain = os.getenv("DOMAIN") or "libervia.int" |
7 -- default admin is admin@DOMAIN | |
6 admins = { "admin@"..(domain) } | 8 admins = { "admin@"..(domain) } |
7 | 9 |
8 -- Enable use of libevent for better performance under high load | 10 -- Enable use of libevent for better performance under high load |
9 -- For more information see: http://prosody.im/doc/libevent | 11 -- For more information see: http://prosody.im/doc/libevent |
10 --use_libevent = true; | 12 --use_libevent = true; |
11 | 13 |
12 -- Documentation on modules can be found at: http://prosody.im/doc/modules | 14 -- Documentation on modules can be found at: http://prosody.im/doc/modules |
13 modules_enabled = { | 15 modules_enabled = { |
14 -- used by SàT | 16 -- used by SàT |
15 | 17 |
16 -- SàT PubSub | 18 -- SàT PubSub |
17 "delegation"; | 19 "delegation"; |
18 "privilege"; | 20 "privilege"; |
19 | 21 |
20 -- Not mandatory but neat | 22 -- Not mandatory but neat |
21 "ipcheck"; | 23 "ipcheck"; |
22 "http_upload"; | 24 "http_upload"; |
23 | 25 |
24 -- Generally required | 26 -- Generally required |
25 "roster"; -- Allow users to have a roster. Recommended ;) | 27 "roster"; -- Allow users to have a roster. Recommended ;) |
26 "saslauth"; -- Authentication for clients and servers. Recommended if you want to log in. | 28 "saslauth"; -- Authentication for clients and servers. Recommended if you want to log in. |
27 "tls"; -- Add support for secure TLS on c2s/s2s connections | 29 "tls"; -- Add support for secure TLS on c2s/s2s connections |
28 "dialback"; -- s2s dialback support | 30 "dialback"; -- s2s dialback support |
29 "disco"; -- Service discovery | 31 "disco"; -- Service discovery |
30 | 32 |
31 -- Not essential, but recommended | 33 -- Not essential, but recommended |
32 "private"; -- Private XML storage (for room bookmarks, etc.) | 34 "private"; -- Private XML storage (for room bookmarks, etc.) |
33 "vcard"; -- Allow users to set vCards | 35 "vcard"; -- Allow users to set vCards |
34 | 36 |
35 -- These are commented by default as they have a performance impact | 37 -- These are commented by default as they have a performance impact |
36 --"privacy"; -- Support privacy lists | 38 --"privacy"; -- Support privacy lists |
37 --"compression"; -- Stream compression (Debian: requires lua-zlib module to work) | 39 --"compression"; -- Stream compression (Debian: requires lua-zlib module to work) |
38 | 40 |
39 -- Nice to have | 41 -- Nice to have |
40 "version"; -- Replies to server version requests | 42 "version"; -- Replies to server version requests |
41 "uptime"; -- Report how long server has been running | 43 "uptime"; -- Report how long server has been running |
42 "time"; -- Let others know the time here on this server | 44 "time"; -- Let others know the time here on this server |
43 "ping"; -- Replies to XMPP pings with pongs | 45 "ping"; -- Replies to XMPP pings with pongs |
44 -- "pep"; -- Enables users to publish their mood, activity, playing music and more | 46 -- "pep"; -- Enables users to publish their mood, activity, playing music and more |
45 --"register"; -- Allow users to register on this server using a client and change passwords | 47 -- we don't want to allow self registering, this is managed by a SàT plugin |
48 --"register"; -- Allow users to register on this server using a client and change passwords | |
46 | 49 |
47 -- Admin interfaces | 50 -- Admin interfaces |
48 "admin_adhoc"; -- Allows administration via an XMPP client that supports ad-hoc commands | 51 "admin_adhoc"; -- Allows administration via an XMPP client that supports ad-hoc commands |
49 --"admin_telnet"; -- Opens telnet console interface on localhost port 5582 | 52 --"admin_telnet"; -- Opens telnet console interface on localhost port 5582 |
50 | 53 |
51 -- HTTP modules | 54 -- HTTP modules |
52 --"bosh"; -- Enable BOSH clients, aka "Jabber over HTTP" | 55 --"bosh"; -- Enable BOSH clients, aka "Jabber over HTTP" |
53 --"http_files"; -- Serve static files from a directory over HTTP | 56 --"http_files"; -- Serve static files from a directory over HTTP |
54 | 57 |
55 -- Other specific functionality | 58 -- Other specific functionality |
56 "posix"; -- POSIX functionality, sends server to background, enables syslog, etc. | 59 "posix"; -- POSIX functionality, sends server to background, enables syslog, etc. |
57 --"groups"; -- Shared roster support | 60 --"groups"; -- Shared roster support |
58 "announce"; -- Send announcement to all online users | 61 -- announce is usefull on a Libervia instance |
59 --"welcome"; -- Welcome users who register accounts | 62 "announce"; -- Send announcement to all online users |
60 --"watchregistrations"; -- Alert admins of registrations | 63 --"welcome"; -- Welcome users who register accounts |
61 --"motd"; -- Send a message to users when they log in | 64 --"watchregistrations"; -- Alert admins of registrations |
62 --"legacyauth"; -- Legacy authentication. Only used by some old clients and bots. | 65 --"motd"; -- Send a message to users when they log in |
66 --"legacyauth"; -- Legacy authentication. Only used by some old clients and bots. | |
63 }; | 67 }; |
64 | 68 |
65 -- to disable them then uncomment them here: | 69 -- to disable them then uncomment them here: |
66 modules_disabled = { | 70 modules_disabled = { |
67 -- "offline"; -- Store offline messages | 71 -- "offline"; -- Store offline messages |
68 -- "c2s"; -- Handle client connections | 72 -- "c2s"; -- Handle client connections |
69 -- "s2s"; -- Handle server-to-server connections | 73 -- "s2s"; -- Handle server-to-server connections |
70 }; | 74 }; |
71 | 75 |
72 -- Disable account creation by default, for security | 76 -- Disable account creation by default, for security |
73 -- For more information see http://prosody.im/doc/creating_accounts | 77 -- For more information see http://prosody.im/doc/creating_accounts |
74 allow_registration = false; | 78 allow_registration = false; |
80 -- Please, don't change this option since /var/run/prosody/ | 84 -- Please, don't change this option since /var/run/prosody/ |
81 -- is one of the few directories Prosody is allowed to write to | 85 -- is one of the few directories Prosody is allowed to write to |
82 -- | 86 -- |
83 pidfile = "/var/run/prosody/prosody.pid"; | 87 pidfile = "/var/run/prosody/prosody.pid"; |
84 | 88 |
85 -- These are the SSL/TLS-related settings. If you don't want | 89 -- We want to use the certificat in /usr/share/sat |
86 -- to use SSL/TLS, you may comment or remove this | |
87 ssl = { | 90 ssl = { |
88 key = "/usr/share/sat/libervia.key"; | 91 key = "/usr/share/sat/libervia.key"; |
89 certificate = "/usr/share/sat/libervia.crt"; | 92 certificate = "/usr/share/sat/libervia.crt"; |
90 } | 93 } |
91 | 94 |
92 c2s_require_encryption = true | 95 c2s_require_encryption = true |
93 | 96 |
94 -- Force certificate authentication for server-to-server connections? | 97 -- Force certificate authentication for server-to-server connections? |
117 -- server please see http://prosody.im/doc/modules/mod_auth_internal_hashed | 120 -- server please see http://prosody.im/doc/modules/mod_auth_internal_hashed |
118 -- for information about using the hashed backend. | 121 -- for information about using the hashed backend. |
119 | 122 |
120 authentication = "internal_plain" | 123 authentication = "internal_plain" |
121 | 124 |
125 -- we listen to the world for components (but we do *NOT* | |
126 -- expose the port! It's just for linked containers) | |
122 component_interface="0.0.0.0" | 127 component_interface="0.0.0.0" |
128 | |
129 -- we want default, unsplitted logs, so we have removed all logging stuff | |
123 | 130 |
124 VirtualHost (domain) | 131 VirtualHost (domain) |
125 privileged_entities = { | 132 privileged_entities = { |
126 ["pubsub."..domain] = { | 133 ["pubsub."..domain] = { |
127 roster = "get"; | 134 roster = "get"; |
128 message = "outgoing"; | 135 message = "outgoing"; |
129 -- presence = "roster"; | 136 -- presence = "roster"; |
130 }, | 137 }, |
131 -- ["louise@necton3.int"] = { | 138 -- ["louise@necton3.int"] = { |
132 -- roster = "both"; | 139 -- roster = "both"; |
133 -- message = "outgoing"; | 140 -- message = "outgoing"; |
134 -- presence = "roster"; | 141 -- presence = "roster"; |
135 -- }, | 142 -- }, |
136 } | 143 } |
137 | 144 |
138 delegations = { | 145 delegations = { |
139 ["urn:xmpp:mam:1"] = { | 146 ["urn:xmpp:mam:1"] = { |