path: root/doc/man/rygel.conf.xml

<?xml version='1.0' encoding='UTF-8'?>
<!-- This document was created with Syntext Serna Free. --><!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [

<!--

`xsltproc -''-nonet \
          -''-param man.charmap.use.subset "0" \
          -''-param make.year.ranges "1" \
          -''-param make.single.year.ranges "1" \
          /usr/share/xml/docbook/stylesheet/nwalsh/manpages/docbook.xsl \
          manpage.xml'

A manual page <package>.<section> will be generated. You may view the
manual page with: nroff -man <package>.<section> | less'. A typical entry
in a Makefile or Makefile.am is:

DB2MAN = /usr/share/sgml/docbook/stylesheet/xsl/nwalsh/manpages/docbook.xsl
XP     = xsltproc -''-nonet -''-param man.charmap.use.subset "0"

manpage.1: manpage.xml
        $(XP) $(DB2MAN) $<

The xsltproc binary is found in the xsltproc package. The XSL files are in
docbook-xsl. A description of the parameters you can use can be found in the
docbook-xsl-doc-* packages. Please remember that if you create the nroff
version in one of the debian/rules file targets (such as build), you will need
to include xsltproc and docbook-xsl in your Build-Depends control field.
Alternatively use the xmlto command/package. That will also automatically
pull in xsltproc and docbook-xsl.

Notes for using docbook2x: docbook2x-man does not automatically create the
AUTHOR(S) and COPYRIGHT sections. In this case, please add them manually as
<refsect1> ... </refsect1>.

To disable the automatic creation of the AUTHOR(S) and COPYRIGHT sections
read /usr/share/doc/docbook-xsl/doc/manpages/authors.html. This file can be
found in the docbook-xsl-doc-html package.

Validation can be done using: `xmllint -''-noout -''-valid manpage.xml`

General documentation about man-pages and man-page-formatting:
man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/

-->

  <!-- Fill in your name for FIRSTNAME and SURNAME. -->
  <!ENTITY dhfirstname "Jens">
  <!ENTITY dhsurname   "Georg">
  <!-- dhusername could also be set to "&firstname; &surname;". -->
  <!ENTITY dhusername  "Jens Georg">
  <!ENTITY dhemail     "mail@jensge.org">
  <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
       allowed: see man(7), man(1) and
       http://www.tldp.org/HOWTO/Man-Page/q2.html. -->
  <!ENTITY dhsection   "5">
  <!-- TITLE should be something like "User commands" or similar (see
       http://www.tldp.org/HOWTO/Man-Page/q2.html). -->
  <!ENTITY dhtitle     "Rygel User Manual">
  <!ENTITY dhucpackage "rygel.conf">
  <!ENTITY dhpackage   "rygel">
]>
<refentry>
  <refentryinfo>
    <title>&dhtitle;</title>
    <productname>&dhpackage;</productname>
    <authorgroup>
      <author>
        <firstname>&dhfirstname;</firstname>
        <surname>&dhsurname;</surname>
        <contrib>Wrote this manpage.</contrib>
        <address>
          <email>&dhemail;</email>
        </address>
      </author>
    </authorgroup>
  </refentryinfo>
  <refmeta>
    <refentrytitle>&dhucpackage;</refentrytitle>
    <manvolnum>&dhsection;</manvolnum>
  </refmeta>
  <refnamediv>
    <refname>&dhucpackage;</refname>
    <refpurpose>Rygel configuration file </refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>$XDG_CONFIG_DIR/rygel.conf</command>
    </cmdsynopsis>
    <cmdsynopsis>
      <command>/etc/rygel.conf</command>
    </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1 id="description">
    <title>DESCRIPTION</title>
    <para><command>&dhpackage;</command> reads its configuration values from
        the file <filename>$XDG_CONFIG_DIR/rygel.conf</filename> or a file given on command line with the <userinput>--config</userinput> option. If that file does not exist it uses the file
        <filename>/etc/rygel.conf</filename>.</para>
    <para>Most of the options may be overriden by commandline arguments or
        envronment variables. See <citerefentry>
        <refentrytitle>rygel</refentrytitle>
        <manvolnum>1</manvolnum>
      </citerefentry> for details on those.</para>
  </refsect1>
  <refsect1 id="options">
    <title>GENERAL DIRECTIVES</title>
    <para>Lists in the configuration files are separated by a semicolon
        (<userinput>;</userinput>). Boolean values may be either
        <userinput>true</userinput> or <userinput>false</userinput>.</para>
    <variablelist>
      <varlistentry>
        <term>
          <option>ipv6</option>
        </term>
        <listitem>
          <para>Set to <userinput>false</userinput> to disable binding to IPv6 addresses</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>interface=<replaceable>INTERFACE</replaceable></option>
        </term>
        <listitem>
          <para>Semicolon separated list separated of the network interfaces <application>&dhpackage;</application> should listen on. May be an IP, an interface name or on Linux even the ESSID of a wireless network.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>port=<replaceable>PORT</replaceable></option>
        </term>
        <listitem>
          <para>Set the listen-port.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>enable-transcoding</option>
        </term>
        <listitem>
          <para>Set to <userinput>true</userinput> to enable transcoding in
            general.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>log-level=<replaceable>DOMAIN</replaceable>:<replaceable>LEVEL</replaceable>[,<replaceable>DOMAIN</replaceable>:<replaceable>LEVEL</replaceable>,…]</option>
        </term>
        <listitem>
          <para>Comma-separated list of <replaceable>DOMAIN</replaceable>:<replaceable>LEVEL</replaceable> pairs, allowing to set the log level individually for each domain, where <replaceable>DOMAIN</replaceable> is eiher <userinput>&quot;*&quot;</userinput>, &quot;<userinput>rygel</userinput>&quot; or the name of a plugin. Allowed log levels are 1=error, 2=critical, 3=warning, 4=message/info,
            5=debug.
          Note that on recent versions of GLib (&gt;= 2.36) it is required to set the environment variable <envar>G_MESSAGES_DEBUG</envar> to <userinput>all</userinput> to get any debug output.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>plugin-path=<replaceable>PATH</replaceable></option>
        </term>
        <listitem>
          <para>Set the plugin search path.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>engine-path=<replaceable>PATH</replaceable></option>
        </term>
        <listitem>
          <para>Set the engine search path.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>media-engine=<replaceable>ENGINE</replaceable></option>
        </term>
        <listitem>
          <para>Name of the loadable module to use as media engine back-end.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>allow-upload</option>
        </term>
        <listitem>
          <para>Allow uploading of media files via UPnP.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>allow-deletion</option>
        </term>
        <listitem>
          <para>Allow remote media file deletion via UPnP.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>video-upload-folder</option>
        </term>
        <listitem>
          <para>If <option>allow-upload</option> is <userinput>true</userinput>, use this folder to store uploaded videos. It defaults to <userinput>@VIDEOS@</userinput> which expands to the default directory for video files (usually <filename><envar>$HOME</envar>/Videos</filename>).</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>music-upload-folder</option>
        </term>
        <listitem>
          <para>If <option>allow-upload</option> is <userinput>true</userinput>, use this folder to store uploaded music files. It defaults to <userinput>@MUSIC@</userinput> which expands to the default directory for music files (usually <filename><envar>$HOME</envar>/Music</filename>).</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>picture-upload-folder</option>
        </term>
        <listitem>
          <para>If <option>allow-upload</option> is <userinput>true</userinput>, use this folder to store uploaded pictures. It defaults to <userinput>@PICTURES@</userinput> which expands to the default directory for picture files (usually <filename><envar>$HOME</envar>/Pictures</filename>).</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>force-downgrade-for</option>
        </term>
        <listitem>
          <para>Semicolon-separated list of device user-agents (or parts thereof) which need a forced downgrade to <userinput>MediaServer:1</userinput> and/or <userinput>ContentDirectory:1</userinput>.</para>
          <para><warning>
              <para>Only use this parameter if you know what your&apos;re doing or are being told to do so; overriding the default value might cause incompatibilites. If you find that adding your device here enables its usage with Rygel, please  <ulink url="https://gitlab.gnome.org/GNOME/rygel/issues/new/?issuable_template=IOP">file an IOP bug</ulink> so we can include it into the default configuration.</para>
            </warning></para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>acl-fallback-policy</option>
        </term>
        <listitem>
            <para>This is the default policy that is used if no access control provider is found on the D-Bus. Use <userinput>true</userinput> to allow access from every peer, <userinput>false</userinput> to deny all access. If it is not specified, the default fall-back policy is <userinput>true</userinput>.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1>
    <title>Database settings</title>
    <para>The settings in the <code>[Database]</code>section are for the database support library. </para>
    <para><variablelist>
        <varlistentry>
          <term>
            <option>debug</option>
          </term>
          <listitem>
            <para>Set to <option>true</option> to show the SQL statements used.</para>
          </listitem>
        </varlistentry>
      </variablelist></para>
  </refsect1>
  <refsect1>
    <title>GStreamer Media Engine settings</title>
    <para>The settings in the <code>[GstMediaEngine]</code> section are specific to the GStreamer media engine, which is the default media engine. See the media-engine setting. These following options are available for the <ulink url="http://gstreamer.freedesktop.org">GStreamer</ulink> media engine.</para>
    <variablelist>
      <varlistentry>
        <term>
          <option>transcoders</option>
        </term>
        <listitem>
          <para>A semicolon-separated list of the active transcoders. This setting has no effect if <option>enable-transcoding</option> is set to <code>false</code>. Possible values are: <code>lpcm,mp3,mp2ts,aac,avc</code> or <code>wmv</code>. Its default value is <code>lpcm;mp3;mp2ts;aac;wmv</code>.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1>
    <title>Plugin-specific settings</title>
    <para>Sections for plugins are denoted with <option>[PluginName]</option>
      and can contain options specific to a plugin (see below)  as well these common options:
    </para>
    <variablelist>
      <varlistentry>
        <term><option>title</option>=<replaceable>TITLE</replaceable></term>
        <listitem>
          <para>Title of the device implemented by this plugin. There are some
            variables which will be replaced by <application>&dhpackage;</application>.
            <replaceable>@REALNAME@</replaceable> will be subsituted by the
            user&apos;s real name, <replaceable>@USERNAME@</replaceable> by the
            user&apos;s login id and <replaceable>@HOSTNAME@</replaceable> by
            the name of the machine <application>&dhpackage;</application> runs on.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>enabled</option>
        </term>
        <listitem>
          <para>
            You can individually enable or disable plugins by setting this
            to <userinput>true</userinput> or <userinput>false</userinput>.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>energy-management</option>
        </term>
        <listitem>
          <para>
            Set to <userinput>true</userinput> to if you would like the UPnP device to contain a EnergyManagement service. Note that additional configuration is required, see EnergyManagement settings.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>diagnostics</option>
        </term>
        <listitem>
          <para>
            Set to <userinput>true</userinput> if you would like the UPnP device to contain a BasicManagement:2 service that allows running tools like ping, nslookup and traceroute remotely.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>server-name</option>
        </term>
        <listitem>
          <para>A string that will be sent as the &quot;Server:&quot; header in a HTTP response.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1>
    <title>EnergyManagement settings</title>
    <para>The settings in <option>[EnergyManagement-IFACENAME]</option> sections specify the settings that relate to EnergyManagement services on this interface. Example: <option>[EnergyManagement-eth0].</option></para>
    <variablelist>
      <varlistentry>
        <term>
          <option>mode-on-suspend</option>
        </term>
        <listitem>
          <para>The <code>NetworkInterfaceMode</code> that should be used when suspended. Default is &quot;Unimplemented&quot;, other valid values are &quot;IP-up-Periodic”, &quot;IP-down-no-Wake&quot;, &quot;IP-down-with-WakeOn&quot;, &quot;IP-down-with-WakeAuto&quot;, &quot;IP-down-with-WakeOnAuto&quot;.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>supported-transport</option>
        </term>
        <listitem>
          <para>Optional <code>WakeSupportedTransport</code> that the service should advertize. Valid values are &quot;UDP-Broadcast&quot;, &quot;UDP-Unicast&quot;, &quot;TCP-Unicast&quot;, &quot;Other&quot;.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>password</option>
        </term>
        <listitem>
          <para>Optional hexadecimal password that will be used to build the <code>WakeOnPattern</code>.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1>
    <title>Tracker Plugin</title>
    <para>The tracker plugin uses the centralized database of meta information
      from the tracker project. See the
      <ulink url="https://wiki.gnome.org/Projects/Tracker">tracker project website </ulink> for more information about tracker.
    </para>
    <variablelist>
      <varlistentry>
        <term>
          <option>share-pictures</option>
        </term>
        <listitem>
          <para>
            Enable or disable sharing of all pictures in the Tracker database.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>share-videos</option>
        </term>
        <listitem>
          <para>
            Enable or disable sharing of all videos in the Tracker database.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>share-music</option>
        </term>
        <listitem>
          <para>
            Enable or disable sharing of all music in the Tracker database.
          </para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1>
    <title>MediaExport Plugin</title>
    <para>The MediaExport plugin is an alternative to the tracker-backed media export.
      It extracts meta-data by itself and stores it in a <ulink url="http://sqlite.org">SQLite </ulink> database in
      <filename>$XDG_CACHE_DIR/&dhpackage;/media-export.db</filename>
      on UNIX platforms.
      <note>
        <para>If both plugins, Tracker as well as MediaExport are enabled,
          MediaExport will disable itself in favour of the Tracker plugin.
        </para>
      </note></para>
    <para>There are several options supported by this plugin:</para>
    <variablelist>
      <varlistentry>
        <term>
          <option>uris</option>
        </term>
        <listitem>
          <para>A list of URIS to expose via UPnP. May be files, folders or anything supported by GVFS. If left emtpy it defaults to export the user&apos;s music, video and picture folders as defined per XDG special user directories spec. These default folders can be referenced by <userinput>@MUSIC@</userinput>, <userinput>@PICTURES@</userinput> and <userinput>@VIDEOS@</userinput>. Locations can be entered as either fully escaped URIS or normal paths.</para>
          <para><note>
              <para>If you enter a normal path that contains whitespace there is no need to escape them with either a backslash or putting the string in quotes.</para>
            </note></para>
            <para><note>
                    <para>It is strongly advised against using an exported folder as a target for downloads when <userinput>extract-metadata</userinput> is enabled. Rygel will most likely ignore the files then because they will fail to extract.</para>
            </note></para>
          <example>
            <title>Possible values for <userinput>uris</userinput></title>
            <para/>
            <para><userinput>uris=@MUSIC@;/home/user/My Pictures;file:///home/user/My%20Videos</userinput></para>
          </example>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>extract-metadata</option>
        </term>
        <listitem>
          <para>Set to <userinput>false</userinput> if you do not care about duration or any other meta-data like artist. This speeds up the initial crawl of the media a lot. Use it to quickly share some files via UPnP. Make sure to define an <option>include-filter</option>, otherwise you will end up with a lot of files exposed which the client cannot display anyway.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>monitor-changes</option>
        </term>
        <listitem>
          <para>Set to <userinput>false</userinput> if you don&apos;t want to have new files picked up automatically by &dhpackage;.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>monitor-grace-timeout</option>
        </term>
        <listitem>
          <para>Time in seconds to wait after a new file has  been detected before trying to extract meta-data from it. Useful if you&apos;re downloading to a directory watched by &dhpackage;. Default is 5 seconds.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>virtual-folders</option>
        </term>
        <listitem>
          <para>Set to <userinput>false</userinput> if you don&apos;t need the virtual folder hierarchy.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1>
    <title>Playbin plugin</title>
    <para>The Playbin plugin implements a media renderer (Digtal Media Renderer, DMR in DLNA terms). This plugin was known as GstRenderer.</para>
    <para>It is highly recommended to leave the sink choice to playbin. If, however, the default choices don&apos;t work for you they can be reconfigured as follows</para>
    <variablelist>
       <varlistentry>
        <term>
          <option>audio-sink</option>
        </term>
        <listitem>
          <para>Definition of the audio sink to use. Can be a single element or a partial pipeline definition in gst-launch&apos;s syntax</para>
        </listitem>
      </varlistentry>
       <varlistentry>
        <term>
          <option>video-sink</option>
        </term>
        <listitem>
          <para>Definition of the video sink to use. Can be a single element or a partial pipeline definition in gst-launch&apos;s syntax</para>
        </listitem>
      </varlistentry>   </variablelist>
  </refsect1>
  <refsect1>
    <title>LightMediaScanner Plugin</title>
    <para>The LightMediaScanner plugin exports the contents of the <ulink url="https://github.com/profusion/lightmediascanner">lightmediascanner daemon</ulink> </para>
    <para>This plugin does not have any special options.</para>
  </refsect1>
  <refsect1>
    <title>GstLaunch Plugin</title>
    <para>The GstLaunch plugin allows to expose GStreamer pipelines using the same syntax as the gst-launch utilty. You can configure several items in this plugins.</para>
    <variablelist>
      <varlistentry>
        <term>
          <option>launch-items</option>
        </term>
        <listitem>
          <para>A list of of identifiers for the pipelines to be exposed. </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>identifier-title</option>
        </term>
        <listitem>
          <para>Title of the device represented by this pipeline. Identifier
              is the identifier as set in launch-items</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>identifier-mime</option>
        </term>
        <listitem>
          <para>Mime-type of the pipeline.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>identifier-launch</option>
        </term>
        <listitem>
          <para>Definition of the pipeline in gst-launch syntax. For some examples on writing pipelines  see <citerefentry>
              <refentrytitle>gst-launch</refentrytitle>
              <manvolnum>1</manvolnum>
            </citerefentry>.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>
          <option>identifier-dlnaprofile</option>
        </term>
        <listitem>
          <para>DLNA profile for the stream.</para>
        </listitem>
      </varlistentry>
    </variablelist>
    <para>An example configuration is available in the distributed configuration file <filename>/etc/&dhucpackage;</filename>.</para>
  </refsect1>
  <refsect1>
    <title>External</title>
    <para>The External plugin is an consumer of the <ulink url="https://wiki.gnome.org/Projects/Rygel/MediaServer2Spec">MediaServer2 DBus interface specification</ulink>. This allows external programs to share their data via UPnP by implementing this DBus specification. The plugin picks up any implementation of this interface on the session bus and exposes the presented media via UPnP. Known implementors of this spec are  <ulink url="https://wiki.gnome.org/Projects/DVBDaemon">gnome-dvb-daemon</ulink>, <ulink url="http://www.rhythmbox.org">Rhythmbox</ulink> and <ulink url="https://wiki.gnome.org/Projects/Grilo">Grilo </ulink> via the grilo-ms2 project.</para>
    <para>You can disable the whole functionality by setting <userinput>enabled=false</userinput> in the <userinput>[External]</userinput> section of the configuration file.</para>
    <para>Individual peers may be enabled or disabled by creating sections corresponding to the D-Bus names of the peer:</para>
    <programlisting>[org.gnome.UPnP.MediaServer2.Rhythmbox]
enabled=false</programlisting>
    <para>This plugin has no additional options.</para>
  </refsect1>
  <refsect1>
    <title>MPRIS</title>
    <para>The MPRIS plugin is a consumer of the  <ulink url="https://specifications.freedesktop.org/mpris-spec/latest/">MPRIS2 DBus interface specification</ulink>. The implementation conforms to version 2.0 of the standard.
      </para>
    <para><application>&dhpackage;</application> exposes media players that implement the provider side of this DBus specification as DLNA Digital Media Renderers (DMR) similar to the Playbin plugin. This means that you can easily turn your media player into a DMR by implementing this DBus specification.</para>
    <para>Players that implement this spec and are known to work with <application>&dhpackage;</application> are  <ulink url="http://banshee.fm">Banshee</ulink>, <ulink url="http://www.rhythmbox.org">Rhythmbox</ulink> and <ulink url="https://wiki.gnome.org/Apps/Videos">GNOME Videos (previously known as Totem)</ulink>
      </para>
    <para>You can disable the whole functionality by setting <userinput>enabled=false</userinput> in the <userinput>[MRPIS]</userinput> section of the configuration file.</para>
    <para>The configuration of this plugin is special. Plugin configuration is not done on the plugin but rather per peer that is found providing the MPRIS2 interface. See the following example to set the title for Banshee on MPRIS:</para>
    <para><programlisting>[org.mpris.MediaPlayer2.banshee]
title=@REALNAME@&apos;s Banshee on @HOSTNAME@</programlisting></para>
    <para>This plugin has no additional options.</para>
  </refsect1>
  <refsect1 id="see_also">
    <title>SEE ALSO</title>
<!-- In alpabetical order. -->    <para><citerefentry>
        <refentrytitle>rygel</refentrytitle>
        <manvolnum>1</manvolnum>
      </citerefentry>, <citerefentry>
        <refentrytitle>gst-launch</refentrytitle>
        <manvolnum>1</manvolnum>
      </citerefentry></para>
  </refsect1>
</refentry>