1SVXREFLECTOR.CONF(5)             File Formats             SVXREFLECTOR.CONF(5)
2
3
4

NAME

6       svxreflector.conf  - Configuration file for the SvxReflector conference
7       server audio reflector
8

DESCRIPTION

10       The svxreflector server is used to interconnect multiple SvxLink  nodes
11       into one network.  This man-page describe the configuration file format
12       for it.
13
14       SvxReflector look for configuration files in a number of places.  First
15       it tries to find a user specific configuration file. It will look for a
16       user specific configuration file in:  $HOME/.svxlink/svxreflector.conf.
17       If  no user specific configuration file can be found, svxreflector will
18       look for the system  wide  configuration  file  /etc/svxlink/svxreflec‐
19       tor.conf.  The --config command line option may also be used to specify
20       an arbitrary configuration file.
21

FILE FORMAT

23       The configuration file is in the  famous  INI-file  format.  A  generic
24       example of how such a file might look like is shown below.
25
26         [SECTION1]
27         VALUE1=1
28         VALUE2="TWO "
29         VAULE3="Multi "
30                "line"
31
32         [SECTION2]
33         VALUE1=2
34
35       This  is a simple format that contain name=value pairs that belong to a
36       section.  In written text, a specific  configuration  variable  can  be
37       referred  to  as SECTION1/VALUE2 meaning "configuration variable VALUE2
38       in section SECTION1".
39
40       The same variable name can exist in two different sections. For example
41       VALUE1  in section SECTION1 have the value 1 and VALUE1 in section SEC‐
42       TION2 have the value 2. Values containing spaces at  the  beginning  or
43       end  of  the  line  must be surrounded by citation characters (see SEC‐
44       TION1/VALUE2). Likewise with a multi line value (see SECTION1/VALUE3).
45

CONFIGURATION VARIABLES

47       Here is the description of all configuration variables that  svxreflec‐
48       tor  understands. The configuration variables are described section for
49       section.
50
51   GLOBAL
52       The GLOBAL section contains application global configuration data.
53
54       CFG_DIR
55              Specify the path to a directory that contain additional configu‐
56              ration files.  If a relative path is specified, the path will be
57              relative to the directory where the main configuration  file  is
58              at.  All  files in the specified directory will be read as addi‐
59              tional configuration. Filenames starting with a dot are ignored.
60
61       TIMESTAMP_FORMAT
62              This variable specifies the format  of  the  timestamp  that  is
63              written  in front of each row in the log file. The format string
64              is in the same format as specified  in  the  strftime(3)  manual
65              page.  The default is "%c" which is described as: "the preferred
66              date and time representation for the current locale". The  envi‐
67              ronment  variables LC_TIME, LC_ALL and LANG will affect how this
68              time format will look. For example, setting LC_TIME="sv_SE.UTF8"
69              will  give  you Swedish timestamp representation. Other examples
70              of format specifiers are:
71
72              ·   %d - The day of the month as a decimal number (range  01  to
73                  31)
74
75              ·   %b  -  The  abbreviated  month name according to the current
76                  locale
77
78              ·   %Y - The year as a decimal number including the century
79
80              ·   %H - The hour as a decimal  number  using  a  24-hour  clock
81                  (range 00 to 23)
82
83              ·   %M - The minute as a decimal number (range 00 to 59)
84
85              ·   %S - The second as a decimal number (range 00 to 61)
86
87              So,  TIMESTAMP_FORMAT="%d %b %Y %H:%M:%S" would give a timestamp
88              looking something like: "29 Nov 2005 22:31:59".
89
90       LISTEN_PORT
91              The TCP and UDP port number to use for  network  communications.
92              The  default  is  5300. Make sure to open this port for incoming
93              traffic to the server on both TCP and UDP. Clients do  not  have
94              to open any ports in their firewalls.
95
96       SQL_TIMEOUT
97              Use  this  configuration variable to set a time in seconds after
98              which a clients audio is blocked if he has been talking for  too
99              long. The default is 0 (disabled).
100
101       SQL_TIMEOUT_BLOCKTIME
102              If  a client has been talking for longer than the time specified
103              in the SQL_TIMEOUT configuration variable he will not be able to
104              talk  again  until  the time in this configuration variable have
105              elapsed. If not specified, the default is one second.
106
107       CODECS A comma separated list of allowed codecs. For  the  moment  only
108              one  codec  can  be specified. Choose from the following codecs:
109              OPUS, SPEEX, GSM, S16 (uncompressed signed 16 bit), RAW  (uncom‐
110              pressed 32 bit floats).
111
112   USERS and PASSWORDS sections
113       All users must be specified in the USERS section. Usernames are totally
114       arbitrary but typically the callsign is used. The  purpose  is  to  map
115       each  username  to  a  password.  However,  the  password  is not given
116       directly but instead a reference to the  PASSWORDS  section  is  given.
117       It's done like this so that multiple nodes can share a single password.
118
119       An  example  of  how the USERS and PASSWORDS sections may look is given
120       below.
121
122         [USERS]
123         SM0ABC-1=MyNodes
124         SM0ABC-2=MyNodes
125         SM1XYZ=SM1XYZ
126
127         [PASSWORDS]
128         MyNodes="A very strong password!"
129         SM1XYZ="Another very good password?"
130
131       This will set up SM0ABC-1 and SM0ABC-2 to use the same password  speci‐
132       fied  by  MyNodes  in  the  PASSWORDS section. User SM1XYZ have his own
133       password.
134

FILES

136       /etc/svxlink/svxreflector.conf
137              The system wide configuration file.
138
139       ~/.svxlink/svxreflector.conf
140              Per user configuration file.
141
142       /etc/svxlink/svxreflector.d/*
143              Additional configuration files. This directory is setup  by  the
144              CFG_DIR configuration variable.
145

AUTHOR

147       Tobias Blomberg (SM0SVX) <sm0svx at users dot sourceforge dot net>
148

SEE ALSO

150       svxreflector(1), svxlink(1), svxlink.conf(5),
151
152
153
154Linux                              OCT 2017               SVXREFLECTOR.CONF(5)
Impressum