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 section "mysql selector"
160 #~~~~~~~~~~~~~~~~~~~~~~~
163 option "mysql_host" -
164 #~~~~~~~~~~~~~~~~~~~~
168 string typestr="ip or hostname"
172 option "mysql_port" -
173 #~~~~~~~~~~~~~~~~~~~~
175 "where mysql is listening"
177 int typestr="portnumber"
182 option "mysql_user" -
183 #~~~~~~~~~~~~~~~~~~~~
185 "default value: username from /etc/passwd"
187 string typestr="username"
190 option "mysql_passwd" -
191 #~~~~~~~~~~~~~~~~~~~~~~
198 option "mysql_database" -
199 #~~~~~~~~~~~~~~~~~~~~~~~~
201 "name of mysql database"
207 option "mysql_audio_file_dir" -
208 #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
210 "dir to search for audio files (required)"
212 string typestr="dirname"
215 option "mysql_default_score" -
216 #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
218 "scoring rule to use if stream definition
219 does not contain explicit score definition"
222 default="(LASTPLAYED() / 1440 - 1000 / (LASTPLAYED() + 1) - sqrt(NUMPLAYED()))"
228 section "random selector"
229 #~~~~~~~~~~~~~~~~~~~~~~~~
232 option "random_dir" -
233 #~~~~~~~~~~~~~~~~~~~~
235 "dir to search for audio files"
236 string typestr="dirname"
237 default="/home/music"
243 section "http sender"
244 #~~~~~~~~~~~~~~~~~~~~
250 "tcp port for http streaming"
252 int typestr="portnumber"
256 option "http_default_deny" -
257 #~~~~~~~~~~~~~~~~~~~~~~~~~~~
259 "deny connections from hosts which are not
264 option "http_access" -
265 #~~~~~~~~~~~~~~~~~~~~~
267 "Add given host/network to access control
268 list (whitelist if http_default_deny was
269 given, blacklist otherwise) before opening
270 the tcp port. This option can be given
271 multiple times. Example: '192.168.0.0/24'
272 whitelists/blacklists the 256 hosts
275 string typestr="a.b.c.d/n"
279 option "http_no_autostart" -
280 #~~~~~~~~~~~~~~~~~~~~~~~~~~~
282 "do not open tcp port on server startup"
286 option "http_max_clients" -
287 #~~~~~~~~~~~~~~~~~~~~~~~~~~
289 "maximal simultaneous connections,
290 non-positive value means unlimited"
299 section "dccp sender"
300 #~~~~~~~~~~~~~~~~~~~~
306 "port for dccp streaming"
308 int typestr="portnumber"
315 section "ortp sender"
316 #~~~~~~~~~~~~~~~~~~~~
318 option "ortp_target" -
319 #~~~~~~~~~~~~~~~~~~~~~
321 "Add given host/port to the list of targets.
322 This option can be given multiple times.
323 Example: '224.0.1.38:1500' instructs the ortp
324 sender to send to udp port 1500 on host
325 224.0.1.38 (unassigned ip in the Local
326 Network Control Block 224.0.0/24). This is
327 useful for LAN-streaming."
329 string typestr="a.b.c.d:p"
333 option "ortp_no_autostart" -
334 #~~~~~~~~~~~~~~~~~~~~~~~~~~~
336 "do not start to send automatically"
340 option "ortp_default_port" -
341 #~~~~~~~~~~~~~~~~~~~~~~~~~~~
343 "default udp port if not specified"
345 int typestr="portnumber"
349 option "ortp_header_interval" H
350 #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
352 "time between extra header sends"
354 int typestr="milliseconds"
358 option "ortp_jitter_compensation" j
359 #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
361 "non-zero values enable ortp's adaptive
364 int typestr="milliseconds"