mod_presence: Re-probe for contacts presence after outgoing 'subscribed' (fixes ...
[prosody.git] / prosody.cfg.lua.dist
index 52cc7c73604fa1bba96e4bfcb7a0c15dd912e9c9..230329325b39eaf702f3114bf4b15fbce6188040 100644 (file)
--- Prosody Example Configuration File \r
--- \r
--- If it wasn't already obvious, -- starts a comment, and all \r
--- text after it is ignored by Prosody.\r
---\r
--- The config is split into sections, a global section, and one \r
--- for each defined host that we serve. You can add as many host \r
--- sections as you like.\r
---\r
--- Lists are written { "like", "this", "one" } \r
--- Lists can also be of { 1, 2, 3 } numbers, etc. \r
--- Either commas, or semi-colons; may be used\r
--- as seperators.\r
---\r
--- A table is a list of values, except each value has a name. An \r
--- example would be:\r
---\r
--- logging = { type = "html", directory = "/var/logs", rotate = "daily" }\r
---\r
--- Whitespace (that is tabs, spaces, line breaks) is insignificant, so can \r
--- be placed anywhere\r
--- that        you deem fitting. Youcouldalsoremoveitentirely,butforobviousrea\r
---sonsIdon'trecommendit.\r
---\r
--- Tip: You can check that the syntax of this file is correct when you have finished\r
--- by running: luac -p prosody.cfg.lua\r
--- If there are any errors, it will let you know what and where they are, otherwise it \r
--- will keep quiet.\r
---\r
--- The only thing left to do is rename this file to remove the .dist ending, and fill in the \r
--- blanks. Good luck, and happy Jabbering!\r
-\r
--- Global settings go in this section\r
-Host "*"\r
-       \r
-       -- This is the list of modules Prosody will load on startup.\r
-       -- It looks for mod_modulename.lua in the plugins folder, so make sure that exists too.\r
-       modules_enabled = {\r
-                               "saslauth"; -- Authentication for clients and servers. Recommended if you want to log in.\r
-                               "legacyauth"; -- Legacy authentication. Only used by some old clients and bots.\r
-                               "roster"; -- Allow users to have a roster. Recommended ;)\r
-                               "register"; -- Allow users to register on this server using a client\r
-                               "tls"; -- Add support for secure TLS on c2s/s2s connections\r
-                               "vcard"; -- Allow users to set vCards\r
-                               "private"; -- Private XML storage (for room bookmarks, etc.)\r
-                               "version"; -- Replies to server version requests\r
-                               "dialback"; -- s2s dialback support\r
-                               "disco"; -- Service discovery\r
-                               "ping"; -- XMPP Ping\r
-                               "time"; -- Let others know the time here\r
-                               "uptime"; -- Uptime reporting\r
-                               "console"; -- telnet to port 5528 (needs console_enabled = true)\r
-                         };\r
-       \r
-       -- These are the SSL/TLS-related settings. If you don't want\r
-       -- to use SSL/TLS, you may comment or remove this\r
-       ssl = { \r
-               key = "certs/localhost.key";\r
-               certificate = "certs/localhost.cert";\r
-               }\r
-\r
--- This allows clients to connect to localhost. No harm in it.\r
-Host "localhost"\r
-\r
--- Section for example.com\r
--- (replace example.com with your domain name)\r
-Host "example.com"\r
-       -- Assign this host a certificate for TLS, otherwise it would use the one\r
-       -- set in the global section (if any).\r
-       -- Note that old-style SSL on port 5223 only supports one certificate, and will always\r
-       -- use the global one.\r
-       ssl = { \r
-               key = "certs/example.com.key";\r
-               certificate = "certs/example.com.crt";\r
-               }\r
-\r
-       enabled = false -- This will disable the host, preserving the config, but denying connections\r
-       \r
+-- 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
+-- they are, otherwise it will keep quiet.
+--
+-- The only thing left to do is rename this file to remove the .dist ending, and fill in the
+-- blanks. Good luck, and happy Jabbering!
+
+
+---------- Server-wide settings ----------
+-- Settings in this section apply to the whole server and are the default settings
+-- for any virtual hosts
+
+-- 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)
+-- 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
+               "roster"; -- Allow users to have a roster. Recommended ;)
+               "saslauth"; -- Authentication for clients and servers. Recommended if you want to log in.
+               "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
+       
+       -- These are commented by default as they have a performance impact
+               --"privacy"; -- Support privacy lists
+               --"compression"; -- Stream compression
+
+       -- Nice to have
+               "version"; -- Replies to server version requests
+               "uptime"; -- Report how long server has been running
+               "time"; -- Let others know the time here on this server
+               "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
+
+       -- 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"
+               --"http_files"; -- Serve static files from a directory over HTTP
+
+       -- Other specific functionality
+               --"posix"; -- POSIX functionality, sends server to background, enables syslog, etc.
+               --"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, but should you want
+-- to disable them then uncomment them here:
+modules_disabled = {
+       -- "offline"; -- Store offline messages
+       -- "c2s"; -- Handle client connections
+       -- "s2s"; -- Handle server-to-server connections
+};
+
+-- 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 = {
+       key = "certs/localhost.key";
+       certificate = "certs/localhost.crt";
+}
+
+-- Force clients to use encrypted connections? This option will
+-- prevent clients from authenticating unless they are using encryption.
+
+c2s_require_encryption = false
+
+-- 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 http://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 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.
+
+VirtualHost "localhost"
+
+VirtualHost "example.com"
+       enabled = false -- Remove this line to enable this host
+
+       -- Assign this host a certificate for TLS, otherwise it would use the one
+       -- 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 = {
+               key = "certs/example.com.key";
+               certificate = "certs/example.com.crt";
+       }
+
+------ 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
+
+---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"