Software /
code /
prosody
Annotate
prosody.cfg.lua.dist @ 11106:76f46c2579a2 0.11
net.websocket.frames: Allow all methods to work on non-string objects
Instead of using the string library, use methods from the passed object,
which are assumed to be equivalent.
This provides compatibility with objects from util.ringbuffer and
util.dbuffer, for example.
author | Matthew Wild <mwild1@gmail.com> |
---|---|
date | Thu, 17 Sep 2020 13:00:19 +0100 |
parent | 9637:b8301ba2c437 |
child | 10176:9178d18a4ed7 |
child | 11553:b0d8920ed5e5 |
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 |
2984 | 26 -- Enable use of libevent for better performance under high load |
8258
503f424d4f07
prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents:
6345
diff
changeset
|
27 -- For more information see: https://prosody.im/doc/libevent |
5624
187f734bc996
prosody.cfg.lua: Remove some more sneaky ';' characters from the config
Matthew Wild <mwild1@gmail.com>
parents:
5623
diff
changeset
|
28 --use_libevent = true |
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 "dialback"; -- s2s dialback support |
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
|
45 "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
|
46 |
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
|
47 -- 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
|
48 "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
|
49 "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
|
50 "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
|
51 "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
|
52 "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
|
53 "vcard_legacy"; -- Conversion between legacy vCard and PEP Avatar, vcard |
2984 | 54 |
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
|
55 -- Nice to have |
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
|
56 "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
|
57 "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
|
58 "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
|
59 "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
|
60 "register"; -- Allow users to register on this server using a client and change passwords |
8258
503f424d4f07
prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents:
6345
diff
changeset
|
61 --"mam"; -- Store messages in an archive and allow users to access it |
9590
6d4da1b4b6f4
prosody.cfg.lua.dist: Add mod_csi_simple
Kim Alvefur <zash@zash.se>
parents:
8285
diff
changeset
|
62 --"csi_simple"; -- Simple Mobile optimizations |
8258
503f424d4f07
prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents:
6345
diff
changeset
|
63 |
3767
3ba97d1d7a62
prosody.cfg.lua.dist: Update to reflect new mod_admin_* modules
Matthew Wild <mwild1@gmail.com>
parents:
3493
diff
changeset
|
64 -- Admin interfaces |
3ba97d1d7a62
prosody.cfg.lua.dist: Update to reflect new mod_admin_* modules
Matthew Wild <mwild1@gmail.com>
parents:
3493
diff
changeset
|
65 "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
|
66 --"admin_telnet"; -- Opens telnet console interface on localhost port 5582 |
8258
503f424d4f07
prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents:
6345
diff
changeset
|
67 |
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
|
68 -- 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
|
69 --"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
|
70 --"websocket"; -- XMPP over WebSockets |
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
|
71 --"http_files"; -- Serve static files from a directory over HTTP |
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
|
72 |
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
|
73 -- Other specific functionality |
8258
503f424d4f07
prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents:
6345
diff
changeset
|
74 --"limits"; -- Enable bandwidth limiting for XMPP connections |
2984 | 75 --"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
|
76 --"server_contact_info"; -- Publish contact information for this service |
2984 | 77 --"announce"; -- Send announcement to all online users |
78 --"welcome"; -- Welcome users who register accounts | |
79 --"watchregistrations"; -- Alert admins of registrations | |
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 |
4497
f42a0833c47c
prosody.cfg.lua.dist: Comment mod_legacyauth by default (thanks Zash)
Matthew Wild <mwild1@gmail.com>
parents:
4233
diff
changeset
|
81 --"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
|
82 --"proxy65"; -- Enables a file transfer proxy service which clients behind NAT can use |
5624
187f734bc996
prosody.cfg.lua: Remove some more sneaky ';' characters from the config
Matthew Wild <mwild1@gmail.com>
parents:
5623
diff
changeset
|
83 } |
2024
46a9c7c99476
prosody.cfg.lua.dist: Convert to unix line endings from DOS
Matthew Wild <mwild1@gmail.com>
parents:
1810
diff
changeset
|
84 |
5409
8e98a58ab6a3
prosody.cfg.lua.dist: Update with new options and comments
Matthew Wild <mwild1@gmail.com>
parents:
5293
diff
changeset
|
85 -- 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
|
86 -- 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
|
87 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
|
88 -- "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
|
89 -- "c2s"; -- Handle client connections |
8e98a58ab6a3
prosody.cfg.lua.dist: Update with new options and comments
Matthew Wild <mwild1@gmail.com>
parents:
5293
diff
changeset
|
90 -- "s2s"; -- Handle server-to-server connections |
6037
7bbe22d8dd09
prosody.cfg.lua.dist: mod_posix is enabled by default on posix platforms now
Kim Alvefur <zash@zash.se>
parents:
5806
diff
changeset
|
91 -- "posix"; -- POSIX functionality, sends server to background, enables syslog, etc. |
5623
5752391fa27d
prosody.cfg.lua.dist: Remove unnecessary ';' from default config (thanks Vincent)
Matthew Wild <mwild1@gmail.com>
parents:
5615
diff
changeset
|
92 } |
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
|
93 |
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
|
94 -- 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
|
95 -- 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
|
96 allow_registration = false |
3412
7c66519f4973
prosody.cfg.lua.dist: Fixed trailing whitespace.
Waqas Hussain <waqas20@gmail.com>
parents:
3273
diff
changeset
|
97 |
5409
8e98a58ab6a3
prosody.cfg.lua.dist: Update with new options and comments
Matthew Wild <mwild1@gmail.com>
parents:
5293
diff
changeset
|
98 -- Force clients to use encrypted connections? This option will |
8e98a58ab6a3
prosody.cfg.lua.dist: Update with new options and comments
Matthew Wild <mwild1@gmail.com>
parents:
5293
diff
changeset
|
99 -- prevent clients from authenticating unless they are using encryption. |
8e98a58ab6a3
prosody.cfg.lua.dist: Update with new options and comments
Matthew Wild <mwild1@gmail.com>
parents:
5293
diff
changeset
|
100 |
5806
c914f4322581
prosody.cfg.lua.dist: Set c2s_require_encryption = true
Matthew Wild <mwild1@gmail.com>
parents:
5624
diff
changeset
|
101 c2s_require_encryption = true |
5409
8e98a58ab6a3
prosody.cfg.lua.dist: Update with new options and comments
Matthew Wild <mwild1@gmail.com>
parents:
5293
diff
changeset
|
102 |
8258
503f424d4f07
prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents:
6345
diff
changeset
|
103 -- Force servers to use encrypted connections? This option will |
503f424d4f07
prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents:
6345
diff
changeset
|
104 -- prevent servers from authenticating unless they are using encryption. |
503f424d4f07
prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents:
6345
diff
changeset
|
105 |
503f424d4f07
prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents:
6345
diff
changeset
|
106 s2s_require_encryption = true |
503f424d4f07
prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents:
6345
diff
changeset
|
107 |
5409
8e98a58ab6a3
prosody.cfg.lua.dist: Update with new options and comments
Matthew Wild <mwild1@gmail.com>
parents:
5293
diff
changeset
|
108 -- Force certificate authentication for server-to-server connections? |
4086
c51737e6b445
prosody.cfg.lua.dist: Add note about the require_encryption options
Matthew Wild <mwild1@gmail.com>
parents:
4084
diff
changeset
|
109 |
5573
ca9f99f7dcbc
prosody.cfg.lua.dist: Fix my s2s_secure(_auth) mess
Matthew Wild <mwild1@gmail.com>
parents:
5409
diff
changeset
|
110 s2s_secure_auth = false |
5409
8e98a58ab6a3
prosody.cfg.lua.dist: Update with new options and comments
Matthew Wild <mwild1@gmail.com>
parents:
5293
diff
changeset
|
111 |
8258
503f424d4f07
prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents:
6345
diff
changeset
|
112 -- 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
|
113 -- 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
|
114 -- 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
|
115 -- 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
|
116 |
8258
503f424d4f07
prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents:
6345
diff
changeset
|
117 --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
|
118 |
9637
b8301ba2c437
prosody.cfg.lua.dist: Tidy up some comments
Matthew Wild <mwild1@gmail.com>
parents:
9636
diff
changeset
|
119 -- 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
|
120 -- 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
|
121 |
5573
ca9f99f7dcbc
prosody.cfg.lua.dist: Fix my s2s_secure(_auth) mess
Matthew Wild <mwild1@gmail.com>
parents:
5409
diff
changeset
|
122 --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
|
123 |
4233
3c644c3b10e2
prosody.cfg.lua.dist: Add example of 'authentication' option
Matthew Wild <mwild1@gmail.com>
parents:
4091
diff
changeset
|
124 -- 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
|
125 -- 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
|
126 |
8258
503f424d4f07
prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents:
6345
diff
changeset
|
127 authentication = "internal_hashed" |
4233
3c644c3b10e2
prosody.cfg.lua.dist: Add example of 'authentication' option
Matthew Wild <mwild1@gmail.com>
parents:
4091
diff
changeset
|
128 |
4087
e239504d8fff
prosody.cfg.lua.dist: Update to include storage configuration and examples for SQL
Matthew Wild <mwild1@gmail.com>
parents:
4086
diff
changeset
|
129 -- 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
|
130 -- 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
|
131 -- 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
|
132 -- 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
|
133 |
e239504d8fff
prosody.cfg.lua.dist: Update to include storage configuration and examples for SQL
Matthew Wild <mwild1@gmail.com>
parents:
4086
diff
changeset
|
134 --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
|
135 |
e239504d8fff
prosody.cfg.lua.dist: Update to include storage configuration and examples for SQL
Matthew Wild <mwild1@gmail.com>
parents:
4086
diff
changeset
|
136 -- 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
|
137 --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
|
138 --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
|
139 --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
|
140 |
8258
503f424d4f07
prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents:
6345
diff
changeset
|
141 |
503f424d4f07
prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents:
6345
diff
changeset
|
142 -- Archiving configuration |
503f424d4f07
prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents:
6345
diff
changeset
|
143 -- 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
|
144 -- 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
|
145 -- 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
|
146 -- 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
|
147 |
503f424d4f07
prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents:
6345
diff
changeset
|
148 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
|
149 |
503f424d4f07
prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents:
6345
diff
changeset
|
150 -- 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
|
151 -- 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
|
152 |
2984 | 153 -- 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
|
154 -- 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
|
155 log = { |
4090
111734f49a65
prosody.cfg.lua: Improve comment about enabling debug logging
Matthew Wild <mwild1@gmail.com>
parents:
4089
diff
changeset
|
156 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
|
157 error = "prosody.err"; |
877262704c44
prosody.cfg.lua.dist: Update for new logging config format
Matthew Wild <mwild1@gmail.com>
parents:
3767
diff
changeset
|
158 -- "*syslog"; -- Uncomment this for logging to syslog |
4091
c53610fdab62
prosody.cfg.lua: Give example for logging to console
Matthew Wild <mwild1@gmail.com>
parents:
4090
diff
changeset
|
159 -- "*console"; -- Log to the console, useful for debugging with daemonize=false |
3906
877262704c44
prosody.cfg.lua.dist: Update for new logging config format
Matthew Wild <mwild1@gmail.com>
parents:
3767
diff
changeset
|
160 } |
2984 | 161 |
8258
503f424d4f07
prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents:
6345
diff
changeset
|
162 -- 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
|
163 -- 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
|
164 -- statistics = "internal" |
503f424d4f07
prosody.cfg.lua.dist: Update in preparation for 0.10.0 release
Matthew Wild <mwild1@gmail.com>
parents:
6345
diff
changeset
|
165 |
8260
17c630b243ce
prosody.cfg.lua.dist: Further tweaks in preparation for 0.10.0
Matthew Wild <mwild1@gmail.com>
parents:
8258
diff
changeset
|
166 -- Certificates |
17c630b243ce
prosody.cfg.lua.dist: Further tweaks in preparation for 0.10.0
Matthew Wild <mwild1@gmail.com>
parents:
8258
diff
changeset
|
167 -- 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
|
168 -- 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
|
169 -- 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
|
170 -- 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
|
171 -- (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
|
172 |
8261
012208387396
prosody.cfg.lua.dist: Improve certificates comment
Matthew Wild <mwild1@gmail.com>
parents:
8260
diff
changeset
|
173 -- 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
|
174 certificates = "certs" |
17c630b243ce
prosody.cfg.lua.dist: Further tweaks in preparation for 0.10.0
Matthew Wild <mwild1@gmail.com>
parents:
8258
diff
changeset
|
175 |
9636
fa35724dbdba
prosody.cfg.lua.dist: Add https_certificate option
Matthew Wild <mwild1@gmail.com>
parents:
9593
diff
changeset
|
176 -- HTTPS currently only supports a single certificate, specify it here: |
fa35724dbdba
prosody.cfg.lua.dist: Add https_certificate option
Matthew Wild <mwild1@gmail.com>
parents:
9593
diff
changeset
|
177 --https_certificate = "certs/localhost.crt" |
fa35724dbdba
prosody.cfg.lua.dist: Add https_certificate option
Matthew Wild <mwild1@gmail.com>
parents:
9593
diff
changeset
|
178 |
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
|
179 ----------- 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
|
180 -- 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
|
181 -- 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
|
182 |
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
|
183 VirtualHost "localhost" |
2024
46a9c7c99476
prosody.cfg.lua.dist: Convert to unix line endings from DOS
Matthew Wild <mwild1@gmail.com>
parents:
1810
diff
changeset
|
184 |
8260
17c630b243ce
prosody.cfg.lua.dist: Further tweaks in preparation for 0.10.0
Matthew Wild <mwild1@gmail.com>
parents:
8258
diff
changeset
|
185 --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
|
186 -- 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
|
187 |
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
|
188 ------ 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
|
189 -- 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
|
190 -- 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
|
191 -- 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
|
192 |
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
|
193 ---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
|
194 --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
|
195 --- 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
|
196 --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
|
197 |
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
|
198 ---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
|
199 -- |
1e82c9b9db11
prosody.cfg.lua.dist: Add note about external gateways
Matthew Wild <mwild1@gmail.com>
parents:
3906
diff
changeset
|
200 -- External components allow adding various services, such as gateways/ |
1e82c9b9db11
prosody.cfg.lua.dist: Add note about external gateways
Matthew Wild <mwild1@gmail.com>
parents:
3906
diff
changeset
|
201 -- transports to other networks like ICQ, MSN and Yahoo. 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
|
202 -- 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
|
203 -- |
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
|
204 --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
|
205 -- component_secret = "password" |