1 section "General options"
2 #~~~~~~~~~~~~~~~~~~~~~~~~
18 int typestr="portnumber"
25 "run as background daemon"
32 "run as user 'name'. para_server does not
33 need any special privileges. If started as
34 root (EUID == 0) this option must be given at
35 the command line (not in the configuration
36 file) so that para_server can drop the root
37 privileges right after parsing the command
38 line options, but before parsing the
39 configuration file. In this case,
40 real/effective/saved UID are all set to the
41 UID of 'name'. As the configuration file
42 is read afterwards, those options that have a
43 default value depending on the UID (e.g. the
44 directory for the configuration file) are
45 computed by using the uid of 'name'.
46 This option has no effect if para_server is
47 started as a non-root user (i.e. EUID != 0)"
56 "set group id to according to 'group'. This
57 option is silently ignored if EUID != 0.
58 Otherwise, real/effective GID and the saved
59 set-group ID are all set to the GID given by
60 'group'. Must not be given in the config file."
62 string typestr="group"
67 section "Configuration files"
68 #~~~~~~~~~~~~~~~~~~~~~~~~~~~~
74 "(default=stdout/stderr)"
76 string typestr="filename"
79 option "config_file" c
80 #~~~~~~~~~~~~~~~~~~~~~
82 "(default='~/.paraslash/server.conf'"
84 string typestr="filename"
90 "(default='~/.paraslash/server.users')"
92 string typestr="filename"
97 section "virtual streaming system"
98 #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
104 "start playing on startup"
108 option "autoplay_delay" -
109 #~~~~~~~~~~~~~~~~~~~~~~~~
110 "Time to wait before autoplay starts. Ignored if
112 int typestr="milliseconds"
117 option "announce_time" A
118 #~~~~~~~~~~~~~~~~~~~~~~~
120 "Delay betweeen announcing the stream and sending data"
122 int typestr="milliseconds"
132 string typestr="name"
135 #############################
136 section "audio file selector"
137 #############################
139 option "afs_database_dir" D
140 #~~~~~~~~~~~~~~~~~~~~~~~~~~
142 "Directory containing the osl database of the
144 (default='~/.paraslash/afs_database'"
146 string typestr="path"
150 option "afs_socket" s
151 #~~~~~~~~~~~~~~~~~~~~
153 "Command socket for the audio file selector"
155 string typestr="path"
156 default="/var/paraslash/afs_command_socket"
162 "Mood to load on startup."
164 string typestr="mood_name"
170 "Playlist to load on startup. Ignored if
171 --mood is given as well."
173 string typestr="playlist_name"
176 section "mysql selector"
177 #~~~~~~~~~~~~~~~~~~~~~~~
180 option "mysql_host" -
181 #~~~~~~~~~~~~~~~~~~~~
185 string typestr="ip or hostname"
189 option "mysql_port" -
190 #~~~~~~~~~~~~~~~~~~~~
192 "where mysql is listening"
194 int typestr="portnumber"
199 option "mysql_user" -
200 #~~~~~~~~~~~~~~~~~~~~
202 "default value: username from /etc/passwd"
204 string typestr="username"
207 option "mysql_passwd" -
208 #~~~~~~~~~~~~~~~~~~~~~~
215 option "mysql_database" -
216 #~~~~~~~~~~~~~~~~~~~~~~~~
218 "name of mysql database"
224 option "mysql_audio_file_dir" -
225 #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
227 "dir to search for audio files (required)"
229 string typestr="dirname"
232 option "mysql_default_score" -
233 #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
235 "scoring rule to use if stream definition
236 does not contain explicit score definition"
239 default="(LASTPLAYED() / 1440 - 1000 / (LASTPLAYED() + 1) - sqrt(NUMPLAYED()))"
245 section "random selector"
246 #~~~~~~~~~~~~~~~~~~~~~~~~
249 option "random_dir" -
250 #~~~~~~~~~~~~~~~~~~~~
252 "dir to search for audio files"
253 string typestr="dirname"
254 default="/home/music"
260 section "http sender"
261 #~~~~~~~~~~~~~~~~~~~~
267 "tcp port for http streaming"
269 int typestr="portnumber"
273 option "http_default_deny" -
274 #~~~~~~~~~~~~~~~~~~~~~~~~~~~
276 "deny connections from hosts which are not
281 option "http_access" -
282 #~~~~~~~~~~~~~~~~~~~~~
284 "Add given host/network to access control
285 list (whitelist if http_default_deny was
286 given, blacklist otherwise) before opening
287 the tcp port. This option can be given
288 multiple times. Example: '192.168.0.0/24'
289 whitelists/blacklists the 256 hosts
292 string typestr="a.b.c.d/n"
296 option "http_no_autostart" -
297 #~~~~~~~~~~~~~~~~~~~~~~~~~~~
299 "do not open tcp port on server startup"
303 option "http_max_clients" -
304 #~~~~~~~~~~~~~~~~~~~~~~~~~~
306 "maximal simultaneous connections,
307 non-positive value means unlimited"
316 section "dccp sender"
317 #~~~~~~~~~~~~~~~~~~~~
323 "port for dccp streaming"
325 int typestr="portnumber"
332 section "ortp sender"
333 #~~~~~~~~~~~~~~~~~~~~
335 option "ortp_target" -
336 #~~~~~~~~~~~~~~~~~~~~~
338 "Add given host/port to the list of targets.
339 This option can be given multiple times.
340 Example: '224.0.1.38:1500' instructs the ortp
341 sender to send to udp port 1500 on host
342 224.0.1.38 (unassigned ip in the Local
343 Network Control Block 224.0.0/24). This is
344 useful for LAN-streaming."
346 string typestr="a.b.c.d:p"
350 option "ortp_no_autostart" -
351 #~~~~~~~~~~~~~~~~~~~~~~~~~~~
353 "do not start to send automatically"
357 option "ortp_default_port" -
358 #~~~~~~~~~~~~~~~~~~~~~~~~~~~
360 "default udp port if not specified"
362 int typestr="portnumber"
366 option "ortp_header_interval" H
367 #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
369 "time between extra header sends"
371 int typestr="milliseconds"
375 option "ortp_jitter_compensation" j
376 #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
378 "non-zero values enable ortp's adaptive
381 int typestr="milliseconds"