prosody
d5a1fd78a06a
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 @ 1834:d5a1fd78a06a

Merge with waqas
author Matthew Wild <mwild1@gmail.com>
date Sun, 27 Sep 2009 12:10:36 +0100
parent 1810:7c45ae42923a
child 2024:46a9c7c99476
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
522
fc3df507afa2 Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents: 479
diff changeset
1 -- Prosody Example Configuration File
fc3df507afa2 Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents: 479
diff changeset
2 --
fc3df507afa2 Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents: 479
diff changeset
3 -- If it wasn't already obvious, -- starts a comment, and all
911
39133bca5938 prosody.cfg.lua.dist: Remove some factual inaccuracies
Matthew Wild <mwild1@gmail.com>
parents: 525
diff changeset
4 -- text after it on a line is ignored by Prosody.
522
fc3df507afa2 Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents: 479
diff changeset
5 --
fc3df507afa2 Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents: 479
diff changeset
6 -- The config is split into sections, a global section, and one
fc3df507afa2 Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents: 479
diff changeset
7 -- for each defined host that we serve. You can add as many host
fc3df507afa2 Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents: 479
diff changeset
8 -- sections as you like.
fc3df507afa2 Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents: 479
diff changeset
9 --
fc3df507afa2 Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents: 479
diff changeset
10 -- Lists are written { "like", "this", "one" }
1527
47729fa90a6c prosody.cfg.lua: Various small changes
Matthew Wild <mwild1@gmail.com>
parents: 1526
diff changeset
11 -- Lists can also be of { 1, 2, 3 } numbers, and other things.
522
fc3df507afa2 Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents: 479
diff changeset
12 -- Either commas, or semi-colons; may be used
fc3df507afa2 Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents: 479
diff changeset
13 -- as seperators.
fc3df507afa2 Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents: 479
diff changeset
14 --
fc3df507afa2 Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents: 479
diff changeset
15 -- A table is a list of values, except each value has a name. An
1527
47729fa90a6c prosody.cfg.lua: Various small changes
Matthew Wild <mwild1@gmail.com>
parents: 1526
diff changeset
16 -- example table would be:
522
fc3df507afa2 Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents: 479
diff changeset
17 --
1176
2be14b7021b2 prosody.cfg.lua.dist: Update example to a better one
Matthew Wild <mwild1@gmail.com>
parents: 1132
diff changeset
18 -- ssl = { key = "keyfile.key", certificate = "certificate.cert" }
522
fc3df507afa2 Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents: 479
diff changeset
19 --
911
39133bca5938 prosody.cfg.lua.dist: Remove some factual inaccuracies
Matthew Wild <mwild1@gmail.com>
parents: 525
diff changeset
20 -- Whitespace (that is tabs, spaces, line breaks) is mostly insignificant, so
39133bca5938 prosody.cfg.lua.dist: Remove some factual inaccuracies
Matthew Wild <mwild1@gmail.com>
parents: 525
diff changeset
21 -- can
1527
47729fa90a6c prosody.cfg.lua: Various small changes
Matthew Wild <mwild1@gmail.com>
parents: 1526
diff changeset
22 -- be placed anywhere that you deem fitting.
522
fc3df507afa2 Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents: 479
diff changeset
23 --
fc3df507afa2 Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents: 479
diff changeset
24 -- Tip: You can check that the syntax of this file is correct when you have finished
fc3df507afa2 Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents: 479
diff changeset
25 -- by running: luac -p prosody.cfg.lua
fc3df507afa2 Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents: 479
diff changeset
26 -- If there are any errors, it will let you know what and where they are, otherwise it
fc3df507afa2 Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents: 479
diff changeset
27 -- will keep quiet.
fc3df507afa2 Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents: 479
diff changeset
28 --
fc3df507afa2 Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents: 479
diff changeset
29 -- The only thing left to do is rename this file to remove the .dist ending, and fill in the
fc3df507afa2 Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents: 479
diff changeset
30 -- blanks. Good luck, and happy Jabbering!
fc3df507afa2 Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents: 479
diff changeset
31
1527
47729fa90a6c prosody.cfg.lua: Various small changes
Matthew Wild <mwild1@gmail.com>
parents: 1526
diff changeset
32 -- Server-wide settings go in this section
522
fc3df507afa2 Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents: 479
diff changeset
33 Host "*"
fc3df507afa2 Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents: 479
diff changeset
34
1810
7c45ae42923a prosody.cfg.lua.dist: Add example of declaring admins for a server
Matthew Wild <mwild1@gmail.com>
parents: 1548
diff changeset
35 -- This is a (by default, empty) list of accounts that are admins
7c45ae42923a prosody.cfg.lua.dist: Add example of declaring admins for a server
Matthew Wild <mwild1@gmail.com>
parents: 1548
diff changeset
36 -- for the server. Note that you must create the accounts separately
7c45ae42923a prosody.cfg.lua.dist: Add example of declaring admins for a server
Matthew Wild <mwild1@gmail.com>
parents: 1548
diff changeset
37 -- (see http://prosody.im/doc/creating_accounts for info)
7c45ae42923a prosody.cfg.lua.dist: Add example of declaring admins for a server
Matthew Wild <mwild1@gmail.com>
parents: 1548
diff changeset
38 -- Example: admins = { "user1@example.com", "user2@example.net" }
7c45ae42923a prosody.cfg.lua.dist: Add example of declaring admins for a server
Matthew Wild <mwild1@gmail.com>
parents: 1548
diff changeset
39 admins = { }
7c45ae42923a prosody.cfg.lua.dist: Add example of declaring admins for a server
Matthew Wild <mwild1@gmail.com>
parents: 1548
diff changeset
40
522
fc3df507afa2 Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents: 479
diff changeset
41 -- This is the list of modules Prosody will load on startup.
fc3df507afa2 Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents: 479
diff changeset
42 -- It looks for mod_modulename.lua in the plugins folder, so make sure that exists too.
fc3df507afa2 Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents: 479
diff changeset
43 modules_enabled = {
912
62dd71870ee3 Update example config, categorise modules, add new modules
Matthew Wild <mwild1@gmail.com>
parents: 911
diff changeset
44 -- Generally required
522
fc3df507afa2 Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents: 479
diff changeset
45 "roster"; -- Allow users to have a roster. Recommended ;)
912
62dd71870ee3 Update example config, categorise modules, add new modules
Matthew Wild <mwild1@gmail.com>
parents: 911
diff changeset
46 "saslauth"; -- Authentication for clients and servers. Recommended if you want to log in.
522
fc3df507afa2 Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents: 479
diff changeset
47 "tls"; -- Add support for secure TLS on c2s/s2s connections
fc3df507afa2 Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents: 479
diff changeset
48 "dialback"; -- s2s dialback support
fc3df507afa2 Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents: 479
diff changeset
49 "disco"; -- Service discovery
912
62dd71870ee3 Update example config, categorise modules, add new modules
Matthew Wild <mwild1@gmail.com>
parents: 911
diff changeset
50
62dd71870ee3 Update example config, categorise modules, add new modules
Matthew Wild <mwild1@gmail.com>
parents: 911
diff changeset
51 -- Not essential, but recommended
62dd71870ee3 Update example config, categorise modules, add new modules
Matthew Wild <mwild1@gmail.com>
parents: 911
diff changeset
52 "private"; -- Private XML storage (for room bookmarks, etc.)
62dd71870ee3 Update example config, categorise modules, add new modules
Matthew Wild <mwild1@gmail.com>
parents: 911
diff changeset
53 "vcard"; -- Allow users to set vCards
62dd71870ee3 Update example config, categorise modules, add new modules
Matthew Wild <mwild1@gmail.com>
parents: 911
diff changeset
54
62dd71870ee3 Update example config, categorise modules, add new modules
Matthew Wild <mwild1@gmail.com>
parents: 911
diff changeset
55 -- Nice to have
62dd71870ee3 Update example config, categorise modules, add new modules
Matthew Wild <mwild1@gmail.com>
parents: 911
diff changeset
56 "legacyauth"; -- Legacy authentication. Only used by some old clients and bots.
62dd71870ee3 Update example config, categorise modules, add new modules
Matthew Wild <mwild1@gmail.com>
parents: 911
diff changeset
57 "version"; -- Replies to server version requests
62dd71870ee3 Update example config, categorise modules, add new modules
Matthew Wild <mwild1@gmail.com>
parents: 911
diff changeset
58 "uptime"; -- Report how long server has been running
62dd71870ee3 Update example config, categorise modules, add new modules
Matthew Wild <mwild1@gmail.com>
parents: 911
diff changeset
59 "time"; -- Let others know the time here on this server
62dd71870ee3 Update example config, categorise modules, add new modules
Matthew Wild <mwild1@gmail.com>
parents: 911
diff changeset
60 "ping"; -- Replies to XMPP pings with pongs
1548
b88b30c9e688 prosody.cfg.lua.dist: Add mod_pep to the default config file
Matthew Wild <mwild1@gmail.com>
parents: 1527
diff changeset
61 "pep"; -- Enables users to publish their mood, activity, playing music and more
1291
22dcd5f06bc4 prosody.cfg.lua.dist: Enable mod_register by default, but with registration disabled, and add a comment about it
Matthew Wild <mwild1@gmail.com>
parents: 1176
diff changeset
62 "register"; -- Allow users to register on this server using a client and change passwords
912
62dd71870ee3 Update example config, categorise modules, add new modules
Matthew Wild <mwild1@gmail.com>
parents: 911
diff changeset
63
62dd71870ee3 Update example config, categorise modules, add new modules
Matthew Wild <mwild1@gmail.com>
parents: 911
diff changeset
64 -- Other specific functionality
62dd71870ee3 Update example config, categorise modules, add new modules
Matthew Wild <mwild1@gmail.com>
parents: 911
diff changeset
65 --"posix"; -- POSIX functionality, sends server to background, enables syslog, etc.
62dd71870ee3 Update example config, categorise modules, add new modules
Matthew Wild <mwild1@gmail.com>
parents: 911
diff changeset
66 --"console"; -- telnet to port 5582 (needs console_enabled = true)
62dd71870ee3 Update example config, categorise modules, add new modules
Matthew Wild <mwild1@gmail.com>
parents: 911
diff changeset
67 --"bosh"; -- Enable BOSH clients, aka "Jabber over HTTP"
62dd71870ee3 Update example config, categorise modules, add new modules
Matthew Wild <mwild1@gmail.com>
parents: 911
diff changeset
68 --"httpserver"; -- Serve static files from a directory over HTTP
522
fc3df507afa2 Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents: 479
diff changeset
69 };
fc3df507afa2 Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents: 479
diff changeset
70
1525
f30886f684eb prosody.cfg.lua.dist: Add auto-loaded modules to the config
Matthew Wild <mwild1@gmail.com>
parents: 1446
diff changeset
71 -- These modules are auto-loaded, should you
f30886f684eb prosody.cfg.lua.dist: Add auto-loaded modules to the config
Matthew Wild <mwild1@gmail.com>
parents: 1446
diff changeset
72 -- for (for some mad reason) want to disable
f30886f684eb prosody.cfg.lua.dist: Add auto-loaded modules to the config
Matthew Wild <mwild1@gmail.com>
parents: 1446
diff changeset
73 -- them then uncomment them below
f30886f684eb prosody.cfg.lua.dist: Add auto-loaded modules to the config
Matthew Wild <mwild1@gmail.com>
parents: 1446
diff changeset
74 modules_disabled = {
f30886f684eb prosody.cfg.lua.dist: Add auto-loaded modules to the config
Matthew Wild <mwild1@gmail.com>
parents: 1446
diff changeset
75 -- "presence";
f30886f684eb prosody.cfg.lua.dist: Add auto-loaded modules to the config
Matthew Wild <mwild1@gmail.com>
parents: 1446
diff changeset
76 -- "message";
f30886f684eb prosody.cfg.lua.dist: Add auto-loaded modules to the config
Matthew Wild <mwild1@gmail.com>
parents: 1446
diff changeset
77 -- "iq";
f30886f684eb prosody.cfg.lua.dist: Add auto-loaded modules to the config
Matthew Wild <mwild1@gmail.com>
parents: 1446
diff changeset
78 };
f30886f684eb prosody.cfg.lua.dist: Add auto-loaded modules to the config
Matthew Wild <mwild1@gmail.com>
parents: 1446
diff changeset
79
1291
22dcd5f06bc4 prosody.cfg.lua.dist: Enable mod_register by default, but with registration disabled, and add a comment about it
Matthew Wild <mwild1@gmail.com>
parents: 1176
diff changeset
80 -- Disable account creation by default, for security
22dcd5f06bc4 prosody.cfg.lua.dist: Enable mod_register by default, but with registration disabled, and add a comment about it
Matthew Wild <mwild1@gmail.com>
parents: 1176
diff changeset
81 -- For more information see http://prosody.im/doc/creating_accounts
22dcd5f06bc4 prosody.cfg.lua.dist: Enable mod_register by default, but with registration disabled, and add a comment about it
Matthew Wild <mwild1@gmail.com>
parents: 1176
diff changeset
82 allow_registration = false;
22dcd5f06bc4 prosody.cfg.lua.dist: Enable mod_register by default, but with registration disabled, and add a comment about it
Matthew Wild <mwild1@gmail.com>
parents: 1176
diff changeset
83
522
fc3df507afa2 Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents: 479
diff changeset
84 -- These are the SSL/TLS-related settings. If you don't want
fc3df507afa2 Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents: 479
diff changeset
85 -- to use SSL/TLS, you may comment or remove this
fc3df507afa2 Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents: 479
diff changeset
86 ssl = {
fc3df507afa2 Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents: 479
diff changeset
87 key = "certs/localhost.key";
fc3df507afa2 Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents: 479
diff changeset
88 certificate = "certs/localhost.cert";
fc3df507afa2 Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents: 479
diff changeset
89 }
fc3df507afa2 Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents: 479
diff changeset
90
fc3df507afa2 Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents: 479
diff changeset
91 -- This allows clients to connect to localhost. No harm in it.
fc3df507afa2 Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents: 479
diff changeset
92 Host "localhost"
fc3df507afa2 Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents: 479
diff changeset
93
fc3df507afa2 Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents: 479
diff changeset
94 -- Section for example.com
fc3df507afa2 Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents: 479
diff changeset
95 -- (replace example.com with your domain name)
fc3df507afa2 Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents: 479
diff changeset
96 Host "example.com"
1526
5f11a8d07161 prosody.cfg.lua.dist: Move enabled line higher up (people including myself often miss it)
Matthew Wild <mwild1@gmail.com>
parents: 1525
diff changeset
97
5f11a8d07161 prosody.cfg.lua.dist: Move enabled line higher up (people including myself often miss it)
Matthew Wild <mwild1@gmail.com>
parents: 1525
diff changeset
98 enabled = false -- This will disable the host, preserving the config, but denying connections
5f11a8d07161 prosody.cfg.lua.dist: Move enabled line higher up (people including myself often miss it)
Matthew Wild <mwild1@gmail.com>
parents: 1525
diff changeset
99
522
fc3df507afa2 Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents: 479
diff changeset
100 -- Assign this host a certificate for TLS, otherwise it would use the one
fc3df507afa2 Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents: 479
diff changeset
101 -- set in the global section (if any).
fc3df507afa2 Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents: 479
diff changeset
102 -- Note that old-style SSL on port 5223 only supports one certificate, and will always
fc3df507afa2 Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents: 479
diff changeset
103 -- use the global one.
fc3df507afa2 Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents: 479
diff changeset
104 ssl = {
fc3df507afa2 Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents: 479
diff changeset
105 key = "certs/example.com.key";
fc3df507afa2 Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents: 479
diff changeset
106 certificate = "certs/example.com.crt";
fc3df507afa2 Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents: 479
diff changeset
107 }
fc3df507afa2 Converted prosody.cfg.lua.dist to use windows end-of-lines
Waqas Hussain <waqas20@gmail.com>
parents: 479
diff changeset
108
912
62dd71870ee3 Update example config, categorise modules, add new modules
Matthew Wild <mwild1@gmail.com>
parents: 911
diff changeset
109 -- Set up a MUC (multi-user chat) room server on conference.example.com:
62dd71870ee3 Update example config, categorise modules, add new modules
Matthew Wild <mwild1@gmail.com>
parents: 911
diff changeset
110 Component "conference.example.com" "muc"