Merge 0.10->trunk
[prosody.git] / prosody.cfg.lua.dist
index 2e07b7f5d4ceb1b363514d620ac86de5c9442e43..15725a35a77ad1d69ca9ca227d165e76390d3cf7 100644 (file)
@@ -1,10 +1,10 @@
 -- Prosody Example Configuration File
--- 
+--
 -- Information on configuring Prosody can be found on our
--- website at http://prosody.im/doc/configure
--- 
+-- website at https://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
+-- when you have finished by running: prosodyctl check config
 -- If there are any errors, it will let you know what and where
 -- they are, otherwise it will keep quiet.
 --
 
 -- This is a (by default, empty) list of accounts that are admins
 -- for the server. Note that you must create the accounts separately
--- (see http://prosody.im/doc/creating_accounts for info)
+-- (see https://prosody.im/doc/creating_accounts for info)
 -- 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;
+-- For more information see: https://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
+-- Documentation on modules can be found at: https://prosody.im/doc/modules
 modules_enabled = {
 
        -- Generally required
@@ -41,11 +41,12 @@ modules_enabled = {
        -- Not essential, but recommended
                "private"; -- Private XML storage (for room bookmarks, etc.)
                "vcard"; -- Allow users to set vCards
-               --"privacy"; -- Support privacy lists
+       
+       -- These are commented by default as they have a performance impact
+               --"blocklist"; -- Allow users to block communications with other users
                --"compression"; -- Stream compression
 
        -- Nice to have
-               "legacyauth"; -- Legacy authentication. Only used by some old clients and bots.
                "version"; -- Replies to server version requests
                "uptime"; -- Report how long server has been running
                "time"; -- Let others know the time here on this server
@@ -53,46 +54,96 @@ modules_enabled = {
                "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
 
-       -- Other specific functionality
-               --"posix"; -- POSIX functionality, sends server to background, enables syslog, etc.
-               --"console"; -- Opens admin telnet interface on localhost port 5582
+       -- 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
+       
+       -- HTTP modules
                --"bosh"; -- Enable BOSH clients, aka "Jabber over HTTP"
-               --"httpserver"; -- Serve static files from a directory over HTTP
+               --"http_files"; -- Serve static files from a directory over HTTP
+
+       -- Other specific functionality
                --"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
+               --"legacyauth"; -- Legacy authentication. Only used by some old clients and bots.
+}
 
--- These modules are auto-loaded, should you
--- for (for some mad reason) want to disable
--- them then uncomment them below
+-- These modules are auto-loaded, but should you want
+-- to disable them then uncomment them here:
 modules_disabled = {
-       -- "presence";
-       -- "message";
-       -- "iq";
-       -- "defaultauth";
-};
+       -- "offline"; -- Store offline messages
+       -- "c2s"; -- Handle client connections
+       -- "s2s"; -- Handle server-to-server connections
+       -- "posix"; -- POSIX functionality, sends server to background, enables syslog, etc.
+}
 
 -- Disable account creation by default, for security
--- For more information see http://prosody.im/doc/creating_accounts
-allow_registration = false;
-       
+-- For more information see https://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 = {
        key = "certs/localhost.key";
-       certificate = "certs/localhost.cert";
+       certificate = "certs/localhost.crt";
 }
 
--- Require encryption on client/server connections?
---c2s_require_encryption = false
---s2s_require_encryption = false
+-- Force clients to use encrypted connections? This option will
+-- prevent clients from authenticating unless they are using encryption.
+
+c2s_require_encryption = true
+
+-- Force certificate authentication for server-to-server connections?
+-- This provides ideal security, but requires servers you communicate
+-- with to support encryption AND present valid, trusted certificates.
+-- NOTE: Your version of LuaSec must support certificate verification!
+-- For more information see https://prosody.im/doc/s2s#security
+
+s2s_secure_auth = false
+
+-- Many servers don't support encryption or have invalid or self-signed
+-- certificates. You can list domains here that will not be required to
+-- authenticate using certificates. They will be authenticated using DNS.
+
+--s2s_insecure_domains = { "gmail.com" }
+
+-- Even if you leave s2s_secure_auth disabled, you can still require valid
+-- certificates for some domains by specifying a list here.
+
+--s2s_secure_domains = { "jabber.org" }
+
+-- 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 https://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 https://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 = "prosody.log";
-debug = false; -- Log debug messages?
+-- For advanced logging see https://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.
@@ -107,7 +158,7 @@ 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";
        }
@@ -115,7 +166,7 @@ VirtualHost "example.com"
 ------ Components ------
 -- You can specify components to add hosts that provide special services,
 -- like multi-user conferences, and transports.
--- For more information on components, see http://prosody.im/doc/components
+-- For more information on components, see https://prosody.im/doc/components
 
 ---Set up a MUC (multi-user chat) room server on conference.example.com:
 --Component "conference.example.com" "muc"
@@ -124,5 +175,10 @@ VirtualHost "example.com"
 --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: https://prosody.im/doc/components#adding_an_external_component
+--
 --Component "gateway.example.com"
 --     component_secret = "password"