Merge 0.6.2/waqas with 0.6.2/MattJ
[prosody.git] / prosody.cfg.lua.dist
index de460956b7cfe43cef5b47cf9d1b98f3215d8a38..021f6f117edd11eaf2b33be2593970908471665f 100644 (file)
--- Prosody Example Configuration File \r
--- \r
--- If it wasn't already obvious, -- starts a comment, and all \r
--- text after it on a line 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, and other things. \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 table would be:\r
---\r
--- ssl = { key = "keyfile.key", certificate = "certificate.cert" }\r
---\r
--- Whitespace (that is tabs, spaces, line breaks) is mostly insignificant, so \r
--- can \r
--- be placed anywhere that     you deem fitting.\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
--- Server-wide settings go in this section\r
-Host "*"\r
-       \r
-       -- This is a (by default, empty) list of accounts that are admins \r
-       -- for the server. Note that you must create the accounts separately\r
-       -- (see http://prosody.im/doc/creating_accounts for info)\r
-       -- Example: admins = { "user1@example.com", "user2@example.net" }\r
-       admins = { }\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
-                       -- Generally required\r
-                               "roster"; -- Allow users to have a roster. Recommended ;)\r
-                               "saslauth"; -- Authentication for clients and servers. Recommended if you want to log in.\r
-                               "tls"; -- Add support for secure TLS on c2s/s2s connections\r
-                               "dialback"; -- s2s dialback support\r
-                               "disco"; -- Service discovery\r
-                       \r
-                       -- Not essential, but recommended\r
-                               "private"; -- Private XML storage (for room bookmarks, etc.)\r
-                               "vcard"; -- Allow users to set vCards\r
-                       \r
-                       -- Nice to have\r
-                               "legacyauth"; -- Legacy authentication. Only used by some old clients and bots.\r
-                               "version"; -- Replies to server version requests\r
-                               "uptime"; -- Report how long server has been running\r
-                               "time"; -- Let others know the time here on this server\r
-                               "ping"; -- Replies to XMPP pings with pongs\r
-                               "pep"; -- Enables users to publish their mood, activity, playing music and more\r
-                               "register"; -- Allow users to register on this server using a client and change passwords\r
-\r
-                       -- Other specific functionality\r
-                               --"posix"; -- POSIX functionality, sends server to background, enables syslog, etc.\r
-                               --"console"; -- telnet to port 5582 (needs console_enabled = true)\r
-                               --"bosh"; -- Enable BOSH clients, aka "Jabber over HTTP"\r
-                               --"httpserver"; -- Serve static files from a directory over HTTP\r
-                         };\r
-       \r
-       -- These modules are auto-loaded, should you\r
-       -- for (for some mad reason) want to disable\r
-       -- them then uncomment them below\r
-       modules_disabled = {\r
-                       -- "presence";\r
-                       -- "message";\r
-                       -- "iq";\r
-       };\r
-\r
-       -- Disable account creation by default, for security\r
-       -- For more information see http://prosody.im/doc/creating_accounts\r
-       allow_registration = false;\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
-\r
-       enabled = false -- This will disable the host, preserving the config, but denying connections\r
-\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
--- Set up a MUC (multi-user chat) room server on conference.example.com:\r
-Component "conference.example.com" "muc"\r
+-- Prosody Example Configuration File
+--
+-- If it wasn't already obvious, -- starts a comment, and all
+-- text after it on a line is ignored by Prosody.
+--
+-- The config is split into sections, a global section, and one
+-- for each defined host that we serve. You can add as many host
+-- sections as you like.
+--
+-- Lists are written { "like", "this", "one" }
+-- Lists can also be of { 1, 2, 3 } numbers, and other things.
+-- Either commas, or semi-colons; may be used
+-- as seperators.
+--
+-- A table is a list of values, except each value has a name. An
+-- example table would be:
+--
+-- ssl = { key = "keyfile.key", certificate = "certificate.cert" }
+--
+-- Whitespace (that is tabs, spaces, line breaks) is mostly
+-- insignificant, so
+-- can
+-- be placed anywhere that      you deem fitting.
+--
+-- 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 go in this section
+Host "*"
+
+    -- 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)
+    -- 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.
+        "dialback"; -- s2s dialback support
+        "disco";    -- Service discovery
+        "posix";    -- POSIX functionality, daemonizes, enables syslog, etc.
+
+        -- Not essential, but recommended
+        "private";       -- Private XML storage (for room bookmarks, etc.)
+        "vcard";         -- Allow users to set vCards
+        "privacy";       -- Support privacy lists
+        "tls";           -- Support for secure TLS on c2s/s2s connections
+        --"compression"; -- Stream compression for client-to-server streams
+
+        -- 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
+        "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
+
+        -- Other specific functionality
+        --"console";            -- telnet to port 5582
+                                -- (needs console_enabled = true)
+        --"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
+    }
+
+    -- These modules are auto-loaded, should you for (for some mad
+    -- reason) want to disable them then uncomment them below.
+    modules_disabled = {
+        --"presence";
+        --"message";
+        --"iq";
+    }
+
+    -- 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.
+    --ssl = {
+    --    key = "certs/localhost.key";
+    --    certificate = "certs/localhost.cert";
+    --}
+
+    -- Require encryption on client/server connections?
+    --c2s_require_encryption = false
+    --s2s_require_encryption = false
+
+    -- Logging configuration
+    -- For advanced logging see http://prosody.im/doc/logging
+    log = "prosody.log";
+    debug = false; -- Log debug messages?
+
+-- This allows clients to connect to localhost. No harm in it.
+Host "localhost"
+
+-- Section for example.com
+-- (replace example.com with your domain name)
+Host "example.com"
+    enabled = false -- This will disable the host, preserving the config, but
+                    -- denying connections (remove to enable!)
+
+    -- 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";
+    --}
+
+-- 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"