Use Client_find_by_session() instead of a few open-coded loops.

[umurmur.git] / umurmur.conf.example

diff --git a/umurmur.conf.example b/umurmur.conf.example
index fad2b8091c3c0522354cc1e48ffde81f7eee00cb..1c32a7887016942a8c89472bcddf9bf7f31415c1 100644 (file)
--- a/umurmur.conf.example
+++ b/umurmur.conf.example
@@ -3,23 +3,40 @@ welcometext = "Welcome to uMurmur!";
 certificate = "/etc/umurmur/cert.crt";
 private_key = "/etc/umurmur/key.key";
 password = "";
+# admin_password = "test";   # Set to enable admin functionality.
+# ban_length = 0;            # Length in seconds for a ban. Default is 0. 0 = forever.
+# enable_ban = false;        # Default is false
+# banfile = "banfile.txt";   # File to save bans to. Default is to not save bans to file.
+# sync_banfile = false;      # Keep banfile synced. Default is false, which means it is saved to at shutdown only.
+# allow_textmessage = true;  # Default is true
+# opus_threshold = 100;      # Percentage of users supporting Opus codec for it to be chosen. Default is 100.
+# show_addresses = true;     # Whether to show client's IP addresses under user information
 max_users = 10;
 
+# 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 = "";
 
-# bindport = 64738;
-# bindaddr = "192.168.1.1";
+# 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";
 
+# CA location for CA-signed certificates
+# ca_path = "/path/to/ca/certificates/";
+
+# 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";
@@ -27,14 +44,24 @@ channels = ( {
         description = "Lobby channel";
         },
         {
+        name = "Silent";
+        parent = "Root";
+        description = "Silent channel";
+        silent = true; # Optional. Default is false 
+        },
+        {
         name = "Red team";
         parent = "Lobby";
         description = "The Red team channel";
+     position = 0;   # Optional. Default is 0 and the channels will be shown in alphabetic order.
+     # password = "redpw";
         },
         {
         name = "Blue team";
         parent = "Lobby";
         description = "The Blue team channel";
+     position = 1;   # Optional. Default is 0 and the channels will be shown in alphabetic order.
+     # password = "bluepw";
         }
 );
 # Channel links configuration.
@@ -48,4 +75,6 @@ channel_links = ( {
         }
 );
 
+# The channel in which users will appear in when connecting.
+# Note that default channel can't have 'noenter = true' or password set
 default_channel = "Lobby";