Open Source Projects Europe

[[logfilename]]

logfilename:: Log file

name. Defaults to stderr. This can also be specified as -d

logfilename.

[[loglevel]]

loglevel:: Log

level. Can also be specified as -l loglevel.

[[pkgdatadir]]

pkgdatadir:: XML and other constant data storage

directory. Default: '$prefix/share/upmpcli' (e.g.:

'/usr/share/upmpdcli').

[[pidfile]]

pidfile:: Name of lock file used to store the

current process pid. Only used if the process is launched

by user root. Used by the init system, and to avoid multiple

instances. The only reason to change the value is if you actually want to

have several instances running (also change cachedir in this

case).

=== UPnP network parameters 

[[upnpiface]]

upnpiface:: Network interface to

use for UPnP. libupnp/pupnp only supports communicating on

a single interface and will use the first found, this allows forcing the

use of another interface.

[[upnpip]]

upnpip:: IP address to use for UPnP,

alternative to using an interface name. 

[[upnpport]]

upnpport:: Port number

used for UPnP. libupnp/pupnp defaults to using the first

free port after 49152. Note that clients do not need to know about the

value, which is automatically discovered.

=== Media Renderer parameters 

=== Media Server general parameters 

[[msfriendlyname]]

msfriendlyname:: Friendly name for the

Media Server (if enabled). The default is to append

"-mediaserver" to the friendlyname value.

[[plgmicrohttpport]]

plgmicrohttpport:: IP port for the

tidal/qobuz/gmusic local HTTP service. The URLs for tracks

streamed from these services point to a local microhttpd server running on

this port (it uses redirection to the actual service URL when

actually streaming). The default is 49149.

=== Tidal streaming service parameters 

[[tidaluser]]

tidaluser:: Tidal user name. Your Tidal login name.

[[tidalpass]]

tidalpass:: Tidal password. The password for your Tidal account.

[[tidalquality]]

tidalquality:: Tidal stream quality. 'low' and 'high' are aac

streams. 'lossless' is FLAC and will only work if your subscription

allows it.

=== Qobuz streaming service parameters 

[[qobuzuser]]

qobuzuser:: Qobuz user name. Your Qobuz login name.

[[qobuzpass]]

qobuzpass:: Qobuz password. The password for your Qobuz account.

[[qobuzformatid]]

qobuzformatid:: Qobuz stream quality. 5 for mp3/320, 7 for FLAC if

your subscription allows it.

=== Google Music streaming service parameters 

[[gmusicuser]]

gmusicuser:: Google Music user name. Your Google Music login name (probably a gmail address).

[[gmusicpass]]

gmusicpass:: Google Music password. The password for your Google Music account.

[[gmusicquality]]

gmusicquality:: Google Music stream quality. 'hi' for mp3/320, 'med'

for mp3/160, 'low' for mp3/128.

[[gmusicdeviceid]]

gmusicdeviceid:: Google Music device

id. Your system MAC address will be used by default, but

this will count against the maximum count of registered devices for this

account.  You can set the gmusicdeviceid value to the device ID from a

phone or tablet on which you also use Google Play Music.

=== Local Media Server parameters 

[[uprcluser]]

uprcluser:: Bogus user name variable. Used for consistency with other Media Server plugins to decide if

the service should be started (so, do set it if you want a Media Server).

[[uprclmediadirs]]

uprclmediadirs:: Media

directories This is a space-separated list of directories

to explore for music files. This is used directly as the recoll "topdirs"

value, so you can use double-quote quoting for paths with embedded

spaces.

[[uprclhostport]]

uprclhostport:: HTTP host and ports for

serving media files The Media Server HTTP server will run

on this address and port, which will also be inserted on the URLs we

produce. If the variable is not set, we will use port 9090 and the first

non-loopback ipv4 address in "ip addr" output, which may be right or

not. Example: 192.168.1.1:9090

[[uprclpaths]]

uprclpaths::  This is used

to translate real path to ones relative to the HTTP server doc tree. It

also performs a form of access control. If this is not set, uprcl will

use a null translation for each of the uprclmediadirs

entries.

[[uprclconfdir]]

uprclconfdir:: Recoll index

directory This is usually not defined and defaults to

/var/cache/upmpdcli/uprcl

[[uprclautostart]]

uprclautostart:: Initialize uprcl as soon as

upmpdcli starts This is useful because uprcl initialization

can take quite some time so it is better not to wait for the first

access. The general default is false for the autostart variables, so this

is normally explicitely set to true.