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"
159 option "afs_initial_mode" i
160 #~~~~~~~~~~~~~~~~~~~~~~~~~~
162 "Mood or playlist to load on startup. Must be
163 prefixed with either 'p:' or 'm:' to indicate
164 whether a playlist or a mood should be
166 --afs_initial_mode p:foo
167 loads the playlist named 'foo'."
169 string typestr="name"
172 section "mysql selector"
173 #~~~~~~~~~~~~~~~~~~~~~~~
176 option "mysql_host" -
177 #~~~~~~~~~~~~~~~~~~~~
181 string typestr="ip or hostname"
185 option "mysql_port" -
186 #~~~~~~~~~~~~~~~~~~~~
188 "where mysql is listening"
190 int typestr="portnumber"
195 option "mysql_user" -
196 #~~~~~~~~~~~~~~~~~~~~
198 "default value: username from /etc/passwd"
200 string typestr="username"
203 option "mysql_passwd" -
204 #~~~~~~~~~~~~~~~~~~~~~~
211 option "mysql_database" -
212 #~~~~~~~~~~~~~~~~~~~~~~~~
214 "name of mysql database"
220 option "mysql_audio_file_dir" -
221 #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
223 "dir to search for audio files (required)"
225 string typestr="dirname"
228 option "mysql_default_score" -
229 #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
231 "scoring rule to use if stream definition
232 does not contain explicit score definition"
235 default="(LASTPLAYED() / 1440 - 1000 / (LASTPLAYED() + 1) - sqrt(NUMPLAYED()))"
241 section "random selector"
242 #~~~~~~~~~~~~~~~~~~~~~~~~
245 option "random_dir" -
246 #~~~~~~~~~~~~~~~~~~~~
248 "dir to search for audio files"
249 string typestr="dirname"
250 default="/home/music"
256 section "http sender"
257 #~~~~~~~~~~~~~~~~~~~~
263 "tcp port for http streaming"
265 int typestr="portnumber"
269 option "http_default_deny" -
270 #~~~~~~~~~~~~~~~~~~~~~~~~~~~
272 "deny connections from hosts which are not
277 option "http_access" -
278 #~~~~~~~~~~~~~~~~~~~~~
280 "Add given host/network to access control
281 list (whitelist if http_default_deny was
282 given, blacklist otherwise) before opening
283 the tcp port. This option can be given
284 multiple times. Example: '192.168.0.0/24'
285 whitelists/blacklists the 256 hosts
288 string typestr="a.b.c.d/n"
292 option "http_no_autostart" -
293 #~~~~~~~~~~~~~~~~~~~~~~~~~~~
295 "do not open tcp port on server startup"
299 option "http_max_clients" -
300 #~~~~~~~~~~~~~~~~~~~~~~~~~~
302 "maximal simultaneous connections,
303 non-positive value means unlimited"
312 section "dccp sender"
313 #~~~~~~~~~~~~~~~~~~~~
319 "port for dccp streaming"
321 int typestr="portnumber"
328 section "ortp sender"
329 #~~~~~~~~~~~~~~~~~~~~
331 option "ortp_target" -
332 #~~~~~~~~~~~~~~~~~~~~~
334 "Add given host/port to the list of targets.
335 This option can be given multiple times.
336 Example: '224.0.1.38:1500' instructs the ortp
337 sender to send to udp port 1500 on host
338 224.0.1.38 (unassigned ip in the Local
339 Network Control Block 224.0.0/24). This is
340 useful for LAN-streaming."
342 string typestr="a.b.c.d:p"
346 option "ortp_no_autostart" -
347 #~~~~~~~~~~~~~~~~~~~~~~~~~~~
349 "do not start to send automatically"
353 option "ortp_default_port" -
354 #~~~~~~~~~~~~~~~~~~~~~~~~~~~
356 "default udp port if not specified"
358 int typestr="portnumber"
362 option "ortp_header_interval" H
363 #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
365 "time between extra header sends"
367 int typestr="milliseconds"
371 option "ortp_jitter_compensation" j
372 #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
374 "non-zero values enable ortp's adaptive
377 int typestr="milliseconds"