Software /
code /
prosody
Annotate
prosody.cfg.lua.dist @ 12338:677ea3cc9c84
prosody.cfg.lua.dist: Improve section-like layout via headers and spacing
author | Matthew Wild <mwild1@gmail.com> |
---|---|
date | Mon, 14 Feb 2022 16:27:58 +0000 |
parent | 12337:fea2d8fff5c6 |
child | 12339:4ba0a0dfa047 |
rev | line source |
---|---|
2982
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
1 -- Prosody Example Configuration File |
3412
7c66519f4973
prosody.cfg.lua.dist: Fixed trailing whitespace.
Waqas Hussain <waqas20@gmail.com>
parents:
3273
diff
changeset
|
2 -- |
2982
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
3 -- Information on configuring Prosody can be found on our |
8258
503f424d4f07
prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents:
6345
diff
changeset
|
4 -- website at https://prosody.im/doc/configure |
3412
7c66519f4973
prosody.cfg.lua.dist: Fixed trailing whitespace.
Waqas Hussain <waqas20@gmail.com>
parents:
3273
diff
changeset
|
5 -- |
2982
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
6 -- Tip: You can check that the syntax of this file is correct |
8258
503f424d4f07
prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents:
6345
diff
changeset
|
7 -- when you have finished by running this command: |
503f424d4f07
prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents:
6345
diff
changeset
|
8 -- prosodyctl check config |
2982
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
9 -- If there are any errors, it will let you know what and where |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
10 -- they are, otherwise it will keep quiet. |
2024
46a9c7c99476
prosody.cfg.lua.dist: Convert to unix line endings from DOS
Matthew Wild <mwild1@gmail.com>
parents:
1810
diff
changeset
|
11 -- |
2982
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
12 -- The only thing left to do is rename this file to remove the .dist ending, and fill in the |
2024
46a9c7c99476
prosody.cfg.lua.dist: Convert to unix line endings from DOS
Matthew Wild <mwild1@gmail.com>
parents:
1810
diff
changeset
|
13 -- blanks. Good luck, and happy Jabbering! |
46a9c7c99476
prosody.cfg.lua.dist: Convert to unix line endings from DOS
Matthew Wild <mwild1@gmail.com>
parents:
1810
diff
changeset
|
14 |
2982
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
15 |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
16 ---------- Server-wide settings ---------- |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
17 -- Settings in this section apply to the whole server and are the default settings |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
18 -- for any virtual hosts |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
19 |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
20 -- This is a (by default, empty) list of accounts that are admins |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
21 -- for the server. Note that you must create the accounts separately |
8258
503f424d4f07
prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents:
6345
diff
changeset
|
22 -- (see https://prosody.im/doc/creating_accounts for info) |
2982
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
23 -- Example: admins = { "user1@example.com", "user2@example.net" } |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
24 admins = { } |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
25 |
11581
7e111f7147dc
prosody.cfg.lua.dist: Replace use_libevent with network_backend
Kim Alvefur <zash@zash.se>
parents:
11572
diff
changeset
|
26 -- Prosody includes several alternative modules for keeping track of network connections. |
7e111f7147dc
prosody.cfg.lua.dist: Replace use_libevent with network_backend
Kim Alvefur <zash@zash.se>
parents:
11572
diff
changeset
|
27 -- For more information see: https://prosody.im/doc/network_backend |
7e111f7147dc
prosody.cfg.lua.dist: Replace use_libevent with network_backend
Kim Alvefur <zash@zash.se>
parents:
11572
diff
changeset
|
28 --network_backend = "epoll" |
2984 | 29 |
8258
503f424d4f07
prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents:
6345
diff
changeset
|
30 -- Prosody will always look in its source directory for modules, but |
503f424d4f07
prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents:
6345
diff
changeset
|
31 -- this option allows you to specify additional locations where Prosody |
503f424d4f07
prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents:
6345
diff
changeset
|
32 -- will look for modules first. For community modules, see https://modules.prosody.im/ |
503f424d4f07
prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents:
6345
diff
changeset
|
33 --plugin_paths = {} |
503f424d4f07
prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents:
6345
diff
changeset
|
34 |
2982
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
35 -- This is the list of modules Prosody will load on startup. |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
36 -- It looks for mod_modulename.lua in the plugins folder, so make sure that exists too. |
8258
503f424d4f07
prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents:
6345
diff
changeset
|
37 -- Documentation for bundled modules can be found at: https://prosody.im/doc/modules |
2982
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
38 modules_enabled = { |
2024
46a9c7c99476
prosody.cfg.lua.dist: Convert to unix line endings from DOS
Matthew Wild <mwild1@gmail.com>
parents:
1810
diff
changeset
|
39 |
2982
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
40 -- Generally required |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
41 "roster"; -- Allow users to have a roster. Recommended ;) |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
42 "saslauth"; -- Authentication for clients and servers. Recommended if you want to log in. |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
43 "tls"; -- Add support for secure TLS on c2s/s2s connections |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
44 "disco"; -- Service discovery |
2694
a6d80b6e9ee1
prosody.cfg.lua.dist: Update config for 0.7, most improvements from the Arch Linux package by dbb, thanks!
Matthew Wild <mwild1@gmail.com>
parents:
2408
diff
changeset
|
45 |
2982
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
46 -- Not essential, but recommended |
8258
503f424d4f07
prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents:
6345
diff
changeset
|
47 "carbons"; -- Keep multiple clients in sync |
9591
b0d309abf7d4
prosody.cfg.lua.dist: Mention that mod_pep handles avatars
Kim Alvefur <zash@zash.se>
parents:
9590
diff
changeset
|
48 "pep"; -- Enables users to publish their avatar, mood, activity, playing music and more |
2982
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
49 "private"; -- Private XML storage (for room bookmarks, etc.) |
8258
503f424d4f07
prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents:
6345
diff
changeset
|
50 "blocklist"; -- Allow users to block communications with other users |
9593
6e1379473c3c
prosody.cfg.lua.dist: Replace old vcard module with new ones
Kim Alvefur <zash@zash.se>
parents:
9592
diff
changeset
|
51 "vcard4"; -- User profiles (stored in PEP) |
6e1379473c3c
prosody.cfg.lua.dist: Replace old vcard module with new ones
Kim Alvefur <zash@zash.se>
parents:
9592
diff
changeset
|
52 "vcard_legacy"; -- Conversion between legacy vCard and PEP Avatar, vcard |
11553
b0d8920ed5e5
prosody.cfg.lua.dist: Enable rate limits by default
Matthew Wild <mwild1@gmail.com>
parents:
9637
diff
changeset
|
53 "limits"; -- Enable bandwidth limiting for XMPP connections |
12322
b1cb236c4478
prosody.cfg.lua.dist: Add new modules
Kim Alvefur <zash@zash.se>
parents:
12321
diff
changeset
|
54 "bookmarks"; -- Synchronise open rooms between clients |
b1cb236c4478
prosody.cfg.lua.dist: Add new modules
Kim Alvefur <zash@zash.se>
parents:
12321
diff
changeset
|
55 "smacks"; -- Stream management and resumption (XEP-0198) |
12326
e59b5b1cdc5b
prosody.cfg.lua.dist: Move Dialback down
Kim Alvefur <zash@zash.se>
parents:
12325
diff
changeset
|
56 "dialback"; -- s2s dialback support |
2984 | 57 |
2982
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
58 -- Nice to have |
12334
e621bb7bb623
prosody.cfg.lua.dist: Enable csi_simple by default
Matthew Wild <mwild1@gmail.com>
parents:
12332
diff
changeset
|
59 "csi_simple"; -- Simple Mobile optimizations |
2982
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
60 "version"; -- Replies to server version requests |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
61 "uptime"; -- Report how long server has been running |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
62 "time"; -- Let others know the time here on this server |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
63 "ping"; -- Replies to XMPP pings with pongs |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
64 "register"; -- Allow users to register on this server using a client and change passwords |
12322
b1cb236c4478
prosody.cfg.lua.dist: Add new modules
Kim Alvefur <zash@zash.se>
parents:
12321
diff
changeset
|
65 "invites"; -- Create and manage invites |
b1cb236c4478
prosody.cfg.lua.dist: Add new modules
Kim Alvefur <zash@zash.se>
parents:
12321
diff
changeset
|
66 "invites_register"; -- Create accounts using invites |
b1cb236c4478
prosody.cfg.lua.dist: Add new modules
Kim Alvefur <zash@zash.se>
parents:
12321
diff
changeset
|
67 "invites_adhoc"; -- Create invites via AdHoc command |
8258
503f424d4f07
prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents:
6345
diff
changeset
|
68 --"mam"; -- Store messages in an archive and allow users to access it |
12335
abfe210adcc4
prosody.cfg.lua.dist: TURN configuration improvements and example
Matthew Wild <mwild1@gmail.com>
parents:
12334
diff
changeset
|
69 --"turn_external"; -- Provide external STUN/TURN service for e.g. audio/video calls |
8258
503f424d4f07
prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents:
6345
diff
changeset
|
70 |
3767
3ba97d1d7a62
prosody.cfg.lua.dist: Update to reflect new mod_admin_* modules
Matthew Wild <mwild1@gmail.com>
parents:
3493
diff
changeset
|
71 -- Admin interfaces |
3ba97d1d7a62
prosody.cfg.lua.dist: Update to reflect new mod_admin_* modules
Matthew Wild <mwild1@gmail.com>
parents:
3493
diff
changeset
|
72 "admin_adhoc"; -- Allows administration via an XMPP client that supports ad-hoc commands |
3ba97d1d7a62
prosody.cfg.lua.dist: Update to reflect new mod_admin_* modules
Matthew Wild <mwild1@gmail.com>
parents:
3493
diff
changeset
|
73 --"admin_telnet"; -- Opens telnet console interface on localhost port 5582 |
12322
b1cb236c4478
prosody.cfg.lua.dist: Add new modules
Kim Alvefur <zash@zash.se>
parents:
12321
diff
changeset
|
74 "admin_shell"; -- Allow secure administration via an UNIX socket |
8258
503f424d4f07
prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents:
6345
diff
changeset
|
75 |
4775
ab73a32a655e
prosody.cfg.lua.dist: Rename mod_httpserver to mod_http_files, and move both it and mod_bosh to a new 'HTTP modules' category
Matthew Wild <mwild1@gmail.com>
parents:
4497
diff
changeset
|
76 -- HTTP modules |
ab73a32a655e
prosody.cfg.lua.dist: Rename mod_httpserver to mod_http_files, and move both it and mod_bosh to a new 'HTTP modules' category
Matthew Wild <mwild1@gmail.com>
parents:
4497
diff
changeset
|
77 --"bosh"; -- Enable BOSH clients, aka "Jabber over HTTP" |
8273
ca881f4bc415
prosody.cfg.lua.dist: Correct mod_websockets to mod_websocket
Kim Alvefur <zash@zash.se>
parents:
8261
diff
changeset
|
78 --"websocket"; -- XMPP over WebSockets |
12322
b1cb236c4478
prosody.cfg.lua.dist: Add new modules
Kim Alvefur <zash@zash.se>
parents:
12321
diff
changeset
|
79 --"http_openmetrics"; -- for exposing metrics to stats collectors |
2694
a6d80b6e9ee1
prosody.cfg.lua.dist: Update config for 0.7, most improvements from the Arch Linux package by dbb, thanks!
Matthew Wild <mwild1@gmail.com>
parents:
2408
diff
changeset
|
80 |
2982
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
81 -- Other specific functionality |
2984 | 82 --"groups"; -- Shared roster support |
8258
503f424d4f07
prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents:
6345
diff
changeset
|
83 --"server_contact_info"; -- Publish contact information for this service |
2984 | 84 --"announce"; -- Send announcement to all online users |
85 --"welcome"; -- Welcome users who register accounts | |
86 --"watchregistrations"; -- Alert admins of registrations | |
4084
680df3c635c6
prosody.cfg.lua.dist: Add motd plugin
Matthew Wild <mwild1@gmail.com>
parents:
3907
diff
changeset
|
87 --"motd"; -- Send a message to users when they log in |
4497
f42a0833c47c
prosody.cfg.lua.dist: Comment mod_legacyauth by default (thanks Zash)
Matthew Wild <mwild1@gmail.com>
parents:
4233
diff
changeset
|
88 --"legacyauth"; -- Legacy authentication. Only used by some old clients and bots. |
8258
503f424d4f07
prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents:
6345
diff
changeset
|
89 --"proxy65"; -- Enables a file transfer proxy service which clients behind NAT can use |
12322
b1cb236c4478
prosody.cfg.lua.dist: Add new modules
Kim Alvefur <zash@zash.se>
parents:
12321
diff
changeset
|
90 --"mimicking"; -- Prevent address spoofing |
b1cb236c4478
prosody.cfg.lua.dist: Add new modules
Kim Alvefur <zash@zash.se>
parents:
12321
diff
changeset
|
91 --"tombstones"; -- Prevent registration of deleted accounts |
b1cb236c4478
prosody.cfg.lua.dist: Add new modules
Kim Alvefur <zash@zash.se>
parents:
12321
diff
changeset
|
92 --"s2s_bidi"; -- Bi-directional server-to-server (XEP-0288) |
5624
187f734bc996
prosody.cfg.lua: Remove some more sneaky ';' characters from the config
Matthew Wild <mwild1@gmail.com>
parents:
5623
diff
changeset
|
93 } |
2024
46a9c7c99476
prosody.cfg.lua.dist: Convert to unix line endings from DOS
Matthew Wild <mwild1@gmail.com>
parents:
1810
diff
changeset
|
94 |
5409
8e98a58ab6a3
prosody.cfg.lua.dist: Update with new options and comments
Matthew Wild <mwild1@gmail.com>
parents:
5293
diff
changeset
|
95 -- These modules are auto-loaded, but should you want |
8e98a58ab6a3
prosody.cfg.lua.dist: Update with new options and comments
Matthew Wild <mwild1@gmail.com>
parents:
5293
diff
changeset
|
96 -- to disable them then uncomment them here: |
2982
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
97 modules_disabled = { |
4089
0bcbe6c24a6e
prosody.cfg.lua: Add mod_offline to the list of modules that can be disabled, and add comments for all auto-loaded modules
Matthew Wild <mwild1@gmail.com>
parents:
4087
diff
changeset
|
98 -- "offline"; -- Store offline messages |
5409
8e98a58ab6a3
prosody.cfg.lua.dist: Update with new options and comments
Matthew Wild <mwild1@gmail.com>
parents:
5293
diff
changeset
|
99 -- "c2s"; -- Handle client connections |
8e98a58ab6a3
prosody.cfg.lua.dist: Update with new options and comments
Matthew Wild <mwild1@gmail.com>
parents:
5293
diff
changeset
|
100 -- "s2s"; -- Handle server-to-server connections |
10422
cb6c0a5f9367
prosody.cfg.lua.dist: Remove mention of syslog near mod_posix
Kim Alvefur <zash@zash.se>
parents:
10176
diff
changeset
|
101 -- "posix"; -- POSIX functionality, sends server to background, etc. |
5623
5752391fa27d
prosody.cfg.lua.dist: Remove unnecessary ';' from default config (thanks Vincent)
Matthew Wild <mwild1@gmail.com>
parents:
5615
diff
changeset
|
102 } |
2982
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
103 |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
104 -- Disable account creation by default, for security |
8258
503f424d4f07
prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents:
6345
diff
changeset
|
105 -- For more information see https://prosody.im/doc/creating_accounts |
5624
187f734bc996
prosody.cfg.lua: Remove some more sneaky ';' characters from the config
Matthew Wild <mwild1@gmail.com>
parents:
5623
diff
changeset
|
106 allow_registration = false |
3412
7c66519f4973
prosody.cfg.lua.dist: Fixed trailing whitespace.
Waqas Hussain <waqas20@gmail.com>
parents:
3273
diff
changeset
|
107 |
12338
677ea3cc9c84
prosody.cfg.lua.dist: Improve section-like layout via headers and spacing
Matthew Wild <mwild1@gmail.com>
parents:
12337
diff
changeset
|
108 -- Server-to-server authentication |
12336
a8367f169740
prosody.cfg.lua.dist: Update s2s_secure_auth comment and default
Matthew Wild <mwild1@gmail.com>
parents:
12335
diff
changeset
|
109 -- Require valid certificates for server-to-server connections? |
a8367f169740
prosody.cfg.lua.dist: Update s2s_secure_auth comment and default
Matthew Wild <mwild1@gmail.com>
parents:
12335
diff
changeset
|
110 -- If false, other methods such as dialback (DNS) may be used instead. |
4086
c51737e6b445
prosody.cfg.lua.dist: Add note about the require_encryption options
Matthew Wild <mwild1@gmail.com>
parents:
4084
diff
changeset
|
111 |
12336
a8367f169740
prosody.cfg.lua.dist: Update s2s_secure_auth comment and default
Matthew Wild <mwild1@gmail.com>
parents:
12335
diff
changeset
|
112 s2s_secure_auth = true |
5409
8e98a58ab6a3
prosody.cfg.lua.dist: Update with new options and comments
Matthew Wild <mwild1@gmail.com>
parents:
5293
diff
changeset
|
113 |
8258
503f424d4f07
prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents:
6345
diff
changeset
|
114 -- Some servers have invalid or self-signed certificates. You can list |
503f424d4f07
prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents:
6345
diff
changeset
|
115 -- remote domains here that will not be required to authenticate using |
503f424d4f07
prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents:
6345
diff
changeset
|
116 -- certificates. They will be authenticated using DNS instead, even |
503f424d4f07
prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents:
6345
diff
changeset
|
117 -- when s2s_secure_auth is enabled. |
5409
8e98a58ab6a3
prosody.cfg.lua.dist: Update with new options and comments
Matthew Wild <mwild1@gmail.com>
parents:
5293
diff
changeset
|
118 |
8258
503f424d4f07
prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents:
6345
diff
changeset
|
119 --s2s_insecure_domains = { "insecure.example" } |
5409
8e98a58ab6a3
prosody.cfg.lua.dist: Update with new options and comments
Matthew Wild <mwild1@gmail.com>
parents:
5293
diff
changeset
|
120 |
9637
b8301ba2c437
prosody.cfg.lua.dist: Tidy up some comments
Matthew Wild <mwild1@gmail.com>
parents:
9636
diff
changeset
|
121 -- Even if you disable s2s_secure_auth, you can still require valid |
5573
ca9f99f7dcbc
prosody.cfg.lua.dist: Fix my s2s_secure(_auth) mess
Matthew Wild <mwild1@gmail.com>
parents:
5409
diff
changeset
|
122 -- certificates for some domains by specifying a list here. |
5409
8e98a58ab6a3
prosody.cfg.lua.dist: Update with new options and comments
Matthew Wild <mwild1@gmail.com>
parents:
5293
diff
changeset
|
123 |
5573
ca9f99f7dcbc
prosody.cfg.lua.dist: Fix my s2s_secure(_auth) mess
Matthew Wild <mwild1@gmail.com>
parents:
5409
diff
changeset
|
124 --s2s_secure_domains = { "jabber.org" } |
2694
a6d80b6e9ee1
prosody.cfg.lua.dist: Update config for 0.7, most improvements from the Arch Linux package by dbb, thanks!
Matthew Wild <mwild1@gmail.com>
parents:
2408
diff
changeset
|
125 |
12338
677ea3cc9c84
prosody.cfg.lua.dist: Improve section-like layout via headers and spacing
Matthew Wild <mwild1@gmail.com>
parents:
12337
diff
changeset
|
126 |
677ea3cc9c84
prosody.cfg.lua.dist: Improve section-like layout via headers and spacing
Matthew Wild <mwild1@gmail.com>
parents:
12337
diff
changeset
|
127 -- Rate limits |
12337
fea2d8fff5c6
prosody.cfg.lua.dist: Comment improvements
Matthew Wild <mwild1@gmail.com>
parents:
12336
diff
changeset
|
128 -- Enable rate limits for incoming client and server connections. These help |
fea2d8fff5c6
prosody.cfg.lua.dist: Comment improvements
Matthew Wild <mwild1@gmail.com>
parents:
12336
diff
changeset
|
129 -- protect from excessive resource consumption and denial-of-service attacks. |
11553
b0d8920ed5e5
prosody.cfg.lua.dist: Enable rate limits by default
Matthew Wild <mwild1@gmail.com>
parents:
9637
diff
changeset
|
130 |
b0d8920ed5e5
prosody.cfg.lua.dist: Enable rate limits by default
Matthew Wild <mwild1@gmail.com>
parents:
9637
diff
changeset
|
131 limits = { |
11572
e06dba5e99b9
prosody.cfg.lua.dist: Fix indentation to use tabs like the rest of the file
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
11560
diff
changeset
|
132 c2s = { |
e06dba5e99b9
prosody.cfg.lua.dist: Fix indentation to use tabs like the rest of the file
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
11560
diff
changeset
|
133 rate = "10kb/s"; |
e06dba5e99b9
prosody.cfg.lua.dist: Fix indentation to use tabs like the rest of the file
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
11560
diff
changeset
|
134 }; |
e06dba5e99b9
prosody.cfg.lua.dist: Fix indentation to use tabs like the rest of the file
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
11560
diff
changeset
|
135 s2sin = { |
e06dba5e99b9
prosody.cfg.lua.dist: Fix indentation to use tabs like the rest of the file
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
11560
diff
changeset
|
136 rate = "30kb/s"; |
e06dba5e99b9
prosody.cfg.lua.dist: Fix indentation to use tabs like the rest of the file
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents:
11560
diff
changeset
|
137 }; |
11553
b0d8920ed5e5
prosody.cfg.lua.dist: Enable rate limits by default
Matthew Wild <mwild1@gmail.com>
parents:
9637
diff
changeset
|
138 } |
b0d8920ed5e5
prosody.cfg.lua.dist: Enable rate limits by default
Matthew Wild <mwild1@gmail.com>
parents:
9637
diff
changeset
|
139 |
12338
677ea3cc9c84
prosody.cfg.lua.dist: Improve section-like layout via headers and spacing
Matthew Wild <mwild1@gmail.com>
parents:
12337
diff
changeset
|
140 -- Authentication |
4233
3c644c3b10e2
prosody.cfg.lua.dist: Add example of 'authentication' option
Matthew Wild <mwild1@gmail.com>
parents:
4091
diff
changeset
|
141 -- Select the authentication backend to use. The 'internal' providers |
3c644c3b10e2
prosody.cfg.lua.dist: Add example of 'authentication' option
Matthew Wild <mwild1@gmail.com>
parents:
4091
diff
changeset
|
142 -- use Prosody's configured data storage to store the authentication data. |
3c644c3b10e2
prosody.cfg.lua.dist: Add example of 'authentication' option
Matthew Wild <mwild1@gmail.com>
parents:
4091
diff
changeset
|
143 |
8258
503f424d4f07
prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents:
6345
diff
changeset
|
144 authentication = "internal_hashed" |
4233
3c644c3b10e2
prosody.cfg.lua.dist: Add example of 'authentication' option
Matthew Wild <mwild1@gmail.com>
parents:
4091
diff
changeset
|
145 |
12338
677ea3cc9c84
prosody.cfg.lua.dist: Improve section-like layout via headers and spacing
Matthew Wild <mwild1@gmail.com>
parents:
12337
diff
changeset
|
146 |
677ea3cc9c84
prosody.cfg.lua.dist: Improve section-like layout via headers and spacing
Matthew Wild <mwild1@gmail.com>
parents:
12337
diff
changeset
|
147 -- Storage |
4087
e239504d8fff
prosody.cfg.lua.dist: Update to include storage configuration and examples for SQL
Matthew Wild <mwild1@gmail.com>
parents:
4086
diff
changeset
|
148 -- Select the storage backend to use. By default Prosody uses flat files |
e239504d8fff
prosody.cfg.lua.dist: Update to include storage configuration and examples for SQL
Matthew Wild <mwild1@gmail.com>
parents:
4086
diff
changeset
|
149 -- in its configured data directory, but it also supports more backends |
e239504d8fff
prosody.cfg.lua.dist: Update to include storage configuration and examples for SQL
Matthew Wild <mwild1@gmail.com>
parents:
4086
diff
changeset
|
150 -- through modules. An "sql" backend is included by default, but requires |
8258
503f424d4f07
prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents:
6345
diff
changeset
|
151 -- additional dependencies. See https://prosody.im/doc/storage for more info. |
4087
e239504d8fff
prosody.cfg.lua.dist: Update to include storage configuration and examples for SQL
Matthew Wild <mwild1@gmail.com>
parents:
4086
diff
changeset
|
152 |
e239504d8fff
prosody.cfg.lua.dist: Update to include storage configuration and examples for SQL
Matthew Wild <mwild1@gmail.com>
parents:
4086
diff
changeset
|
153 --storage = "sql" -- Default is "internal" |
e239504d8fff
prosody.cfg.lua.dist: Update to include storage configuration and examples for SQL
Matthew Wild <mwild1@gmail.com>
parents:
4086
diff
changeset
|
154 |
e239504d8fff
prosody.cfg.lua.dist: Update to include storage configuration and examples for SQL
Matthew Wild <mwild1@gmail.com>
parents:
4086
diff
changeset
|
155 -- For the "sql" backend, you can uncomment *one* of the below to configure: |
e239504d8fff
prosody.cfg.lua.dist: Update to include storage configuration and examples for SQL
Matthew Wild <mwild1@gmail.com>
parents:
4086
diff
changeset
|
156 --sql = { driver = "SQLite3", database = "prosody.sqlite" } -- Default. 'database' is the filename. |
e239504d8fff
prosody.cfg.lua.dist: Update to include storage configuration and examples for SQL
Matthew Wild <mwild1@gmail.com>
parents:
4086
diff
changeset
|
157 --sql = { driver = "MySQL", database = "prosody", username = "prosody", password = "secret", host = "localhost" } |
e239504d8fff
prosody.cfg.lua.dist: Update to include storage configuration and examples for SQL
Matthew Wild <mwild1@gmail.com>
parents:
4086
diff
changeset
|
158 --sql = { driver = "PostgreSQL", database = "prosody", username = "prosody", password = "secret", host = "localhost" } |
e239504d8fff
prosody.cfg.lua.dist: Update to include storage configuration and examples for SQL
Matthew Wild <mwild1@gmail.com>
parents:
4086
diff
changeset
|
159 |
8258
503f424d4f07
prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents:
6345
diff
changeset
|
160 |
503f424d4f07
prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents:
6345
diff
changeset
|
161 -- Archiving configuration |
503f424d4f07
prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents:
6345
diff
changeset
|
162 -- If mod_mam is enabled, Prosody will store a copy of every message. This |
503f424d4f07
prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents:
6345
diff
changeset
|
163 -- is used to synchronize conversations between multiple clients, even if |
503f424d4f07
prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents:
6345
diff
changeset
|
164 -- they are offline. This setting controls how long Prosody will keep |
503f424d4f07
prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents:
6345
diff
changeset
|
165 -- messages in the archive before removing them. |
503f424d4f07
prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents:
6345
diff
changeset
|
166 |
503f424d4f07
prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents:
6345
diff
changeset
|
167 archive_expires_after = "1w" -- Remove archived messages after 1 week |
503f424d4f07
prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents:
6345
diff
changeset
|
168 |
503f424d4f07
prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents:
6345
diff
changeset
|
169 -- You can also configure messages to be stored in-memory only. For more |
503f424d4f07
prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents:
6345
diff
changeset
|
170 -- archiving options, see https://prosody.im/doc/modules/mod_mam |
503f424d4f07
prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents:
6345
diff
changeset
|
171 |
12335
abfe210adcc4
prosody.cfg.lua.dist: TURN configuration improvements and example
Matthew Wild <mwild1@gmail.com>
parents:
12334
diff
changeset
|
172 |
abfe210adcc4
prosody.cfg.lua.dist: TURN configuration improvements and example
Matthew Wild <mwild1@gmail.com>
parents:
12334
diff
changeset
|
173 -- Audio/video call relay (STUN/TURN) |
abfe210adcc4
prosody.cfg.lua.dist: TURN configuration improvements and example
Matthew Wild <mwild1@gmail.com>
parents:
12334
diff
changeset
|
174 -- To ensure clients connected to the server can establish connections for |
abfe210adcc4
prosody.cfg.lua.dist: TURN configuration improvements and example
Matthew Wild <mwild1@gmail.com>
parents:
12334
diff
changeset
|
175 -- low-latency media streaming (such as audio and video calls), it is |
abfe210adcc4
prosody.cfg.lua.dist: TURN configuration improvements and example
Matthew Wild <mwild1@gmail.com>
parents:
12334
diff
changeset
|
176 -- recommended to run a STUN/TURN server for clients to use. If you do this, |
abfe210adcc4
prosody.cfg.lua.dist: TURN configuration improvements and example
Matthew Wild <mwild1@gmail.com>
parents:
12334
diff
changeset
|
177 -- specify the details here so clients can discover it. |
abfe210adcc4
prosody.cfg.lua.dist: TURN configuration improvements and example
Matthew Wild <mwild1@gmail.com>
parents:
12334
diff
changeset
|
178 -- Find more information at https://prosody.im/doc/turn |
abfe210adcc4
prosody.cfg.lua.dist: TURN configuration improvements and example
Matthew Wild <mwild1@gmail.com>
parents:
12334
diff
changeset
|
179 |
abfe210adcc4
prosody.cfg.lua.dist: TURN configuration improvements and example
Matthew Wild <mwild1@gmail.com>
parents:
12334
diff
changeset
|
180 --turn_external_host = "turn.example.com" |
abfe210adcc4
prosody.cfg.lua.dist: TURN configuration improvements and example
Matthew Wild <mwild1@gmail.com>
parents:
12334
diff
changeset
|
181 --turn_external_secret = "your-secret-turn-access-token" |
abfe210adcc4
prosody.cfg.lua.dist: TURN configuration improvements and example
Matthew Wild <mwild1@gmail.com>
parents:
12334
diff
changeset
|
182 |
12338
677ea3cc9c84
prosody.cfg.lua.dist: Improve section-like layout via headers and spacing
Matthew Wild <mwild1@gmail.com>
parents:
12337
diff
changeset
|
183 |
2984 | 184 -- Logging configuration |
8258
503f424d4f07
prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents:
6345
diff
changeset
|
185 -- For advanced logging see https://prosody.im/doc/logging |
3906
877262704c44
prosody.cfg.lua.dist: Update for new logging config format
Matthew Wild <mwild1@gmail.com>
parents:
3767
diff
changeset
|
186 log = { |
4090
111734f49a65
prosody.cfg.lua: Improve comment about enabling debug logging
Matthew Wild <mwild1@gmail.com>
parents:
4089
diff
changeset
|
187 info = "prosody.log"; -- Change 'info' to 'debug' for verbose logging |
3906
877262704c44
prosody.cfg.lua.dist: Update for new logging config format
Matthew Wild <mwild1@gmail.com>
parents:
3767
diff
changeset
|
188 error = "prosody.err"; |
877262704c44
prosody.cfg.lua.dist: Update for new logging config format
Matthew Wild <mwild1@gmail.com>
parents:
3767
diff
changeset
|
189 -- "*syslog"; -- Uncomment this for logging to syslog |
12324
041602327fc2
prosody.cfg.lua.dist: Remove mention of deprecated daemonize option
Kim Alvefur <zash@zash.se>
parents:
12323
diff
changeset
|
190 -- "*console"; -- Log to the console, useful for debugging when running in the foreground |
3906
877262704c44
prosody.cfg.lua.dist: Update for new logging config format
Matthew Wild <mwild1@gmail.com>
parents:
3767
diff
changeset
|
191 } |
2984 | 192 |
12338
677ea3cc9c84
prosody.cfg.lua.dist: Improve section-like layout via headers and spacing
Matthew Wild <mwild1@gmail.com>
parents:
12337
diff
changeset
|
193 |
8258
503f424d4f07
prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents:
6345
diff
changeset
|
194 -- Uncomment to enable statistics |
503f424d4f07
prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents:
6345
diff
changeset
|
195 -- For more info see https://prosody.im/doc/statistics |
503f424d4f07
prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents:
6345
diff
changeset
|
196 -- statistics = "internal" |
503f424d4f07
prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents:
6345
diff
changeset
|
197 |
12338
677ea3cc9c84
prosody.cfg.lua.dist: Improve section-like layout via headers and spacing
Matthew Wild <mwild1@gmail.com>
parents:
12337
diff
changeset
|
198 |
8260
17c630b243ce
prosody.cfg.lua.dist: Further tweaks in preparation for 0.10.0
Matthew Wild <mwild1@gmail.com>
parents:
8258
diff
changeset
|
199 -- Certificates |
17c630b243ce
prosody.cfg.lua.dist: Further tweaks in preparation for 0.10.0
Matthew Wild <mwild1@gmail.com>
parents:
8258
diff
changeset
|
200 -- Every virtual host and component needs a certificate so that clients and |
17c630b243ce
prosody.cfg.lua.dist: Further tweaks in preparation for 0.10.0
Matthew Wild <mwild1@gmail.com>
parents:
8258
diff
changeset
|
201 -- servers can securely verify its identity. Prosody will automatically load |
8261
012208387396
prosody.cfg.lua.dist: Improve certificates comment
Matthew Wild <mwild1@gmail.com>
parents:
8260
diff
changeset
|
202 -- certificates/keys from the directory specified here. |
8260
17c630b243ce
prosody.cfg.lua.dist: Further tweaks in preparation for 0.10.0
Matthew Wild <mwild1@gmail.com>
parents:
8258
diff
changeset
|
203 -- For more information, including how to use 'prosodyctl' to auto-import certificates |
17c630b243ce
prosody.cfg.lua.dist: Further tweaks in preparation for 0.10.0
Matthew Wild <mwild1@gmail.com>
parents:
8258
diff
changeset
|
204 -- (from e.g. Let's Encrypt) see https://prosody.im/doc/certificates |
17c630b243ce
prosody.cfg.lua.dist: Further tweaks in preparation for 0.10.0
Matthew Wild <mwild1@gmail.com>
parents:
8258
diff
changeset
|
205 |
8261
012208387396
prosody.cfg.lua.dist: Improve certificates comment
Matthew Wild <mwild1@gmail.com>
parents:
8260
diff
changeset
|
206 -- Location of directory to find certificates in (relative to main config file): |
8260
17c630b243ce
prosody.cfg.lua.dist: Further tweaks in preparation for 0.10.0
Matthew Wild <mwild1@gmail.com>
parents:
8258
diff
changeset
|
207 certificates = "certs" |
17c630b243ce
prosody.cfg.lua.dist: Further tweaks in preparation for 0.10.0
Matthew Wild <mwild1@gmail.com>
parents:
8258
diff
changeset
|
208 |
2982
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
209 ----------- Virtual hosts ----------- |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
210 -- You need to add a VirtualHost entry for each domain you wish Prosody to serve. |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
211 -- Settings under each VirtualHost entry apply *only* to that host. |
2024
46a9c7c99476
prosody.cfg.lua.dist: Convert to unix line endings from DOS
Matthew Wild <mwild1@gmail.com>
parents:
1810
diff
changeset
|
212 |
2982
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
213 VirtualHost "localhost" |
12321
398c5f5db934
prosody.cfg.lua.dist: Add note about 'localhost'
Kim Alvefur <zash@zash.se>
parents:
12277
diff
changeset
|
214 -- Prosody requires at least one enabled VirtualHost to function. You can |
398c5f5db934
prosody.cfg.lua.dist: Add note about 'localhost'
Kim Alvefur <zash@zash.se>
parents:
12277
diff
changeset
|
215 -- safely remove or disable 'localhost' once you have added another. |
398c5f5db934
prosody.cfg.lua.dist: Add note about 'localhost'
Kim Alvefur <zash@zash.se>
parents:
12277
diff
changeset
|
216 |
2024
46a9c7c99476
prosody.cfg.lua.dist: Convert to unix line endings from DOS
Matthew Wild <mwild1@gmail.com>
parents:
1810
diff
changeset
|
217 |
8260
17c630b243ce
prosody.cfg.lua.dist: Further tweaks in preparation for 0.10.0
Matthew Wild <mwild1@gmail.com>
parents:
8258
diff
changeset
|
218 --VirtualHost "example.com" |
17c630b243ce
prosody.cfg.lua.dist: Further tweaks in preparation for 0.10.0
Matthew Wild <mwild1@gmail.com>
parents:
8258
diff
changeset
|
219 -- certificate = "/path/to/example.crt" |
2024
46a9c7c99476
prosody.cfg.lua.dist: Convert to unix line endings from DOS
Matthew Wild <mwild1@gmail.com>
parents:
1810
diff
changeset
|
220 |
2982
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
221 ------ Components ------ |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
222 -- You can specify components to add hosts that provide special services, |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
223 -- like multi-user conferences, and transports. |
8258
503f424d4f07
prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents:
6345
diff
changeset
|
224 -- For more information on components, see https://prosody.im/doc/components |
2982
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
225 |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
226 ---Set up a MUC (multi-user chat) room server on conference.example.com: |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
227 --Component "conference.example.com" "muc" |
9592
c9ddc51053b7
prosody.cfg.lua.dist: Add mod_muc_mam to example MUC section
Kim Alvefur <zash@zash.se>
parents:
9591
diff
changeset
|
228 --- Store MUC messages in an archive and allow users to access it |
c9ddc51053b7
prosody.cfg.lua.dist: Add mod_muc_mam to example MUC section
Kim Alvefur <zash@zash.se>
parents:
9591
diff
changeset
|
229 --modules_enabled = { "muc_mam" } |
2982
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
230 |
12322
b1cb236c4478
prosody.cfg.lua.dist: Add new modules
Kim Alvefur <zash@zash.se>
parents:
12321
diff
changeset
|
231 ---Set up a file sharing component |
b1cb236c4478
prosody.cfg.lua.dist: Add new modules
Kim Alvefur <zash@zash.se>
parents:
12321
diff
changeset
|
232 --Component "share.example.com" "http_file_share" |
b1cb236c4478
prosody.cfg.lua.dist: Add new modules
Kim Alvefur <zash@zash.se>
parents:
12321
diff
changeset
|
233 |
2982
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
234 ---Set up an external component (default component port is 5347) |
3907
1e82c9b9db11
prosody.cfg.lua.dist: Add note about external gateways
Matthew Wild <mwild1@gmail.com>
parents:
3906
diff
changeset
|
235 -- |
1e82c9b9db11
prosody.cfg.lua.dist: Add note about external gateways
Matthew Wild <mwild1@gmail.com>
parents:
3906
diff
changeset
|
236 -- External components allow adding various services, such as gateways/ |
12337
fea2d8fff5c6
prosody.cfg.lua.dist: Comment improvements
Matthew Wild <mwild1@gmail.com>
parents:
12336
diff
changeset
|
237 -- bridges to non-XMPP networks and services. For more info |
8258
503f424d4f07
prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents:
6345
diff
changeset
|
238 -- see: https://prosody.im/doc/components#adding_an_external_component |
3907
1e82c9b9db11
prosody.cfg.lua.dist: Add note about external gateways
Matthew Wild <mwild1@gmail.com>
parents:
3906
diff
changeset
|
239 -- |
2982
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
240 --Component "gateway.example.com" |
0395f2f34bd5
prosody.cfg.lua.dist: Refactor the default config file based on feedback from confused users
Matthew Wild <mwild1@gmail.com>
parents:
2829
diff
changeset
|
241 -- component_secret = "password" |
12276
7c5e6ad3d778
prosody.cfg.lua.dist: Warn about adding settings at the end of the file
Kim Alvefur <zash@zash.se>
parents:
11581
diff
changeset
|
242 |
7c5e6ad3d778
prosody.cfg.lua.dist: Warn about adding settings at the end of the file
Kim Alvefur <zash@zash.se>
parents:
11581
diff
changeset
|
243 |
7c5e6ad3d778
prosody.cfg.lua.dist: Warn about adding settings at the end of the file
Kim Alvefur <zash@zash.se>
parents:
11581
diff
changeset
|
244 ---------- End of the Prosody Configuration file ---------- |
7c5e6ad3d778
prosody.cfg.lua.dist: Warn about adding settings at the end of the file
Kim Alvefur <zash@zash.se>
parents:
11581
diff
changeset
|
245 -- You usually **DO NOT** want to add settings here at the end, as they would |
7c5e6ad3d778
prosody.cfg.lua.dist: Warn about adding settings at the end of the file
Kim Alvefur <zash@zash.se>
parents:
11581
diff
changeset
|
246 -- only apply to the last defined VirtualHost or Component. |
7c5e6ad3d778
prosody.cfg.lua.dist: Warn about adding settings at the end of the file
Kim Alvefur <zash@zash.se>
parents:
11581
diff
changeset
|
247 -- |
7c5e6ad3d778
prosody.cfg.lua.dist: Warn about adding settings at the end of the file
Kim Alvefur <zash@zash.se>
parents:
11581
diff
changeset
|
248 -- Settings for the global section should go higher up, before the first |
7c5e6ad3d778
prosody.cfg.lua.dist: Warn about adding settings at the end of the file
Kim Alvefur <zash@zash.se>
parents:
11581
diff
changeset
|
249 -- VirtualHost or Component line, while settings intended for specific hosts |
7c5e6ad3d778
prosody.cfg.lua.dist: Warn about adding settings at the end of the file
Kim Alvefur <zash@zash.se>
parents:
11581
diff
changeset
|
250 -- should go under the corresponding VirtualHost or Component line. |
12277
e921295e934c
prosody.cfg.lua.dist: Link to website (thanks eta)
Kim Alvefur <zash@zash.se>
parents:
12276
diff
changeset
|
251 -- |
e921295e934c
prosody.cfg.lua.dist: Link to website (thanks eta)
Kim Alvefur <zash@zash.se>
parents:
12276
diff
changeset
|
252 -- For more information see https://prosody.im/doc/configure |