Automated merge with http://waqas.ath.cx/
[prosody.git] / prosody.cfg.lua.dist
1 -- Prosody Example Configuration File 
2 -- 
3 -- If it wasn't already obvious, -- starts a comment, and all 
4 -- text after it is ignored by Prosody.
5 --
6 -- The config is split into sections, a global section, and one 
7 -- for each defined host that we serve. You can add as many host 
8 -- sections as you like.
9 --
10 -- Lists are written { "like", "this", "one" } 
11 -- Lists can also be of { 1, 2, 3 } numbers, etc. 
12 -- Either commas, or semi-colons; may be used
13 -- as seperators.
14 --
15 -- A table is a list of values, except each value has a name. An 
16 -- example would be:
17 --
18 -- logging = { type = "html", directory = "/var/logs", rotate = "daily" }
19 --
20 -- Whitespace (that is tabs, spaces, line breaks) is insignificant, so can 
21 -- be placed anywhere
22 -- that         you deem fitting. Youcouldalsoremoveitentirely,butforobviousrea
23 --sonsIdon'trecommendit.
24 --
25 -- Tip: You can check that the syntax of this file is correct when you have finished
26 -- by running: luac -p prosody.cfg.lua
27 -- If there are any errors, it will let you know what and where they are, otherwise it 
28 -- will keep quiet.
29 --
30 -- The only thing left to do is rename this file to remove the .dist ending, and fill in the 
31 -- blanks. Good luck, and happy Jabbering!
32
33 -- Global settings go in this section
34 Host "*"
35         
36         -- This is the list of modules Prosody will load on startup.
37         -- It looks for mod_modulename.lua in the plugins folder, so make sure that exists too.
38         modules_enabled = {
39                                 "saslauth"; -- Authentication for clients and servers. Recommended if you want to log in.
40                                 "legacyauth"; -- Legacy authentication. Only used by some old clients and bots.
41                                 "roster"; -- Allow users to have a roster. Recommended ;)
42                                 "register"; -- Allow users to register on this server using a client
43                                 "tls"; -- Add support for secure TLS on c2s/s2s connections
44                                 "vcard"; -- Allow users to set vCards
45                                 "private"; -- Private XML storage (for room bookmarks, etc.)
46                                 "version"; -- Replies to server version requests
47                                 "dialback"; -- s2s dialback support
48                                 "disco"; -- Service discovery
49                                 "ping"; -- XMPP Ping
50                                 "time"; -- Let others know the time here
51                                 "uptime"; -- Uptime reporting
52                                 "console"; -- telnet to port 5528 (needs console_enabled = true)
53                           };
54         
55         -- These are the SSL/TLS-related settings. If you don't want
56         -- to use SSL/TLS, you may comment or remove this
57         ssl = { 
58                 key = "certs/localhost.key";
59                 certificate = "certs/localhost.cert";
60                 }
61
62 -- This allows clients to connect to localhost. No harm in it.
63 Host "localhost"
64
65 -- Section for example.com
66 -- (replace example.com with your domain name)
67 Host "example.com"
68         -- Assign this host a certificate for TLS, otherwise it would use the one
69         -- set in the global section (if any).
70         -- Note that old-style SSL on port 5223 only supports one certificate, and will always
71         -- use the global one.
72         ssl = { 
73                 key = "certs/example.com.key";
74                 certificate = "certs/example.com.crt";
75                 }
76
77         enabled = false -- This will disable the host, preserving the config, but denying connections
78