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 'username'. 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 'username'.
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="groupname"
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 "audio file sender"
98 #~~~~~~~~~~~~~~~~~~~~~~~~~~
104 "start playing on startup"
108 option "announce_time" A
109 #~~~~~~~~~~~~~~~~~~~~~~~
111 "Delay betweeen announcing the stream and sending data"
113 int typestr="milliseconds"
123 string typestr="name"
128 section "mysql selector:"
129 #~~~~~~~~~~~~~~~~~~~~~~~~
132 option "mysql_host" -
133 #~~~~~~~~~~~~~~~~~~~~
137 string typestr="ip or hostname"
141 option "mysql_port" -
142 #~~~~~~~~~~~~~~~~~~~~
144 "where mysql is listening"
146 int typestr="portnumber"
151 option "mysql_user" -
152 #~~~~~~~~~~~~~~~~~~~~
154 "default value: username from /etc/passwd"
156 string typestr="username"
159 option "mysql_passwd" -
160 #~~~~~~~~~~~~~~~~~~~~~~
167 option "mysql_database" -
168 #~~~~~~~~~~~~~~~~~~~~~~~~
170 "name of mysql database"
176 option "mysql_audio_file_dir" -
177 #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
179 "dir to search for audio files (required)"
181 string typestr="dirname"
184 option "mysql_default_score" -
185 #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
187 "scoring rule to use if stream definition
188 does not contain explicit score definition"
191 default="(LASTPLAYED() / 1440 - 1000 / (LASTPLAYED() + 1) - sqrt(NUMPLAYED()))"
197 section "random selector"
198 #~~~~~~~~~~~~~~~~~~~~~~~~
201 option "random_dir" -
202 #~~~~~~~~~~~~~~~~~~~~
204 "dir to search for audio files"
205 string typestr="dirname"
206 default="/home/music"
212 section "http sender"
213 #~~~~~~~~~~~~~~~~~~~~
219 "tcp port for http streaming"
221 int typestr="portnumber"
225 option "http_default_deny" -
226 #~~~~~~~~~~~~~~~~~~~~~~~~~~~
228 "deny connections from hosts which are not
233 option "http_access" -
234 #~~~~~~~~~~~~~~~~~~~~~
236 "Add given host/network to access control
237 list (whitelist if http_default_deny was
238 given, blacklist otherwise) before opening
239 the tcp port. This option can be given
240 multiple times. Example: '192.168.0.0/24'
241 whitelists/blacklists the 256 hosts
244 string typestr="a.b.c.d/n"
248 option "http_no_autostart" -
249 #~~~~~~~~~~~~~~~~~~~~~~~~~~~
251 "do not open tcp port on server startup"
255 option "http_max_clients" -
256 #~~~~~~~~~~~~~~~~~~~~~~~~~~
258 "maximal simultaneous connections,
259 non-positive value means unlimited"
268 section "dccp sender"
269 #~~~~~~~~~~~~~~~~~~~~
275 "port for dccp streaming"
277 int typestr="portnumber"
284 section "ortp sender"
285 #~~~~~~~~~~~~~~~~~~~~
287 option "ortp_target" -
288 #~~~~~~~~~~~~~~~~~~~~~
290 "Add given host/port to the list of targets.
291 This option can be given multiple times.
292 Example: '224.0.1.38:1500' instructs the ortp
293 sender to send to udp port 1500 on host
294 224.0.1.38 (unassigned ip in the Local
295 Network Control Block 224.0.0/24). This is
296 useful for LAN-streaming."
298 string typestr="a.b.c.d:p"
302 option "ortp_no_autostart" -
303 #~~~~~~~~~~~~~~~~~~~~~~~~~~~
305 "do not start to send automatically"
309 option "ortp_default_port" -
310 #~~~~~~~~~~~~~~~~~~~~~~~~~~~
312 "default udp port if not specified"
314 int typestr="portnumber"
318 option "ortp_header_interval" H
319 #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
321 "time between extra header sends"
323 int typestr="milliseconds"
327 option "ortp_jitter_compensation" j
328 #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
330 "non-zero values enable ortp's adaptive
333 int typestr="milliseconds"