X-Git-Url: https://git.enpas.org/?a=blobdiff_plain;f=prosody.cfg.lua.dist;h=d660a9bd21d80b0219700be4ace0af008292059e;hb=73fca41d6807b6fb4606e513a09f35b1415be5a9;hp=80f9e585ac4eee36e89243a26015a4aba5841b39;hpb=2858c071fb42b204bcd08082f24fd5855764a9a4;p=prosody.git

diff --git a/prosody.cfg.lua.dist b/prosody.cfg.lua.dist
index 80f9e585..d660a9bd 100644
--- a/prosody.cfg.lua.dist
+++ b/prosody.cfg.lua.dist
@@ -1,26 +1,25 @@
 -- Prosody Example Configuration File 
 -- 
 -- If it wasn't already obvious, -- starts a comment, and all 
--- text after it is ignored by Prosody.
+-- 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, etc. 
+-- 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 would be:
+-- example table would be:
 --
--- logging = { type = "html", directory = "/var/logs", rotate = "daily" }
+-- ssl = { key = "keyfile.key", certificate = "certificate.cert" }
 --
--- Whitespace (that is tabs, spaces, line breaks) is insignificant, so can 
--- be placed anywhere
--- that 	you deem fitting. Youcouldalsoremoveitentirely,butforobviousrea
---sonsIdon'trecommendit.
+-- 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
@@ -30,28 +29,58 @@
 -- 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!
 
--- Global settings go in this section
+-- 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 for info)
+	-- Example: admins = { "user1@example.com", "user2@example.net" }
+	admins = { }
+	
 	-- 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.
 	modules_enabled = {
-				"saslauth"; -- Authentication for clients and servers. Recommended if you want to log in.
-				"legacyauth"; -- Legacy authentication. Only used by some old clients and bots.
+			-- Generally required
 				"roster"; -- Allow users to have a roster. Recommended ;)
-				"register"; -- Allow users to register on this server using a client
+				"saslauth"; -- Authentication for clients and servers. Recommended if you want to log in.
 				"tls"; -- Add support for secure TLS on c2s/s2s connections
-				"vcard"; -- Allow users to set vCards
-				"private"; -- Private XML storage (for room bookmarks, etc.)
-				"version"; -- Replies to server version requests
 				"dialback"; -- s2s dialback support
 			  	"disco"; -- Service discovery
-			  	"ping"; -- XMPP Ping
-			  	"time"; -- Let others know the time here
-			  	"uptime"; -- Uptime reporting
-			  	"console"; -- telnet to port 5582 (needs console_enabled = true)
+			
+			-- Not essential, but recommended
+				"private"; -- Private XML storage (for room bookmarks, etc.)
+				"vcard"; -- Allow users to set vCards
+			
+			-- 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
+				--"posix"; -- POSIX functionality, sends server to background, enables syslog, etc.
+			  	--"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
 			  };
 	
+	-- 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. If you don't want
 	-- to use SSL/TLS, you may comment or remove this
 	ssl = { 
@@ -65,6 +94,9 @@ 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
+
 	-- 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
@@ -74,5 +106,5 @@ Host "example.com"
 		certificate = "certs/example.com.crt";
 		}
 
-	enabled = false -- This will disable the host, preserving the config, but denying connections
-	
+-- Set up a MUC (multi-user chat) room server on conference.example.com:
+Component "conference.example.com" "muc"