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 "version"; -- Replies to server version requests
49 "uptime"; -- Report how long server has been running
50 "time"; -- Let others know the time here on this server
51 "ping"; -- Replies to XMPP pings with pongs
52 "pep"; -- Enables users to publish their mood, activity, playing music and more
53 "register"; -- Allow users to register on this server using a client and change passwords
54 "adhoc"; -- Support for "ad-hoc commands" that can be executed with an XMPP client
57 "admin_adhoc"; -- Allows administration via an XMPP client that supports ad-hoc commands
58 --"admin_telnet"; -- Opens telnet console interface on localhost port 5582
61 --"bosh"; -- Enable BOSH clients, aka "Jabber over HTTP"
62 --"http_files"; -- Serve static files from a directory over HTTP
64 -- Other specific functionality
65 --"posix"; -- POSIX functionality, sends server to background, enables syslog, etc.
66 --"groups"; -- Shared roster support
67 --"announce"; -- Send announcement to all online users
68 --"welcome"; -- Welcome users who register accounts
69 --"watchregistrations"; -- Alert admins of registrations
70 --"motd"; -- Send a message to users when they log in
71 --"legacyauth"; -- Legacy authentication. Only used by some old clients and bots.
74 -- These modules are auto-loaded, should you
75 -- (for some mad reason) want to disable
76 -- them then uncomment them below
78 -- "presence"; -- Route user/contact status information
79 -- "message"; -- Route messages
80 -- "iq"; -- Route info queries
81 -- "offline"; -- Store offline messages
84 -- Disable account creation by default, for security
85 -- For more information see http://prosody.im/doc/creating_accounts
86 allow_registration = false;
88 -- These are the SSL/TLS-related settings. If you don't want
89 -- to use SSL/TLS, you may comment or remove this
91 key = "certs/localhost.key";
92 certificate = "certs/localhost.cert";
95 -- Only allow encrypted streams? Encryption is already used when
96 -- available. These options will cause Prosody to deny connections that
97 -- are not encrypted. Note that some servers do not support s2s
98 -- encryption or have it disabled, including gmail.com and Google Apps
101 --c2s_require_encryption = false
102 --s2s_require_encryption = false
104 -- Select the authentication backend to use. The 'internal' providers
105 -- use Prosody's configured data storage to store the authentication data.
106 -- To allow Prosody to offer secure authentication mechanisms to clients, the
107 -- default provider stores passwords in plaintext. If you do not trust your
108 -- server please see http://prosody.im/doc/modules/mod_auth_internal_hashed
109 -- for information about using the hashed backend.
111 authentication = "internal_plain"
113 -- Select the storage backend to use. By default Prosody uses flat files
114 -- in its configured data directory, but it also supports more backends
115 -- through modules. An "sql" backend is included by default, but requires
116 -- additional dependencies. See http://prosody.im/doc/storage for more info.
118 --storage = "sql" -- Default is "internal"
120 -- For the "sql" backend, you can uncomment *one* of the below to configure:
121 --sql = { driver = "SQLite3", database = "prosody.sqlite" } -- Default. 'database' is the filename.
122 --sql = { driver = "MySQL", database = "prosody", username = "prosody", password = "secret", host = "localhost" }
123 --sql = { driver = "PostgreSQL", database = "prosody", username = "prosody", password = "secret", host = "localhost" }
125 -- Logging configuration
126 -- For advanced logging see http://prosody.im/doc/logging
128 info = "prosody.log"; -- Change 'info' to 'debug' for verbose logging
129 error = "prosody.err";
130 -- "*syslog"; -- Uncomment this for logging to syslog
131 -- "*console"; -- Log to the console, useful for debugging with daemonize=false
134 ----------- Virtual hosts -----------
135 -- You need to add a VirtualHost entry for each domain you wish Prosody to serve.
136 -- Settings under each VirtualHost entry apply *only* to that host.
138 VirtualHost "localhost"
140 VirtualHost "example.com"
141 enabled = false -- Remove this line to enable this host
143 -- Assign this host a certificate for TLS, otherwise it would use the one
144 -- set in the global section (if any).
145 -- Note that old-style SSL on port 5223 only supports one certificate, and will always
146 -- use the global one.
148 key = "certs/example.com.key";
149 certificate = "certs/example.com.crt";
152 ------ Components ------
153 -- You can specify components to add hosts that provide special services,
154 -- like multi-user conferences, and transports.
155 -- For more information on components, see http://prosody.im/doc/components
157 ---Set up a MUC (multi-user chat) room server on conference.example.com:
158 --Component "conference.example.com" "muc"
160 -- Set up a SOCKS5 bytestream proxy for server-proxied file transfers:
161 --Component "proxy.example.com" "proxy65"
163 ---Set up an external component (default component port is 5347)
165 -- External components allow adding various services, such as gateways/
166 -- transports to other networks like ICQ, MSN and Yahoo. For more info
167 -- see: http://prosody.im/doc/components#adding_an_external_component
169 --Component "gateway.example.com"
170 -- component_secret = "password"