1 #########################
2 section "General options"
3 #########################
12 Larger values mean less verbose output. Loglevel 1 (debug) gets
13 really noisy; a value of 2 (info) produces still noisy output,
14 but this won't fill up the disk quicky. Messaged logged with
15 loglevel 3 (notice) indicate normal but significant events
16 while level 4 (warning) logs unexpected events that can be
17 handled. Unhandled error conditions are logged with loglevel
18 5 (error) and crititcal errors are logged using loglevel 6
19 (crit). Finally, loglevel 7 (emerg) is reserved for messages
20 that cause para_server to terminate immediately.
26 int typestr="portnumber"
30 para_server listens on this tcp port for incoming connections
31 from clients such as para_client. If the default port is
32 changed, the corresponding option of para_client must be used
33 to connect to para_server.
38 "run as background daemon"
42 Note that para_server refuses to start in daemon mode if no
43 logfile was specified.
48 "run as the given user"
52 para_server does not need any special privileges. If started
53 as root (EUID == 0) this option must be given at the command
54 line (not in the configuration file) so that para_server
55 can drop the root privileges right after parsing the command
56 line options, but before parsing the configuration file. In
57 this case, real/effective/saved UID are all set to the UID
58 of 'name'. As the configuration file is read afterwards,
59 those options that have a default value depending on the UID
60 (e.g. the directory for the configuration file) are computed
61 by using the uid of 'name'. This option has no effect if
62 para_server is started as a non-root user (i.e. EUID != 0)
69 string typestr="group"
72 This option sets the group id according to 'group'. This option
73 is silently ignored if EUID != 0. Otherwise, real/effective
74 GID and the saved set-group ID are all set to the GID given by
75 'group'. Must not be given in the config file.
78 #############################
79 section "Configuration files"
80 #############################
85 "where to write log output"
86 string typestr="filename"
89 If this option is not given, para_server writes the log
93 option "config_file" c
94 #~~~~~~~~~~~~~~~~~~~~~
95 "(default='~/.paraslash/server.conf'"
96 string typestr="filename"
99 para_server reads its config file right after parsing
100 the options that were given at the command line. If an
101 option is given both at the command line and in the
102 config file, the value that was specified at the command line
108 "(default='~/.paraslash/server.users')"
110 string typestr="filename"
114 ##################################
115 section "virtual streaming system"
116 ##################################
121 "start playing on startup"
124 option "autoplay_delay" -
125 #~~~~~~~~~~~~~~~~~~~~~~~~
126 "time to wait before streaming"
132 If para_server is started with the autoplay option, this option
133 may be used to set up a delay before para_server streams its
134 first audio file. This is useful for example if para_server
135 and para_audiod are started during system startup. The delay
136 time should be choosen large enough so that para_audiod is
137 already up when para_server starts to stream. Of course, this
138 option depends on the autoplay option.
140 option "announce_time" A
141 #~~~~~~~~~~~~~~~~~~~~~~~
142 "grace time for clients"
148 Clients such as para_audiod connect to para_server and execute
149 the stat command to find out whether an audio stream is
150 currently available. This sets the delay betweeen announcing
151 the stream via the output of the stat command and sending
152 the first chunk of data.
155 #############################
156 section "audio file selector"
157 #############################
159 option "afs_database_dir" D
160 #~~~~~~~~~~~~~~~~~~~~~~~~~~
161 "location of the database"
162 string typestr="path"
165 Where para_server should look for the osl database of the audio
166 file selector. The default is '~/.paraslash/afs_database'.
169 option "afs_socket" s
170 #~~~~~~~~~~~~~~~~~~~~
171 "Command socket for afs"
172 string typestr="path"
173 default="/var/paraslash/afs_command_socket"
176 For each server command that is handled by the audio file
177 selector, the child process of para_server connects to the
178 audio file selector via a local socket. This option specifies
179 the location of that socket in the file system.
181 option "afs_initial_mode" i
182 #~~~~~~~~~~~~~~~~~~~~~~~~~~
184 "Mood or playlist to load on startup."
185 string typestr="<specifier>/<name>"
189 The argument of this option must be prefixed with either 'p/'
190 or 'm/' to indicate whether a playlist or a mood should be
192 --afs_initial_mode p/foo
193 loads the playlist named 'foo'.
196 #####################
197 section "http sender"
198 #####################
203 "tcp port for http streaming"
204 int typestr="portnumber"
208 The http sender of para_server listens on this port for
209 incoming connections. Clients are expected to send the usual
210 http request message such as 'GET / HTTP/'.
213 option "http_default_deny" -
214 #~~~~~~~~~~~~~~~~~~~~~~~~~~~
215 "make the http ACL a whitelist"
218 The default is to use blacklists instead, i.e. connections
219 to the http sender are allowed unless the connecting host
220 matches a pattern given by a http_access option. This allows
221 to use access control the other way round: Connections are
222 denied from hosts which are not explicitly allowed by one or
223 more http_access options.
226 option "http_access" -
227 #~~~~~~~~~~~~~~~~~~~~~
228 "add an entry to the http ACL"
229 string typestr="a.b.c.d/n"
233 Add given host/network to access control list (whitelist if
234 http_default_deny was given, blacklist otherwise) before
235 opening the tcp port. This option can be given multiple
236 times. Example: '192.168.0.0/24' whitelists/blacklists the
237 256 hosts 192.168.0.x
240 option "http_no_autostart" -
241 #~~~~~~~~~~~~~~~~~~~~~~~~~~~
242 "do not open tcp port on startup"
245 If this option is given, the http sender does not listen on
246 its tcp port. It may be instructed to open this port at a
247 later time by using the sender command.
250 option "http_max_clients" -
251 #~~~~~~~~~~~~~~~~~~~~~~~~~~
252 "maximal number of connections"
257 The http sender will refuse connections if already that number
258 of clients are currently connected. A non-positive value
259 (the default) allows an unlimited number of simultaneous
263 #####################
264 section "dccp sender"
265 #####################
270 "port for dccp streaming"
271 int typestr="portnumber"
275 See http_port for details.
278 option "dccp_default_deny" -
279 #~~~~~~~~~~~~~~~~~~~~~~~~~~~
280 "make the dccp ACL a whitelist"
283 See http_default_deny for details.
286 option "dccp_access" -
287 #~~~~~~~~~~~~~~~~~~~~~
288 "add an entry to the dccp ACL"
289 string typestr="a.b.c.d/n"
293 See http_access for details.
296 option "dccp_max_clients" -
297 #~~~~~~~~~~~~~~~~~~~~~~~~~~
298 "maximal number of connections"
303 See http_max_clients for details.
310 option "udp_target" -
311 #~~~~~~~~~~~~~~~~~~~~
313 string typestr="a.b.c.d:p"
317 Add given host/port to the list of targets. This option
318 can be given multiple times. Example: '224.0.1.38:1500'
319 instructs the udp sender to send to udp port 1500 on host
320 224.0.1.38 (unassigned ip in the Local Network Control Block
321 224.0.0/24). This is useful for multicast streaming.
324 option "udp_no_autostart" -
325 #~~~~~~~~~~~~~~~~~~~~~~~~~~
326 "do not start sending"
329 If this option is given, udp streaming may be activated at
330 a later time by using the sender command.
333 option "udp_default_port" -
334 #~~~~~~~~~~~~~~~~~~~~~~~~~~
335 "udp port to send to"
340 option "udp_header_interval" H
341 #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
342 "duration for sending header"
347 As the udp sender has no idea about connected clients it
348 sends the audio file header periodically if necessary. This
349 option is used to specify the duration of the interval between
350 sending the header. Shorter values decrease the average time
351 clients have to wait before being able to start playback,
352 but this also increases the amount network traffic. Note
353 that this affects only ogg vorbis streams as this is the only
354 audio format that needs an audio file header.
359 "set time to live value"
364 This option instructs the udp sender to set the time to live to
365 \"num\" for the sending udp socket. Only useful for multicast