|
a/doc/upmpdcli-config.txt |
|
b/doc/upmpdcli-config.txt |
|
|
1 |
== Upmpdcli configuration
|
|
|
2 |
|
| 1 |
=== Upmpdcli general parameters
|
3 |
=== Upmpdcli general parameters
|
| 2 |
|
4 |
|
| 3 |
[[logfilename]]
|
5 |
[[logfilename]]
|
| 4 |
logfilename:: Log file
|
6 |
logfilename:: Log file
|
| 5 |
name. Defaults to stderr. This can also be specified as -d
|
7 |
name. Defaults to stderr. This can also be specified as -d
|
|
... |
|
... |
| 257 |
msfriendlyname:: Friendly name for the
|
259 |
msfriendlyname:: Friendly name for the
|
| 258 |
Media Server (if enabled). The default is to append
|
260 |
Media Server (if enabled). The default is to append
|
| 259 |
"-mediaserver" to the friendlyname value.
|
261 |
"-mediaserver" to the friendlyname value.
|
| 260 |
|
262 |
|
| 261 |
[[plgmicrohttpport]]
|
263 |
[[plgmicrohttpport]]
|
| 262 |
plgmicrohttpport:: IP port for the
|
264 |
plgmicrohttpport:: IP
|
| 263 |
tidal/qobuz/gmusic local HTTP service. The URLs for tracks
|
265 |
port for the tidal/qobuz/gmusic local HTTP service. The
|
| 264 |
streamed from these services point to a local microhttpd server running on
|
266 |
URLs for tracks streamed from these services point to a local microhttpd
|
| 265 |
this port (it uses redirection to the actual service URL when
|
267 |
server running on this port (it uses redirection to the actual service
|
| 266 |
actually streaming). The default is 49149.
|
268 |
URL when actually streaming). The default is 49149.
|
| 267 |
|
269 |
|
| 268 |
=== Tidal streaming service parameters
|
270 |
=== Tidal streaming service parameters
|
| 269 |
|
271 |
|
| 270 |
[[tidaluser]]
|
272 |
[[tidaluser]]
|
| 271 |
tidaluser:: Tidal user name. Your Tidal login name.
|
273 |
tidaluser:: Tidal user name. Your Tidal login name.
|
|
... |
|
... |
| 321 |
directories This is a space-separated list of directories
|
323 |
directories This is a space-separated list of directories
|
| 322 |
to explore for music files. This is used directly as the recoll "topdirs"
|
324 |
to explore for music files. This is used directly as the recoll "topdirs"
|
| 323 |
value, so you can use double-quote quoting for paths with embedded
|
325 |
value, so you can use double-quote quoting for paths with embedded
|
| 324 |
spaces.
|
326 |
spaces.
|
| 325 |
|
327 |
|
|
|
328 |
[[uprcltitle]]
|
|
|
329 |
uprcltitle:: Plugin Title. This
|
|
|
330 |
will be displayed as the plugin entry in the Media Server root
|
|
|
331 |
directory.
|
|
|
332 |
|
| 326 |
[[uprclhostport]]
|
333 |
[[uprclhostport]]
|
| 327 |
uprclhostport:: HTTP host and ports for
|
334 |
uprclhostport:: HTTP host and port for
|
| 328 |
serving media files The Media Server HTTP server will run
|
335 |
serving media files The Media Server HTTP server will run
|
| 329 |
on this address and port, which will also be inserted on the URLs we
|
336 |
on this address and port, which will also be inserted on the URLs we
|
| 330 |
produce. If the variable is not set, we will use port 9090 and the first
|
337 |
produce. If the variable is not set, we will use port 9090 and the first
|
| 331 |
non-loopback ipv4 address in "ip addr" output, which may be right or
|
338 |
non-loopback ipv4 address in "ip addr" output, which may be right or
|
| 332 |
not. Example: 192.168.1.1:9090
|
339 |
not. Example: 192.168.1.1:9090
|
| 333 |
|
340 |
|
| 334 |
[[uprclpaths]]
|
341 |
[[uprclpaths]]
|
| 335 |
uprclpaths:: This is used
|
342 |
uprclpaths:: Path translations. Translations from real paths to ones relative to the HTTP server
|
| 336 |
to translate real path to ones relative to the HTTP server doc tree. It
|
343 |
doc tree. If this is not set, uprcl will use a null translation for each
|
| 337 |
also performs a form of access control. If this is not set, uprcl will
|
344 |
of the uprclmediadirs entries.
|
| 338 |
use a null translation for each of the uprclmediadirs
|
|
|
| 339 |
entries.
|
|
|
| 340 |
|
345 |
|
| 341 |
[[uprclconfdir]]
|
346 |
[[uprclconfdir]]
|
| 342 |
uprclconfdir:: Recoll index
|
347 |
uprclconfdir:: Recoll index
|
| 343 |
directory This is usually not defined and defaults to
|
348 |
directory This is usually not defined and defaults to
|
| 344 |
/var/cache/upmpdcli/uprcl
|
349 |
/var/cache/upmpdcli/uprcl
|
|
... |
|
... |
| 346 |
[[uprclautostart]]
|
351 |
[[uprclautostart]]
|
| 347 |
uprclautostart:: Initialize uprcl as soon as
|
352 |
uprclautostart:: Initialize uprcl as soon as
|
| 348 |
upmpdcli starts This is useful because uprcl initialization
|
353 |
upmpdcli starts This is useful because uprcl initialization
|
| 349 |
can take quite some time so it is better not to wait for the first
|
354 |
can take quite some time so it is better not to wait for the first
|
| 350 |
access. The general default is false for the autostart variables, so this
|
355 |
access. The general default is false for the autostart variables, so this
|
| 351 |
is normally explicitely set to true.
|
356 |
needs to be explicitely set to true.
|
| 352 |
|
357 |
|
| 353 |
=== Songcast Receiver parameters
|
358 |
=== Songcast Receiver parameters
|
| 354 |
|
359 |
|
| 355 |
[[sclogfilename]]
|
360 |
[[sclogfilename]]
|
| 356 |
sclogfilename:: Log file name for sc2mpd (default
|
361 |
sclogfilename:: Log file name for sc2mpd (default
|
|
... |
|
... |
| 399 |
location is not in the $PATH for the init scripts.
|
404 |
location is not in the $PATH for the init scripts.
|
| 400 |
|
405 |
|
| 401 |
=== Songcast Sender parameters
|
406 |
=== Songcast Sender parameters
|
| 402 |
|
407 |
|
| 403 |
[[scsenderpath]]
|
408 |
[[scsenderpath]]
|
| 404 |
scsenderpath:: Path to the script
|
409 |
scsenderpath:: Path to starter script This is normally scmakempdsender which starts the auxiliary mpd
|
| 405 |
(scmakempdsender) which starts the auxiliary mpd and the sender
|
410 |
and the sender process. Empty and searched in the PATH by
|
| 406 |
process. Empty and searched in PATH by default.
|
411 |
default.
|
| 407 |
|
412 |
|
| 408 |
[[scstreamscaled]]
|
413 |
[[scstreamscaled]]
|
| 409 |
scstreamscaled:: Decide if we
|
414 |
scstreamscaled:: Scale the
|
| 410 |
scale the songcast stream. If set, MPD software volume
|
415 |
Songcast stream. If set, MPD software volume control will
|
| 411 |
control will be applied to the stream. True by default: using a Control
|
416 |
be applied to the stream. True by default: using a Control Point to set
|
| 412 |
Point to set the volume on the upmpdcli instance which started the Sender
|
417 |
the volume on the upmpdcli instance which started the Sender affects the
|
| 413 |
affects the volume for all Receivers.
|
418 |
volume for all Receivers.
|
| 414 |
|
419 |
|
| 415 |
[[scsendermpdport]]
|
420 |
[[scsendermpdport]]
|
| 416 |
scsendermpdport:: localhost port to be used by the auxiliary mpd.
|
421 |
scsendermpdport:: localhost port to be used by the auxiliary mpd.
|
| 417 |
|
422 |
|
| 418 |
[[scripts_dir]]
|
423 |
[[scripts_dir]]
|
| 419 |
scripts_dir:: Location for the scripts used
|
424 |
scripts_dir:: External sources script
|
|
|
425 |
directory. Location for the scripts used to set up
|
| 420 |
to set up additional external sources. See the Songcast
|
426 |
additional external sources. See the Songcast Sender support
|
| 421 |
Sender support documentation page.
|
427 |
documentation page.
|
| 422 |
|
428 |
|
| 423 |
|
429 |
|