net.adns: Add some debug logging to help track down traceback
[prosody.git] / prosody.cfg.lua.dist
index 7289921a319ba72b7519f991f2b0b4f922e02e9e..38618131b79de218e30b5a4137a713d19c60bd5b 100644 (file)
@@ -1,26 +1,25 @@
 -- 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
+-- 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, etc\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 would be:\r
+-- example table would be:\r
 --\r
--- logging = { type = "html", directory = "/var/logs", rotate = "daily" }\r
+-- ssl = { key = "keyfile.key", certificate = "certificate.cert" }\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
+-- 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
 -- 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
+-- Server-wide 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
+                       -- Generally required\r
                                "roster"; -- Allow users to have a roster. Recommended ;)\r
-                               "register"; -- Allow users to register on this server using a client\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
-                               "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 5582 (needs console_enabled = true)\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
@@ -65,6 +88,9 @@ Host "localhost"
 -- 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
@@ -74,4 +100,5 @@ Host "example.com"
                certificate = "certs/example.com.crt";\r
                }\r
 \r
-       enabled = false -- This will disable the host, preserving the config, but denying connections\r
+-- Set up a MUC (multi-user chat) room server on conference.example.com:\r
+Component "conference.example.com" "muc"\r