Add new options to example configuration
[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 # admin_password = "test";   # Set to enable admin functionality.
7 # ban_length = 0;            # Length in seconds for a ban. Default is 0. 0 = forever.
8 # enable_ban = false;        # Default is false
9 # banfile = "banfile.txt";   # File to save bans to. Default is to not save bans to file.
10 # sync_banfile = false;      # Keep banfile synced. Default is false, which means it is saved to at shutdown only.
11 # allow_textmessage = true;  # Default is true
12 # opus_threshold = 100;      # Percentage of users supporting Opus codec for it to be chosen. Default is 100.
13 max_users = 10;
14
15 # bindport = 64738;
16 # bindaddr = "192.168.1.1";
17
18 # username and groupname for privilege dropping.
19 # Will attempt to switch user if set. 
20 # username = "";
21 # If groupname not set the user's default login group will be used
22 # groupname = "";
23
24 # Log to file option. Default is logging to syslog.
25 # umurmurd will close and reopen the logfile if SIGHUP is received.
26 # logfile = "/var/log/umurmurd.log";
27
28 # Channel tree definition:
29 # Root channel must always be defined first.
30 # If a channel has a parent, the parent must be defined before the child channel(s).
31 channels = ( {
32          name = "Root";
33          parent = "";
34          description = "Root channel. No entry.";
35          noenter = true;
36          },
37          {
38          name = "Lobby";
39          parent = "Root";
40          description = "Lobby channel";
41          },
42          {
43          name = "Silent";
44          parent = "Root";
45          description = "Silent channel";
46          silent = true; # Optional. Default is false 
47          },
48          {
49          name = "Red team";
50          parent = "Lobby";
51          description = "The Red team channel";
52      position = 0;   # Optional. Default is 0 and the channels will be shown in alphabetic order.
53      # password = "redpw";
54          },
55          {
56          name = "Blue team";
57          parent = "Lobby";
58          description = "The Blue team channel";
59      position = 1;   # Optional. Default is 0 and the channels will be shown in alphabetic order.
60      # password = "bluepw";
61          }
62 );
63 # Channel links configuration.
64 channel_links = ( {
65          source = "Lobby";
66          destination = "Red team";
67          },
68          {
69          source = "Lobby";
70          destination = "Blue team";
71          }
72 );
73
74 # The channel in which users will appear in when connecting.
75 # Note that default channel can't have 'noenter = true' or password set
76 default_channel = "Lobby";