1 -- Prosody Example Configuration File
3 -- Information on configuring Prosody can be found on our
4 -- website at http://prosody.im/doc/configure
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.
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!
15 ---------- Server-wide settings ----------
16 -- Settings in this section apply to the whole server and are the default settings
17 -- for any virtual hosts
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" }
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;
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
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
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
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 "adhoc"; -- Support for "ad-hoc commands" that can be executed with an XMPP client
58 "admin_adhoc"; -- Allows administration via an XMPP client that supports ad-hoc commands
59 --"admin_telnet"; -- Opens telnet console interface on localhost port 5582
61 -- Other specific functionality
62 --"posix"; -- POSIX functionality, sends server to background, enables syslog, etc.
63 --"bosh"; -- Enable BOSH clients, aka "Jabber over HTTP"
64 --"httpserver"; -- Serve static files from a directory over HTTP
65 --"groups"; -- Shared roster support
66 --"announce"; -- Send announcement to all online users
67 --"welcome"; -- Welcome users who register accounts
68 --"watchregistrations"; -- Alert admins of registrations
71 -- These modules are auto-loaded, should you
72 -- (for some mad reason) want to disable
73 -- them then uncomment them below
80 -- Disable account creation by default, for security
81 -- For more information see http://prosody.im/doc/creating_accounts
82 allow_registration = false;
84 -- These are the SSL/TLS-related settings. If you don't want
85 -- to use SSL/TLS, you may comment or remove this
87 key = "certs/localhost.key";
88 certificate = "certs/localhost.cert";
91 -- Require encryption on client/server connections?
92 --c2s_require_encryption = false
93 --s2s_require_encryption = false
95 -- Logging configuration
96 -- For advanced logging see http://prosody.im/doc/logging
98 info = "prosody.log"; -- Change info to debug for verbose logging
99 error = "prosody.err";
100 -- "*syslog"; -- Uncomment this for logging to syslog
103 ----------- Virtual hosts -----------
104 -- You need to add a VirtualHost entry for each domain you wish Prosody to serve.
105 -- Settings under each VirtualHost entry apply *only* to that host.
107 VirtualHost "localhost"
109 VirtualHost "example.com"
110 enabled = false -- Remove this line to enable this host
112 -- Assign this host a certificate for TLS, otherwise it would use the one
113 -- set in the global section (if any).
114 -- Note that old-style SSL on port 5223 only supports one certificate, and will always
115 -- use the global one.
117 key = "certs/example.com.key";
118 certificate = "certs/example.com.crt";
121 ------ Components ------
122 -- You can specify components to add hosts that provide special services,
123 -- like multi-user conferences, and transports.
124 -- For more information on components, see http://prosody.im/doc/components
126 ---Set up a MUC (multi-user chat) room server on conference.example.com:
127 --Component "conference.example.com" "muc"
129 -- Set up a SOCKS5 bytestream proxy for server-proxied file transfers:
130 --Component "proxy.example.com" "proxy65"
132 ---Set up an external component (default component port is 5347)
134 -- External components allow adding various services, such as gateways/
135 -- transports to other networks like ICQ, MSN and Yahoo. For more info
136 -- see: http://prosody.im/doc/components#adding_an_external_component
138 --Component "gateway.example.com"
139 -- component_secret = "password"