prosody
06453c564141
prosody.cfg.lua.dist

Find changesets by keywords by author, files, the commit message, revision number or hash, or revset expression.

Software / code / prosody

Annotate

prosody.cfg.lua.dist @ 13014:06453c564141

util.startup: Add prosody.started promise to easily execute code after startup To avoid a race where server-started fires before the promise function body is run (on next tick), I moved server-started to fire on the next tick, which seems sensible anyway. Errors are logged, I'm not sure if we ought to be doing something more here. I'm sure we'll find out.
author Matthew Wild <mwild1@gmail.com>
date Sat, 01 Apr 2023 11:56:38 +0100
parent 12352:bad813103cd4
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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
12351
1418fd275b81 prosody.cfg.lua.dist: Fix plugin_paths description (thanks Zash)
Matthew Wild <mwild1@gmail.com>
parents: 12350
diff changeset
26 -- This option allows you to specify additional locations where Prosody
1418fd275b81 prosody.cfg.lua.dist: Fix plugin_paths description (thanks Zash)
Matthew Wild <mwild1@gmail.com>
parents: 12350
diff changeset
27 -- will search first for modules. For additional modules you can install, see
1418fd275b81 prosody.cfg.lua.dist: Fix plugin_paths description (thanks Zash)
Matthew Wild <mwild1@gmail.com>
parents: 12350
diff changeset
28 -- the community module repository at https://modules.prosody.im/
8258
503f424d4f07 prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents: 6345
diff changeset
29 --plugin_paths = {}
503f424d4f07 prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents: 6345
diff changeset
30
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
31 -- This is the list of modules Prosody will load on startup.
8258
503f424d4f07 prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents: 6345
diff changeset
32 -- 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
33 modules_enabled = {
2024
46a9c7c99476 prosody.cfg.lua.dist: Convert to unix line endings from DOS
Matthew Wild <mwild1@gmail.com>
parents: 1810
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 -- Generally required
12348
a95940c32ed0 prosody.cfg.lua.dist: Alphabetical ordering of modules within each section
Matthew Wild <mwild1@gmail.com>
parents: 12347
diff changeset
36 "disco"; -- Service discovery
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
37 "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
38 "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
39 "tls"; -- Add support for secure TLS on c2s/s2s connections
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
40
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
41 -- Not essential, but recommended
12348
a95940c32ed0 prosody.cfg.lua.dist: Alphabetical ordering of modules within each section
Matthew Wild <mwild1@gmail.com>
parents: 12347
diff changeset
42 "blocklist"; -- Allow users to block communications with other users
12349
89c638496fe1 prosody.cfg.lua.dist: Improved descriptions for a number of modules
Matthew Wild <mwild1@gmail.com>
parents: 12348
diff changeset
43 "bookmarks"; -- Synchronise the list of open rooms between clients
89c638496fe1 prosody.cfg.lua.dist: Improved descriptions for a number of modules
Matthew Wild <mwild1@gmail.com>
parents: 12348
diff changeset
44 "carbons"; -- Keep multiple online clients in sync
89c638496fe1 prosody.cfg.lua.dist: Improved descriptions for a number of modules
Matthew Wild <mwild1@gmail.com>
parents: 12348
diff changeset
45 "dialback"; -- Support for verifying remote servers using DNS
12348
a95940c32ed0 prosody.cfg.lua.dist: Alphabetical ordering of modules within each section
Matthew Wild <mwild1@gmail.com>
parents: 12347
diff changeset
46 "limits"; -- Enable bandwidth limiting for XMPP connections
12349
89c638496fe1 prosody.cfg.lua.dist: Improved descriptions for a number of modules
Matthew Wild <mwild1@gmail.com>
parents: 12348
diff changeset
47 "pep"; -- Allow users to store public and private data in their account
89c638496fe1 prosody.cfg.lua.dist: Improved descriptions for a number of modules
Matthew Wild <mwild1@gmail.com>
parents: 12348
diff changeset
48 "private"; -- Legacy account storage mechanism (XEP-0049)
12348
a95940c32ed0 prosody.cfg.lua.dist: Alphabetical ordering of modules within each section
Matthew Wild <mwild1@gmail.com>
parents: 12347
diff changeset
49 "smacks"; -- Stream management and resumption (XEP-0198)
9593
6e1379473c3c prosody.cfg.lua.dist: Replace old vcard module with new ones
Kim Alvefur <zash@zash.se>
parents: 9592
diff changeset
50 "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
51 "vcard_legacy"; -- Conversion between legacy vCard and PEP Avatar, vcard
2984
3094166cfdd5 Merge 0.6 into 0.7.
Waqas Hussain <waqas20@gmail.com>
parents: 2931 2982
diff changeset
52
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
53 -- Nice to have
12349
89c638496fe1 prosody.cfg.lua.dist: Improved descriptions for a number of modules
Matthew Wild <mwild1@gmail.com>
parents: 12348
diff changeset
54 "csi_simple"; -- Simple but effective traffic optimizations for mobile devices
12322
b1cb236c4478 prosody.cfg.lua.dist: Add new modules
Kim Alvefur <zash@zash.se>
parents: 12321
diff changeset
55 "invites"; -- Create and manage invites
12349
89c638496fe1 prosody.cfg.lua.dist: Improved descriptions for a number of modules
Matthew Wild <mwild1@gmail.com>
parents: 12348
diff changeset
56 "invites_adhoc"; -- Allow admins/users to create invitations via their client
89c638496fe1 prosody.cfg.lua.dist: Improved descriptions for a number of modules
Matthew Wild <mwild1@gmail.com>
parents: 12348
diff changeset
57 "invites_register"; -- Allows invited users to create accounts
12348
a95940c32ed0 prosody.cfg.lua.dist: Alphabetical ordering of modules within each section
Matthew Wild <mwild1@gmail.com>
parents: 12347
diff changeset
58 "ping"; -- Replies to XMPP pings with pongs
a95940c32ed0 prosody.cfg.lua.dist: Alphabetical ordering of modules within each section
Matthew Wild <mwild1@gmail.com>
parents: 12347
diff changeset
59 "register"; -- Allow users to register on this server using a client and change passwords
a95940c32ed0 prosody.cfg.lua.dist: Alphabetical ordering of modules within each section
Matthew Wild <mwild1@gmail.com>
parents: 12347
diff changeset
60 "time"; -- Let others know the time here on this server
a95940c32ed0 prosody.cfg.lua.dist: Alphabetical ordering of modules within each section
Matthew Wild <mwild1@gmail.com>
parents: 12347
diff changeset
61 "uptime"; -- Report how long server has been running
a95940c32ed0 prosody.cfg.lua.dist: Alphabetical ordering of modules within each section
Matthew Wild <mwild1@gmail.com>
parents: 12347
diff changeset
62 "version"; -- Replies to server version requests
12347
bedf13eb573f prosody.cfg.lua.dist: Improve mod_mam description to indicate its purpose
Matthew Wild <mwild1@gmail.com>
parents: 12346
diff changeset
63 --"mam"; -- Store recent messages to allow multi-device synchronization
12335
abfe210adcc4 prosody.cfg.lua.dist: TURN configuration improvements and example
Matthew Wild <mwild1@gmail.com>
parents: 12334
diff changeset
64 --"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
65
3767
3ba97d1d7a62 prosody.cfg.lua.dist: Update to reflect new mod_admin_* modules
Matthew Wild <mwild1@gmail.com>
parents: 3493
diff changeset
66 -- Admin interfaces
3ba97d1d7a62 prosody.cfg.lua.dist: Update to reflect new mod_admin_* modules
Matthew Wild <mwild1@gmail.com>
parents: 3493
diff changeset
67 "admin_adhoc"; -- Allows administration via an XMPP client that supports ad-hoc commands
12346
2b5806c092f9 prosody.cfg.lua.dist: Remove mod_admin_telnet
Matthew Wild <mwild1@gmail.com>
parents: 12345
diff changeset
68 "admin_shell"; -- Allow secure administration via 'prosodyctl shell'
8258
503f424d4f07 prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents: 6345
diff changeset
69
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
70 -- 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
71 --"bosh"; -- Enable BOSH clients, aka "Jabber over HTTP"
12348
a95940c32ed0 prosody.cfg.lua.dist: Alphabetical ordering of modules within each section
Matthew Wild <mwild1@gmail.com>
parents: 12347
diff changeset
72 --"http_openmetrics"; -- for exposing metrics to stats collectors
8273
ca881f4bc415 prosody.cfg.lua.dist: Correct mod_websockets to mod_websocket
Kim Alvefur <zash@zash.se>
parents: 8261
diff changeset
73 --"websocket"; -- XMPP over WebSockets
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
74
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
75 -- Other specific functionality
12348
a95940c32ed0 prosody.cfg.lua.dist: Alphabetical ordering of modules within each section
Matthew Wild <mwild1@gmail.com>
parents: 12347
diff changeset
76 --"announce"; -- Send announcement to all online users
2984
3094166cfdd5 Merge 0.6 into 0.7.
Waqas Hussain <waqas20@gmail.com>
parents: 2931 2982
diff changeset
77 --"groups"; -- Shared roster support
12348
a95940c32ed0 prosody.cfg.lua.dist: Alphabetical ordering of modules within each section
Matthew Wild <mwild1@gmail.com>
parents: 12347
diff changeset
78 --"legacyauth"; -- Legacy authentication. Only used by some old clients and bots.
a95940c32ed0 prosody.cfg.lua.dist: Alphabetical ordering of modules within each section
Matthew Wild <mwild1@gmail.com>
parents: 12347
diff changeset
79 --"mimicking"; -- Prevent address spoofing
4084
680df3c635c6 prosody.cfg.lua.dist: Add motd plugin
Matthew Wild <mwild1@gmail.com>
parents: 3907
diff changeset
80 --"motd"; -- Send a message to users when they log in
8258
503f424d4f07 prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents: 6345
diff changeset
81 --"proxy65"; -- Enables a file transfer proxy service which clients behind NAT can use
12348
a95940c32ed0 prosody.cfg.lua.dist: Alphabetical ordering of modules within each section
Matthew Wild <mwild1@gmail.com>
parents: 12347
diff changeset
82 --"s2s_bidi"; -- Bi-directional server-to-server (XEP-0288)
a95940c32ed0 prosody.cfg.lua.dist: Alphabetical ordering of modules within each section
Matthew Wild <mwild1@gmail.com>
parents: 12347
diff changeset
83 --"server_contact_info"; -- Publish contact information for this service
12322
b1cb236c4478 prosody.cfg.lua.dist: Add new modules
Kim Alvefur <zash@zash.se>
parents: 12321
diff changeset
84 --"tombstones"; -- Prevent registration of deleted accounts
12348
a95940c32ed0 prosody.cfg.lua.dist: Alphabetical ordering of modules within each section
Matthew Wild <mwild1@gmail.com>
parents: 12347
diff changeset
85 --"watchregistrations"; -- Alert admins of registrations
a95940c32ed0 prosody.cfg.lua.dist: Alphabetical ordering of modules within each section
Matthew Wild <mwild1@gmail.com>
parents: 12347
diff changeset
86 --"welcome"; -- Welcome users who register accounts
5624
187f734bc996 prosody.cfg.lua: Remove some more sneaky ';' characters from the config
Matthew Wild <mwild1@gmail.com>
parents: 5623
diff changeset
87 }
2024
46a9c7c99476 prosody.cfg.lua.dist: Convert to unix line endings from DOS
Matthew Wild <mwild1@gmail.com>
parents: 1810
diff changeset
88
5409
8e98a58ab6a3 prosody.cfg.lua.dist: Update with new options and comments
Matthew Wild <mwild1@gmail.com>
parents: 5293
diff changeset
89 -- 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
90 -- 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
91 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
92 -- "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
93 -- "c2s"; -- Handle client connections
8e98a58ab6a3 prosody.cfg.lua.dist: Update with new options and comments
Matthew Wild <mwild1@gmail.com>
parents: 5293
diff changeset
94 -- "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
95 -- "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
96 }
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
3412
7c66519f4973 prosody.cfg.lua.dist: Fixed trailing whitespace.
Waqas Hussain <waqas20@gmail.com>
parents: 3273
diff changeset
98
12338
677ea3cc9c84 prosody.cfg.lua.dist: Improve section-like layout via headers and spacing
Matthew Wild <mwild1@gmail.com>
parents: 12337
diff changeset
99 -- 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
100 -- 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
101 -- 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
102
12336
a8367f169740 prosody.cfg.lua.dist: Update s2s_secure_auth comment and default
Matthew Wild <mwild1@gmail.com>
parents: 12335
diff changeset
103 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
104
8258
503f424d4f07 prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents: 6345
diff changeset
105 -- 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
106 -- remote domains here that will not be required to authenticate using
12340
7d132ea04a05 prosody.cfg.lua.dist: Comment improvements: s2s authentication
Matthew Wild <mwild1@gmail.com>
parents: 12339
diff changeset
107 -- certificates. They will be authenticated using other methods instead,
7d132ea04a05 prosody.cfg.lua.dist: Comment improvements: s2s authentication
Matthew Wild <mwild1@gmail.com>
parents: 12339
diff changeset
108 -- even 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
109
8258
503f424d4f07 prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents: 6345
diff changeset
110 --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
111
9637
b8301ba2c437 prosody.cfg.lua.dist: Tidy up some comments
Matthew Wild <mwild1@gmail.com>
parents: 9636
diff changeset
112 -- 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
113 -- 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
114
5573
ca9f99f7dcbc prosody.cfg.lua.dist: Fix my s2s_secure(_auth) mess
Matthew Wild <mwild1@gmail.com>
parents: 5409
diff changeset
115 --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
116
12338
677ea3cc9c84 prosody.cfg.lua.dist: Improve section-like layout via headers and spacing
Matthew Wild <mwild1@gmail.com>
parents: 12337
diff changeset
117
677ea3cc9c84 prosody.cfg.lua.dist: Improve section-like layout via headers and spacing
Matthew Wild <mwild1@gmail.com>
parents: 12337
diff changeset
118 -- Rate limits
12337
fea2d8fff5c6 prosody.cfg.lua.dist: Comment improvements
Matthew Wild <mwild1@gmail.com>
parents: 12336
diff changeset
119 -- 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
120 -- 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
121
b0d8920ed5e5 prosody.cfg.lua.dist: Enable rate limits by default
Matthew Wild <mwild1@gmail.com>
parents: 9637
diff changeset
122 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
123 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
124 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
125 };
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
126 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
127 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
128 };
11553
b0d8920ed5e5 prosody.cfg.lua.dist: Enable rate limits by default
Matthew Wild <mwild1@gmail.com>
parents: 9637
diff changeset
129 }
b0d8920ed5e5 prosody.cfg.lua.dist: Enable rate limits by default
Matthew Wild <mwild1@gmail.com>
parents: 9637
diff changeset
130
12338
677ea3cc9c84 prosody.cfg.lua.dist: Improve section-like layout via headers and spacing
Matthew Wild <mwild1@gmail.com>
parents: 12337
diff changeset
131 -- Authentication
4233
3c644c3b10e2 prosody.cfg.lua.dist: Add example of 'authentication' option
Matthew Wild <mwild1@gmail.com>
parents: 4091
diff changeset
132 -- 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
133 -- use Prosody's configured data storage to store the authentication data.
12339
4ba0a0dfa047 prosody.cfg.lua.dist: Comment improvements: authentication
Matthew Wild <mwild1@gmail.com>
parents: 12338
diff changeset
134 -- For more information see https://prosody.im/doc/authentication
4233
3c644c3b10e2 prosody.cfg.lua.dist: Add example of 'authentication' option
Matthew Wild <mwild1@gmail.com>
parents: 4091
diff changeset
135
8258
503f424d4f07 prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents: 6345
diff changeset
136 authentication = "internal_hashed"
4233
3c644c3b10e2 prosody.cfg.lua.dist: Add example of 'authentication' option
Matthew Wild <mwild1@gmail.com>
parents: 4091
diff changeset
137
12339
4ba0a0dfa047 prosody.cfg.lua.dist: Comment improvements: authentication
Matthew Wild <mwild1@gmail.com>
parents: 12338
diff changeset
138 -- Many authentication providers, including the default one, allow you to
4ba0a0dfa047 prosody.cfg.lua.dist: Comment improvements: authentication
Matthew Wild <mwild1@gmail.com>
parents: 12338
diff changeset
139 -- create user accounts via Prosody's admin interfaces. For details, see the
4ba0a0dfa047 prosody.cfg.lua.dist: Comment improvements: authentication
Matthew Wild <mwild1@gmail.com>
parents: 12338
diff changeset
140 -- documentation at https://prosody.im/doc/creating_accounts
4ba0a0dfa047 prosody.cfg.lua.dist: Comment improvements: authentication
Matthew Wild <mwild1@gmail.com>
parents: 12338
diff changeset
141
12338
677ea3cc9c84 prosody.cfg.lua.dist: Improve section-like layout via headers and spacing
Matthew Wild <mwild1@gmail.com>
parents: 12337
diff changeset
142
677ea3cc9c84 prosody.cfg.lua.dist: Improve section-like layout via headers and spacing
Matthew Wild <mwild1@gmail.com>
parents: 12337
diff changeset
143 -- 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
144 -- 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
145 -- 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
146 -- 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
147 -- 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
148
e239504d8fff prosody.cfg.lua.dist: Update to include storage configuration and examples for SQL
Matthew Wild <mwild1@gmail.com>
parents: 4086
diff changeset
149 --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
150
e239504d8fff prosody.cfg.lua.dist: Update to include storage configuration and examples for SQL
Matthew Wild <mwild1@gmail.com>
parents: 4086
diff changeset
151 -- 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
152 --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
153 --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
154 --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
155
8258
503f424d4f07 prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents: 6345
diff changeset
156
503f424d4f07 prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents: 6345
diff changeset
157 -- Archiving configuration
503f424d4f07 prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents: 6345
diff changeset
158 -- 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
159 -- 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
160 -- 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
161 -- 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
162
503f424d4f07 prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents: 6345
diff changeset
163 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
164
503f424d4f07 prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents: 6345
diff changeset
165 -- 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
166 -- 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
167
12335
abfe210adcc4 prosody.cfg.lua.dist: TURN configuration improvements and example
Matthew Wild <mwild1@gmail.com>
parents: 12334
diff changeset
168
abfe210adcc4 prosody.cfg.lua.dist: TURN configuration improvements and example
Matthew Wild <mwild1@gmail.com>
parents: 12334
diff changeset
169 -- 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
170 -- 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
171 -- 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
172 -- 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
173 -- 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
174 -- 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
175
12350
afe310107302 prosody.cfg.lua.dist: Add comments explaining the individual TURN options
Matthew Wild <mwild1@gmail.com>
parents: 12349
diff changeset
176 -- Specify the address of the TURN service (you may use the same domain as XMPP)
12335
abfe210adcc4 prosody.cfg.lua.dist: TURN configuration improvements and example
Matthew Wild <mwild1@gmail.com>
parents: 12334
diff changeset
177 --turn_external_host = "turn.example.com"
12350
afe310107302 prosody.cfg.lua.dist: Add comments explaining the individual TURN options
Matthew Wild <mwild1@gmail.com>
parents: 12349
diff changeset
178
afe310107302 prosody.cfg.lua.dist: Add comments explaining the individual TURN options
Matthew Wild <mwild1@gmail.com>
parents: 12349
diff changeset
179 -- This secret must be set to the same value in both Prosody and the TURN server
12335
abfe210adcc4 prosody.cfg.lua.dist: TURN configuration improvements and example
Matthew Wild <mwild1@gmail.com>
parents: 12334
diff changeset
180 --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
181
12338
677ea3cc9c84 prosody.cfg.lua.dist: Improve section-like layout via headers and spacing
Matthew Wild <mwild1@gmail.com>
parents: 12337
diff changeset
182
2984
3094166cfdd5 Merge 0.6 into 0.7.
Waqas Hussain <waqas20@gmail.com>
parents: 2931 2982
diff changeset
183 -- 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
184 -- 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
185 log = {
4090
111734f49a65 prosody.cfg.lua: Improve comment about enabling debug logging
Matthew Wild <mwild1@gmail.com>
parents: 4089
diff changeset
186 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
187 error = "prosody.err";
877262704c44 prosody.cfg.lua.dist: Update for new logging config format
Matthew Wild <mwild1@gmail.com>
parents: 3767
diff changeset
188 -- "*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
189 -- "*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
190 }
2984
3094166cfdd5 Merge 0.6 into 0.7.
Waqas Hussain <waqas20@gmail.com>
parents: 2931 2982
diff changeset
191
12338
677ea3cc9c84 prosody.cfg.lua.dist: Improve section-like layout via headers and spacing
Matthew Wild <mwild1@gmail.com>
parents: 12337
diff changeset
192
8258
503f424d4f07 prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents: 6345
diff changeset
193 -- 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
194 -- 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
195 -- statistics = "internal"
503f424d4f07 prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents: 6345
diff changeset
196
12338
677ea3cc9c84 prosody.cfg.lua.dist: Improve section-like layout via headers and spacing
Matthew Wild <mwild1@gmail.com>
parents: 12337
diff changeset
197
8260
17c630b243ce prosody.cfg.lua.dist: Further tweaks in preparation for 0.10.0
Matthew Wild <mwild1@gmail.com>
parents: 8258
diff changeset
198 -- Certificates
17c630b243ce prosody.cfg.lua.dist: Further tweaks in preparation for 0.10.0
Matthew Wild <mwild1@gmail.com>
parents: 8258
diff changeset
199 -- 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
200 -- 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
201 -- 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
202 -- 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
203 -- (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
204
8261
012208387396 prosody.cfg.lua.dist: Improve certificates comment
Matthew Wild <mwild1@gmail.com>
parents: 8260
diff changeset
205 -- 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
206 certificates = "certs"
17c630b243ce prosody.cfg.lua.dist: Further tweaks in preparation for 0.10.0
Matthew Wild <mwild1@gmail.com>
parents: 8258
diff changeset
207
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
208 ----------- 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
209 -- 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
210 -- 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
211
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
212 VirtualHost "localhost"
12321
398c5f5db934 prosody.cfg.lua.dist: Add note about 'localhost'
Kim Alvefur <zash@zash.se>
parents: 12277
diff changeset
213 -- 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
214 -- 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
215
2024
46a9c7c99476 prosody.cfg.lua.dist: Convert to unix line endings from DOS
Matthew Wild <mwild1@gmail.com>
parents: 1810
diff changeset
216
8260
17c630b243ce prosody.cfg.lua.dist: Further tweaks in preparation for 0.10.0
Matthew Wild <mwild1@gmail.com>
parents: 8258
diff changeset
217 --VirtualHost "example.com"
2024
46a9c7c99476 prosody.cfg.lua.dist: Convert to unix line endings from DOS
Matthew Wild <mwild1@gmail.com>
parents: 1810
diff changeset
218
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
219 ------ 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
220 -- 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
221 -- 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
222 -- 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
223
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
224 ---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
225 --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
226 --- 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
227 --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
228
12322
b1cb236c4478 prosody.cfg.lua.dist: Add new modules
Kim Alvefur <zash@zash.se>
parents: 12321
diff changeset
229 ---Set up a file sharing component
b1cb236c4478 prosody.cfg.lua.dist: Add new modules
Kim Alvefur <zash@zash.se>
parents: 12321
diff changeset
230 --Component "share.example.com" "http_file_share"
b1cb236c4478 prosody.cfg.lua.dist: Add new modules
Kim Alvefur <zash@zash.se>
parents: 12321
diff changeset
231
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
232 ---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
233 --
1e82c9b9db11 prosody.cfg.lua.dist: Add note about external gateways
Matthew Wild <mwild1@gmail.com>
parents: 3906
diff changeset
234 -- 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
235 -- 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
236 -- 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
237 --
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
238 --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
239 -- 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
240
7c5e6ad3d778 prosody.cfg.lua.dist: Warn about adding settings at the end of the file
Kim Alvefur <zash@zash.se>
parents: 11581
diff changeset
241
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 ---------- 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
243 -- 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
244 -- 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
245 --
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 -- 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
247 -- 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
248 -- 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
249 --
e921295e934c prosody.cfg.lua.dist: Link to website (thanks eta)
Kim Alvefur <zash@zash.se>
parents: 12276
diff changeset
250 -- For more information see https://prosody.im/doc/configure