|
| 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 | + |
| 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 | + "adhoc"; -- Support for "ad-hoc commands" that can be executed with an XMPP client |
| 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 | + -- Other specific functionality |
| 62 | + "bosh"; -- Enable BOSH clients, aka "Jabber over HTTP" |
| 63 | + "websocket"; -- Websocket support |
| 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 |
| 69 | + --"motd"; -- Send a message to users when they log in |
| 70 | + -- Debian: do not remove this module, or you lose syslog |
| 71 | + -- support |
| 72 | + "posix"; -- POSIX functionality, sends server to background, enables syslog, etc. |
| 73 | +}; |
| 74 | + |
| 75 | +-- These modules are auto-loaded, should you |
| 76 | +-- (for some mad reason) want to disable |
| 77 | +-- them then uncomment them below |
| 78 | +modules_disabled = { |
| 79 | + -- "presence"; -- Route user/contact status information |
| 80 | + -- "message"; -- Route messages |
| 81 | + -- "iq"; -- Route info queries |
| 82 | + -- "offline"; -- Store offline messages |
| 83 | +}; |
| 84 | + |
| 85 | +-- Disable account creation by default, for security |
| 86 | +-- For more information see http://prosody.im/doc/creating_accounts |
| 87 | +allow_registration = false; |
| 88 | + |
| 89 | +-- Debian: |
| 90 | +-- send the server to background. |
| 91 | +-- |
| 92 | +daemonize = true; |
| 93 | + |
| 94 | +-- Debian: |
| 95 | +-- Please, don't change this option since /var/run/prosody/ |
| 96 | +-- is one of the few directories Prosody is allowed to write to |
| 97 | +-- |
| 98 | +pidfile = "/var/run/prosody/prosody.pid"; |
| 99 | + |
| 100 | +-- These are the SSL/TLS-related settings. If you don't want |
| 101 | +-- to use SSL/TLS, you may comment or remove this |
| 102 | +ssl = { |
| 103 | + key = "/etc/prosody/certs/localhost.key"; |
| 104 | + certificate = "/etc/prosody/certs/localhost.crt"; |
| 105 | +} |
| 106 | + |
| 107 | +-- Only allow encrypted streams? Encryption is already used when |
| 108 | +-- available. These options will cause Prosody to deny connections that |
| 109 | +-- are not encrypted. Note that some servers do not support s2s |
| 110 | +-- encryption or have it disabled, including gmail.com and Google Apps |
| 111 | +-- domains. |
| 112 | + |
| 113 | +--c2s_require_encryption = false |
| 114 | +--s2s_require_encryption = false |
| 115 | + |
| 116 | +-- Select the authentication backend to use. The 'internal' providers |
| 117 | +-- use Prosody's configured data storage to store the authentication data. |
| 118 | +-- To allow Prosody to offer secure authentication mechanisms to clients, the |
| 119 | +-- default provider stores passwords in plaintext. If you do not trust your |
| 120 | +-- server please see http://prosody.im/doc/modules/mod_auth_internal_hashed |
| 121 | +-- for information about using the hashed backend. |
| 122 | + |
| 123 | +authentication = "anonymous" |
| 124 | + |
| 125 | +-- Select the storage backend to use. By default Prosody uses flat files |
| 126 | +-- in its configured data directory, but it also supports more backends |
| 127 | +-- through modules. An "sql" backend is included by default, but requires |
| 128 | +-- additional dependencies. See http://prosody.im/doc/storage for more info. |
| 129 | + |
| 130 | +--storage = "sql" -- Default is "internal" |
| 131 | + |
| 132 | +-- For the "sql" backend, you can uncomment *one* of the below to configure: |
| 133 | +--sql = { driver = "SQLite3", database = "prosody.sqlite" } -- Default. 'database' is the filename. |
| 134 | +--sql = { driver = "MySQL", database = "prosody", username = "prosody", password = "secret", host = "localhost" } |
| 135 | +--sql = { driver = "PostgreSQL", database = "prosody", username = "prosody", password = "secret", host = "localhost" } |
| 136 | + |
| 137 | +-- Logging configuration |
| 138 | +-- For advanced logging see http://prosody.im/doc/logging |
| 139 | +-- |
| 140 | +-- Debian: |
| 141 | +-- Logs info and higher to /var/log |
| 142 | +-- Logs errors to syslog also |
| 143 | +log = { |
| 144 | + -- Log files (change 'info' to 'debug' for debug logs): |
| 145 | + info = "/var/log/prosody/prosody.log"; |
| 146 | + error = "/var/log/prosody/prosody.err"; |
| 147 | + -- Syslog: |
| 148 | + { levels = { "error" }; to = "syslog"; }; |
| 149 | +} |
| 150 | + |
| 151 | +----------- Virtual hosts ----------- |
| 152 | +-- You need to add a VirtualHost entry for each domain you wish Prosody to serve. |
| 153 | +-- Settings under each VirtualHost entry apply *only* to that host. |
| 154 | + |
| 155 | +-- Setup localhost VirtualHost |
| 156 | +VirtualHost "localhost" |
| 157 | + |
| 158 | +------ Components ------ |
| 159 | +-- You can specify components to add hosts that provide special services, |
| 160 | +-- like multi-user conferences, and transports. |
| 161 | +-- For more information on components, see http://prosody.im/doc/components |
| 162 | + |
| 163 | +---Set up a MUC (multi-user chat) room server on conference.example.com: |
| 164 | +Component "conference.localhost" "muc" |
| 165 | + |
| 166 | +-- Set up a SOCKS5 bytestream proxy for server-proxied file transfers: |
| 167 | +--Component "proxy.example.com" "proxy65" |
| 168 | + |
| 169 | +---Set up an external component (default component port is 5347) |
| 170 | +-- |
| 171 | +-- External components allow adding various services, such as gateways/ |
| 172 | +-- transports to other networks like ICQ, MSN and Yahoo. For more info |
| 173 | +-- see: http://prosody.im/doc/components#adding_an_external_component |
| 174 | +-- |
| 175 | +--Component "gateway.example.com" |
| 176 | +-- component_secret = "password" |
| 177 | + |
| 178 | +------ Additional config files ------ |
| 179 | +-- For organizational purposes you may prefer to add VirtualHost and |
| 180 | +-- Component definitions in their own config files. This line includes |
| 181 | +-- all config files in /etc/prosody/conf.d/ |
| 182 | + |
| 183 | +Include "conf.d/*.cfg.lua" |
0 commit comments