Update and add some comments to the default and example configuration files.

[umurmur.git] / umurmur.conf.example

diff --git a/umurmur.conf.example b/umurmur.conf.example
index 09b49c5a581de5c8354341481e18f4ee66e02001..0caf16c90be8a429551dfd7bbc304d92c73c6429 100644 (file)
--- a/umurmur.conf.example
+++ b/umurmur.conf.example
@@ -4,15 +4,28 @@ certificate = "/etc/umurmur/cert.crt";
 private_key = "/etc/umurmur/key.key";
 password = "";
 max_users = 10;
-username = "";
-groupname = "";
 
+# bindport = 64738;
+# bindaddr = "192.168.1.1";
+
+# username and groupname for privilege dropping.
+# Will attempt to switch user if set. 
+# username = "";
+# If groupname not set the user's default login group will be used
+# groupname = "";
+
+# Log to file option. Default is logging to syslog.
+# umurmurd will close and reopen the logfile if SIGHUP is received.
+# logfile = "/var/log/umurmurd.log";
+
+# Channel tree definition:
 # Root channel must always be defined first.
 # If a channel has a parent, the parent must be defined before the child channel(s).
 channels = ( {
         name = "Root";
         parent = "";
-        description = "The Root of all channels";
+        description = "Root channel. No entry.";
+        noenter = true;
         },
         {
         name = "Lobby";
@@ -41,4 +54,5 @@ channel_links = ( {
         }
 );
 
+# The channel in which users will appear in when connecting.
 default_channel = "Lobby";