s2smanager: Fix letter case in log message (thanks darkrain)
[prosody.git] / prosody.cfg.lua.dist
index c43d1131903029f41e59d4dbbef11f1196374353..e513b11622ae901cbcc6d52e2e055d7441fe5d53 100644 (file)
@@ -1,8 +1,8 @@
 -- Prosody Example Configuration File
--- 
+--
 -- Information on configuring Prosody can be found on our
 -- website at http://prosody.im/doc/configure
--- 
+--
 -- Tip: You can check that the syntax of this file is correct
 -- when you have finished by running: luac -p prosody.cfg.lua
 -- If there are any errors, it will let you know what and where
 -- Example: admins = { "user1@example.com", "user2@example.net" }
 admins = { }
 
+-- Enable use of libevent for better performance under high load
+-- For more information see: http://prosody.im/doc/libevent
+--use_libevent = true;
+
 -- This is the list of modules Prosody will load on startup.
 -- It looks for mod_modulename.lua in the plugins folder, so make sure that exists too.
+-- Documentation on modules can be found at: http://prosody.im/doc/modules
 modules_enabled = {
 
        -- Generally required
@@ -32,11 +37,13 @@ modules_enabled = {
                "tls"; -- Add support for secure TLS on c2s/s2s connections
                "dialback"; -- s2s dialback support
                "disco"; -- Service discovery
-       
+
        -- Not essential, but recommended
                "private"; -- Private XML storage (for room bookmarks, etc.)
                "vcard"; -- Allow users to set vCards
-       
+               --"privacy"; -- Support privacy lists
+               --"compression"; -- Stream compression
+
        -- Nice to have
                "legacyauth"; -- Legacy authentication. Only used by some old clients and bots.
                "version"; -- Replies to server version requests
@@ -45,27 +52,37 @@ modules_enabled = {
                "ping"; -- Replies to XMPP pings with pongs
                "pep"; -- Enables users to publish their mood, activity, playing music and more
                "register"; -- Allow users to register on this server using a client and change passwords
-       
+               "adhoc"; -- Support for "ad-hoc commands" that can be executed with an XMPP client
+
+       -- Admin interfaces
+               "admin_adhoc"; -- Allows administration via an XMPP client that supports ad-hoc commands
+               --"admin_telnet"; -- Opens telnet console interface on localhost port 5582
+
        -- Other specific functionality
                --"posix"; -- POSIX functionality, sends server to background, enables syslog, etc.
-               --"console"; -- Opens admin telnet interface on localhost port 5582
                --"bosh"; -- Enable BOSH clients, aka "Jabber over HTTP"
                --"httpserver"; -- Serve static files from a directory over HTTP
+               --"groups"; -- Shared roster support
+               --"announce"; -- Send announcement to all online users
+               --"welcome"; -- Welcome users who register accounts
+               --"watchregistrations"; -- Alert admins of registrations
+               --"motd"; -- Send a message to users when they log in
 };
 
 -- These modules are auto-loaded, should you
--- for (for some mad reason) want to disable
+-- (for some mad reason) want to disable
 -- them then uncomment them below
 modules_disabled = {
-       -- "presence";
-       -- "message";
-       -- "iq";
+       -- "presence"; -- Route user/contact status information
+       -- "message"; -- Route messages
+       -- "iq"; -- Route info queries
+       -- "offline"; -- Store offline messages
 };
 
 -- Disable account creation by default, for security
 -- For more information see http://prosody.im/doc/creating_accounts
 allow_registration = false;
-       
+
 -- These are the SSL/TLS-related settings. If you don't want
 -- to use SSL/TLS, you may comment or remove this
 ssl = {
@@ -73,6 +90,45 @@ ssl = {
        certificate = "certs/localhost.cert";
 }
 
+-- Only allow encrypted streams? Encryption is already used when
+-- available. These options will cause Prosody to deny connections that
+-- are not encrypted. Note that some servers do not support s2s
+-- encryption or have it disabled, including gmail.com and Google Apps
+-- domains.
+
+--c2s_require_encryption = false
+--s2s_require_encryption = false
+
+-- Select the authentication backend to use. The 'internal' providers
+-- use Prosody's configured data storage to store the authentication data.
+-- To allow Prosody to offer secure authentication mechanisms to clients, the
+-- default provider stores passwords in plaintext. If you do not trust your
+-- server please see http://prosody.im/doc/modules/mod_auth_internal_hashed
+-- for information about using the hashed backend.
+
+authentication = "internal_plain"
+
+-- Select the storage backend to use. By default Prosody uses flat files
+-- in its configured data directory, but it also supports more backends
+-- through modules. An "sql" backend is included by default, but requires
+-- additional dependencies. See http://prosody.im/doc/storage for more info.
+
+--storage = "sql" -- Default is "internal"
+
+-- For the "sql" backend, you can uncomment *one* of the below to configure:
+--sql = { driver = "SQLite3", database = "prosody.sqlite" } -- Default. 'database' is the filename.
+--sql = { driver = "MySQL", database = "prosody", username = "prosody", password = "secret", host = "localhost" }
+--sql = { driver = "PostgreSQL", database = "prosody", username = "prosody", password = "secret", host = "localhost" }
+
+-- Logging configuration
+-- For advanced logging see http://prosody.im/doc/logging
+log = {
+       info = "prosody.log"; -- Change 'info' to 'debug' for verbose logging
+       error = "prosody.err";
+       -- "*syslog"; -- Uncomment this for logging to syslog
+       -- "*console"; -- Log to the console, useful for debugging with daemonize=false
+}
+
 ----------- Virtual hosts -----------
 -- You need to add a VirtualHost entry for each domain you wish Prosody to serve.
 -- Settings under each VirtualHost entry apply *only* to that host.
@@ -86,10 +142,10 @@ VirtualHost "example.com"
        -- set in the global section (if any).
        -- Note that old-style SSL on port 5223 only supports one certificate, and will always
        -- use the global one.
-       ssl = { 
+       ssl = {
                key = "certs/example.com.key";
                certificate = "certs/example.com.crt";
-               }
+       }
 
 ------ Components ------
 -- You can specify components to add hosts that provide special services,
@@ -99,6 +155,14 @@ VirtualHost "example.com"
 ---Set up a MUC (multi-user chat) room server on conference.example.com:
 --Component "conference.example.com" "muc"
 
+-- Set up a SOCKS5 bytestream proxy for server-proxied file transfers:
+--Component "proxy.example.com" "proxy65"
+
 ---Set up an external component (default component port is 5347)
+--
+-- External components allow adding various services, such as gateways/
+-- transports to other networks like ICQ, MSN and Yahoo. For more info
+-- see: http://prosody.im/doc/components#adding_an_external_component
+--
 --Component "gateway.example.com"
 --     component_secret = "password"