Update and add some comments to the default and example configuration files.
[umurmur.git] / umurmur.conf.example
1 max_bandwidth = 48000;
2 welcometext = "Welcome to uMurmur!";
3 certificate = "/etc/umurmur/cert.crt";
4 private_key = "/etc/umurmur/key.key";
5 password = "";
6 max_users = 10;
7
8 # bindport = 64738;
9 # bindaddr = "192.168.1.1";
10
11 # username and groupname for privilege dropping.
12 # Will attempt to switch user if set. 
13 # username = "";
14 # If groupname not set the user's default login group will be used
15 # groupname = "";
16
17 # Log to file option. Default is logging to syslog.
18 # umurmurd will close and reopen the logfile if SIGHUP is received.
19 # logfile = "/var/log/umurmurd.log";
20
21 # Channel tree definition:
22 # Root channel must always be defined first.
23 # If a channel has a parent, the parent must be defined before the child channel(s).
24 channels = ( {
25          name = "Root";
26          parent = "";
27          description = "Root channel. No entry.";
28          noenter = true;
29          },
30          {
31          name = "Lobby";
32          parent = "Root";
33          description = "Lobby channel";
34          },
35          {
36          name = "Red team";
37          parent = "Lobby";
38          description = "The Red team channel";
39          },
40          {
41          name = "Blue team";
42          parent = "Lobby";
43          description = "The Blue team channel";
44          }
45 );
46 # Channel links configuration.
47 channel_links = ( {
48          source = "Lobby";
49          destination = "Red team";
50          },
51          {
52          source = "Lobby";
53          destination = "Blue team";
54          }
55 );
56
57 # The channel in which users will appear in when connecting.
58 default_channel = "Lobby";