· 8 years ago · Feb 07, 2018, 03:32 PM
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" }
23admins = { }
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
32modules_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
45 -- These are commented by default as they have a performance impact
46 --"privacy"; -- Support privacy lists
47 --"compression"; -- Stream compression (Debian: requires lua-zlib module to work)
48
49 -- Nice to have
50 "version"; -- Replies to server version requests
51 "uptime"; -- Report how long server has been running
52 "time"; -- Let others know the time here on this server
53 "ping"; -- Replies to XMPP pings with pongs
54 "pep"; -- Enables users to publish their mood, activity, playing music and more
55 "register"; -- Allow users to register on this server using a client and change passwords
56
57 -- Admin interfaces
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
60
61 -- HTTP modules
62 --"bosh"; -- Enable BOSH clients, aka "Jabber over HTTP"
63 --"http_files"; -- Serve static files from a directory over HTTP
64
65 -- Other specific functionality
66 "posix"; -- POSIX functionality, sends server to background, enables syslog, etc.
67 --"groups"; -- Shared roster support
68 --"announce"; -- Send announcement to all online users
69 --"welcome"; -- Welcome users who register accounts
70 --"watchregistrations"; -- Alert admins of registrations
71 --"motd"; -- Send a message to users when they log in
72 --"legacyauth"; -- Legacy authentication. Only used by some old clients and bots.
73};
74
75-- These modules are auto-loaded, but should you want
76-- to disable them then uncomment them here:
77modules_disabled = {
78 -- "offline"; -- Store offline messages
79 -- "c2s"; -- Handle client connections
80 -- "s2s"; -- Handle server-to-server connections
81};
82
83-- Disable account creation by default, for security
84-- For more information see http://prosody.im/doc/creating_accounts
85allow_registration = true;
86
87-- Debian:
88-- send the server to background.
89--
90daemonize = true;
91
92-- Debian:
93-- Please, don't change this option since /var/run/prosody/
94-- is one of the few directories Prosody is allowed to write to
95--
96pidfile = "/var/run/prosody/prosody.pid";
97
98-- These are the SSL/TLS-related settings. If you don't want
99-- to use SSL/TLS, you may comment or remove this
100ssl = {
101 key = "/etc/prosody/certs/localhost.key";
102 certificate = "/etc/prosody/certs/localhost.crt";
103}
104
105-- Force clients to use encrypted connections? This option will
106-- prevent clients from authenticating unless they are using encryption.
107
108c2s_require_encryption = true
109
110-- Force certificate authentication for server-to-server connections?
111-- This provides ideal security, but requires servers you communicate
112-- with to support encryption AND present valid, trusted certificates.
113-- NOTE: Your version of LuaSec must support certificate verification!
114-- For more information see http://prosody.im/doc/s2s#security
115
116s2s_secure_auth = false
117
118-- Many servers don't support encryption or have invalid or self-signed
119-- certificates. You can list domains here that will not be required to
120-- authenticate using certificates. They will be authenticated using DNS.
121
122--s2s_insecure_domains = { "gmail.com" }
123
124-- Even if you leave s2s_secure_auth disabled, you can still require valid
125-- certificates for some domains by specifying a list here.
126
127--s2s_secure_domains = { "jabber.org" }
128
129-- Select the authentication backend to use. The 'internal' providers
130-- use Prosody's configured data storage to store the authentication data.
131-- To allow Prosody to offer secure authentication mechanisms to clients, the
132-- default provider stores passwords in plaintext. If you do not trust your
133-- server please see http://prosody.im/doc/modules/mod_auth_internal_hashed
134-- for information about using the hashed backend.
135
136authentication = "anonymous"
137
138-- Select the storage backend to use. By default Prosody uses flat files
139-- in its configured data directory, but it also supports more backends
140-- through modules. An "sql" backend is included by default, but requires
141-- additional dependencies. See http://prosody.im/doc/storage for more info.
142
143--storage = "sql" -- Default is "internal" (Debian: "sql" requires one of the
144-- lua-dbi-sqlite3, lua-dbi-mysql or lua-dbi-postgresql packages to work)
145
146-- For the "sql" backend, you can uncomment *one* of the below to configure:
147--sql = { driver = "SQLite3", database = "prosody.sqlite" } -- Default. 'database' is the filename.
148--sql = { driver = "MySQL", database = "prosody", username = "prosody", password = "secret", host = "localhost" }
149--sql = { driver = "PostgreSQL", database = "prosody", username = "prosody", password = "secret", host = "localhost" }
150
151-- Logging configuration
152-- For advanced logging see http://prosody.im/doc/logging
153--
154-- Debian:
155-- Logs info and higher to /var/log
156-- Logs errors to syslog also
157log = {
158 -- Log files (change 'info' to 'debug' for debug logs):
159 info = "/var/log/prosody/prosody.log";
160 error = "/var/log/prosody/prosody.err";
161 -- Syslog:
162 { levels = { "error" }; to = "syslog"; };
163}
164
165----------- Virtual hosts -----------
166-- You need to add a VirtualHost entry for each domain you wish Prosody to serve.
167-- Settings under each VirtualHost entry apply *only* to that host.
168
169VirtualHost "netlabwork.net"
170 enabled = true -- Remove this line to enable this host
171
172 -- Assign this host a certificate for TLS, otherwise it would use the one
173 -- set in the global section (if any).
174 -- Note that old-style SSL on port 5223 only supports one certificate, and will always
175 -- use the global one.
176 ssl = {
177 key = "/etc/prosody/certs/example.com.key";
178 certificate = "/etc/prosody/certs/example.com.crt";
179 }
180
181------ Components ------
182-- You can specify components to add hosts that provide special services,
183-- like multi-user conferences, and transports.
184-- For more information on components, see http://prosody.im/doc/components
185
186---Set up a MUC (multi-user chat) room server on conference.example.com:
187--Component "conference.example.com" "muc"
188
189-- Set up a SOCKS5 bytestream proxy for server-proxied file transfers:
190--Component "proxy.example.com" "proxy65"
191
192---Set up an external component (default component port is 5347)
193--
194-- External components allow adding various services, such as gateways/
195-- transports to other networks like ICQ, MSN and Yahoo. For more info
196-- see: http://prosody.im/doc/components#adding_an_external_component
197--
198--Component "gateway.example.com"
199-- component_secret = "password"
200
201------ Additional config files ------
202-- For organizational purposes you may prefer to add VirtualHost and
203-- Component definitions in their own config files. This line includes
204-- all config files in /etc/prosody/conf.d/
205
206Include "conf.d/*.cfg.lua"