Merge trunk/MattJ with trunk
[prosody.git] / prosody.cfg.lua.dist
1 -- Prosody Example Configuration File
2 -- 
3 -- Information on configuring Prosody can be found on our
4 -- website at http://prosody.im/doc/configure
5 -- 
6 -- Tip: You can check that the syntax of this file is correct
7 -- when you have finished by running: luac -p prosody.cfg.lua
8 -- If there are any errors, it will let you know what and where
9 -- they are, otherwise it will keep quiet.
10 --
11 -- The only thing left to do is rename this file to remove the .dist ending, and fill in the
12 -- blanks. Good luck, and happy Jabbering!
13
14
15 ---------- Server-wide settings ----------
16 -- Settings in this section apply to the whole server and are the default settings
17 -- for any virtual hosts
18
19 -- This is a (by default, empty) list of accounts that are admins
20 -- for the server. Note that you must create the accounts separately
21 -- (see http://prosody.im/doc/creating_accounts for info)
22 -- Example: admins = { "user1@example.com", "user2@example.net" }
23 admins = { }
24
25 -- Enable use of libevent for better performance under high load
26 -- For more information see: http://prosody.im/doc/libevent
27 --use_libevent = true;
28
29 -- This is the list of modules Prosody will load on startup.
30 -- It looks for mod_modulename.lua in the plugins folder, so make sure that exists too.
31 -- Documentation on modules can be found at: http://prosody.im/doc/modules
32 modules_enabled = {
33
34         -- Generally required
35                 "roster"; -- Allow users to have a roster. Recommended ;)
36                 "saslauth"; -- Authentication for clients and servers. Recommended if you want to log in.
37                 "tls"; -- Add support for secure TLS on c2s/s2s connections
38                 "dialback"; -- s2s dialback support
39                 "disco"; -- Service discovery
40
41         -- Not essential, but recommended
42                 "private"; -- Private XML storage (for room bookmarks, etc.)
43                 "vcard"; -- Allow users to set vCards
44                 --"privacy"; -- Support privacy lists
45                 --"compression"; -- Stream compression
46
47         -- Nice to have
48                 "legacyauth"; -- Legacy authentication. Only used by some old clients and bots.
49                 "version"; -- Replies to server version requests
50                 "uptime"; -- Report how long server has been running
51                 "time"; -- Let others know the time here on this server
52                 "ping"; -- Replies to XMPP pings with pongs
53                 "pep"; -- Enables users to publish their mood, activity, playing music and more
54                 "register"; -- Allow users to register on this server using a client and change passwords
55
56         -- Other specific functionality
57                 --"posix"; -- POSIX functionality, sends server to background, enables syslog, etc.
58                 --"console"; -- Opens admin telnet interface on localhost port 5582
59                 --"bosh"; -- Enable BOSH clients, aka "Jabber over HTTP"
60                 --"httpserver"; -- Serve static files from a directory over HTTP
61                 --"groups"; -- Shared roster support
62                 --"announce"; -- Send announcement to all online users
63                 --"welcome"; -- Welcome users who register accounts
64                 --"watchregistrations"; -- Alert admins of registrations
65 };
66
67 -- These modules are auto-loaded, should you
68 -- for (for some mad reason) want to disable
69 -- them then uncomment them below
70 modules_disabled = {
71         -- "presence";
72         -- "message";
73         -- "iq";
74         -- "defaultauth";
75 };
76
77 -- Disable account creation by default, for security
78 -- For more information see http://prosody.im/doc/creating_accounts
79 allow_registration = false;
80         
81 -- These are the SSL/TLS-related settings. If you don't want
82 -- to use SSL/TLS, you may comment or remove this
83 ssl = {
84         key = "certs/localhost.key";
85         certificate = "certs/localhost.cert";
86 }
87
88 -- Require encryption on client/server connections?
89 --c2s_require_encryption = false
90 --s2s_require_encryption = false
91
92 -- Logging configuration
93 -- For advanced logging see http://prosody.im/doc/logging
94 log = "prosody.log";
95 debug = false; -- Log debug messages?
96
97 ----------- Virtual hosts -----------
98 -- You need to add a VirtualHost entry for each domain you wish Prosody to serve.
99 -- Settings under each VirtualHost entry apply *only* to that host.
100
101 VirtualHost "localhost"
102
103 VirtualHost "example.com"
104         enabled = false -- Remove this line to enable this host
105
106         -- Assign this host a certificate for TLS, otherwise it would use the one
107         -- set in the global section (if any).
108         -- Note that old-style SSL on port 5223 only supports one certificate, and will always
109         -- use the global one.
110         ssl = { 
111                 key = "certs/example.com.key";
112                 certificate = "certs/example.com.crt";
113         }
114
115 ------ Components ------
116 -- You can specify components to add hosts that provide special services,
117 -- like multi-user conferences, and transports.
118 -- For more information on components, see http://prosody.im/doc/components
119
120 ---Set up a MUC (multi-user chat) room server on conference.example.com:
121 --Component "conference.example.com" "muc"
122
123 -- Set up a SOCKS5 bytestream proxy for server-proxied file transfers:
124 --Component "proxy.example.com" "proxy65"
125
126 ---Set up an external component (default component port is 5347)
127 --Component "gateway.example.com"
128 --      component_secret = "password"