prosody.cfg.lua (7257B)
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 "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 "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 69 --"motd"; -- Send a message to users when they log in 70 }; 71 72 -- These modules are auto-loaded, should you 73 -- (for some mad reason) want to disable 74 -- them then uncomment them below 75 modules_disabled = { 76 -- "presence"; -- Route user/contact status information 77 -- "message"; -- Route messages 78 -- "iq"; -- Route info queries 79 -- "offline"; -- Store offline messages 80 }; 81 82 -- Disable account creation by default, for security 83 -- For more information see http://prosody.im/doc/creating_accounts 84 allow_registration = false; 85 86 -- Only allow encrypted streams? Encryption is already used when 87 -- available. These options will cause Prosody to deny connections that 88 -- are not encrypted. Note that some servers do not support s2s 89 -- encryption or have it disabled, including gmail.com and Google Apps 90 -- domains. 91 92 --c2s_require_encryption = false 93 --s2s_require_encryption = false 94 95 -- Select the authentication backend to use. The 'internal' providers 96 -- use Prosody's configured data storage to store the authentication data. 97 -- To allow Prosody to offer secure authentication mechanisms to clients, the 98 -- default provider stores passwords in plaintext. If you do not trust your 99 -- server please see http://prosody.im/doc/modules/mod_auth_internal_hashed 100 -- for information about using the hashed backend. 101 -- See http://prosody.im/doc/authentication for other possibilities including 102 -- Cyrus SASL. 103 104 authentication = "internal_plain" 105 106 -- Select the storage backend to use. By default Prosody uses flat files 107 -- in its configured data directory, but it also supports more backends 108 -- through modules. An "sql" backend is included by default, but requires 109 -- additional dependencies. See http://prosody.im/doc/storage for more info. 110 111 --storage = "sql" -- Default is "internal" 112 113 -- For the "sql" backend, you can uncomment *one* of the below to configure: 114 --sql = { driver = "SQLite3", database = "prosody.sqlite" } -- Default. 'database' is the filename. 115 --sql = { driver = "MySQL", database = "prosody", username = "prosody", password = "secret", host = "localhost" } 116 --sql = { driver = "PostgreSQL", database = "prosody", username = "prosody", password = "secret", host = "localhost" } 117 118 -- Logging configuration 119 -- For advanced logging see http://prosody.im/doc/logging 120 log = { 121 info = "/var/log/prosody/prosody.log"; -- Change 'info' to 'debug' for verbose logging 122 error = "/var/log/prosody/prosody.err"; 123 -- "*syslog"; -- Uncomment this for logging to syslog; needs mod_posix 124 -- "*console"; -- Log to the console, useful for debugging with daemonize=false 125 } 126 127 -- Pidfile, used by prosodyctl and the init.d script 128 pidfile = "/var/run/prosody/prosody.pid" 129 130 -- User and group, used for daemon 131 prosody_user = "prosody" 132 prosody_group = "prosody" 133 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. 137 138 VirtualHost "localhost" 139 140 VirtualHost "example.com" 141 enabled = false -- Remove this line to enable this host 142 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. 147 ssl = { 148 key = "/etc/prosody/certs/example.com.key"; 149 certificate = "/etc/prosody/certs/example.com.crt"; 150 } 151 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 156 157 ---Set up a MUC (multi-user chat) room server on conference.example.com: 158 --Component "conference.example.com" "muc" 159 160 -- Set up a SOCKS5 bytestream proxy for server-proxied file transfers: 161 --Component "proxy.example.com" "proxy65" 162 163 ---Set up an external component (default component port is 5347) 164 -- 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 168 -- 169 --Component "gateway.example.com" 170 -- component_secret = "password"