updated README
[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 # CA location for CA-signed certificates
29 # ca_path = "/path/to/ca/certificates/";
30
31 # Channel tree definition:
32 # Root channel must always be defined first.
33 # If a channel has a parent, the parent must be defined before the child channel(s).
34 channels = ( {
35          name = "Root";
36          parent = "";
37          description = "Root channel. No entry.";
38          noenter = true;
39          },
40          {
41          name = "Lobby";
42          parent = "Root";
43          description = "Lobby channel";
44          },
45          {
46          name = "Silent";
47          parent = "Root";
48          description = "Silent channel";
49          silent = true; # Optional. Default is false 
50          },
51          {
52          name = "Red team";
53          parent = "Lobby";
54          description = "The Red team channel";
55      position = 0;   # Optional. Default is 0 and the channels will be shown in alphabetic order.
56      # password = "redpw";
57          },
58          {
59          name = "Blue team";
60          parent = "Lobby";
61          description = "The Blue team channel";
62      position = 1;   # Optional. Default is 0 and the channels will be shown in alphabetic order.
63      # password = "bluepw";
64          }
65 );
66 # Channel links configuration.
67 channel_links = ( {
68          source = "Lobby";
69          destination = "Red team";
70          },
71          {
72          source = "Lobby";
73          destination = "Blue team";
74          }
75 );
76
77 # The channel in which users will appear in when connecting.
78 # Note that default channel can't have 'noenter = true' or password set
79 default_channel = "Lobby";