Ubuntu Manpage: rygel.conf - Rygel configuration file

NAME

       rygel.conf - Rygel configuration file

SYNOPSIS


       $XDG_CONFIG_DIR/rygel.conf

       /etc/rygel.conf

DESCRIPTION

       rygel reads its configuration values from the file $XDG_CONFIG_DIR/rygel.conf or a file given on command
       line with the --config option. If that file does not exist it uses the file /etc/rygel.conf.

       Most of the options may be overriden by commandline arguments or envronment variables. See rygel(1) for
       details on those.

GENERAL DIRECTIVES

Lists in the configuration files are separated by a semicolon (;). Boolean values may be either true or
false.

upnp-enabled
Enable/disable UPnP sharing of the media files. If set to false, rygel will still offer HTTP proxy
URLs for its media files but not actively advertise them via UPnP.

interface=INTERFACE
A list of the network interfaces rygel listens on. May be an IP, an interface name or on Linux even
the ESSID of a wireless network.

port=PORT
Set the listen-port.

enable-transcoding
Set to true to enable transcoding in general.

log-level=DOMAIN:LEVEL[,DOMAIN:LEVEL,...]
Comma-separated list of DOMAIN:LEVEL pairs, allowing to set the log level individually for each
domain, where DOMAIN is eiher "*", "rygel" or the name of a plugin. Allowed log levels are
1=critical, 2=error, 3=warning, 4=message/info, 5=debug. Note that on recent versions of GLib (>=
2.36) it is required to set the environment variable G_MESSAGES_DEBUG to all to get any debug output.

plugin-path=PATH
Set the plugin search path.

engine-path=PATH
Set the engine search path.

media-engine=ENGINE
Name of the loadable module to use as media engine back-end.

allow-upload
Allow uploading of media files via UPnP.

allow-deletion
Allow remote media file deletion via UPnP.

video-upload-folder
If allow-upload is true, use this folder to store uploaded videos. It defaults to @VIDEOS@ which
expands to the default directory for video files (usually $HOME/Videos).

music-upload-folder
If allow-upload is true, use this folder to store uploaded music files. It defaults to @MUSIC@ which
expands to the default directory for music files (usually $HOME/Music).

picture-upload-folder
If allow-upload is true, use this folder to store uploaded pictures. It defaults to @PICTURES@ which
expands to the default directory for picture files (usually $HOME/Pictures).

force-downgrade-for
Semicolon-separated list of device user-agents (or parts thereof) which need a forced downgrade to
MediaServer:1 and/or ContentDirectory:1.

Warning
Only use this parameter if you know what your'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 file an IOP bug[1] so we can include it into the default configuration.

GSTREAMER MEDIA ENGINE SETTINGS

       The settings in the [GstMediaEngine] 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
       GStreamer[2] media engine.

       transcoders
           A semicolon-separated list of the active transcoders. This setting has no effect if
           enable-transcoding is set to false. Possible values are: lpcm,mp3,mp2ts,aac,avc or wmv. Its default
           value is lpcm;mp3;mp2ts;aac;wmv.

PLUGIN-SPECIFIC SETTINGS

       Sections for plugins are denoted with [PluginName] and can contain options specific to a plugin (see
       below) as well these common options:

       title=TITLE
           Title of the device implemented by this plugin. There are some variables which will be replaced by
           rygel.  @REALNAME@ will be subsituted by the user's real name, @USERNAME@ by the user's login id and
           @HOSTNAME@ by the name of the machine rygel runs on.

       enabled
           You can individually enable or disable plugins by setting this to true or false.

       energy-management
           Set to true to if you would like the UPnP device to contain a EnergyManagement service. Not that
           additional configuration is required, see EnergyManagement settings.

       diagnostics
           Set to true if you would like the UPnP device to contain a BasicManagement:2 service that allows
           running tools like ping, nslookup and traceroute remotely.

ENERGYMANAGEMENT SETTINGS

       The settings in [EnergyManagement-IFACENAME] sections specify the settings that relate to
       EnergyManagement services on this interface. Example: [EnergyManagement-eth0].

       mode-on-suspend
           The NetworkInterfaceMode that should be used when suspended. Default is "Unimplemented", other valid
           values are "IP-up-Periodic”, "IP-down-no-Wake", "IP-down-with-WakeOn", "IP-down-with-WakeAuto",
           "IP-down-with-WakeOnAuto".

       supported-transport
           Optional WakeSupportedTransport that the service should advertize. Valid values are "UDP-Broadcast",
           "UDP-Unicast", "TCP-Unicast", "Other".

       password
           Optional hexadecimal password that will be used to build the WakeOnPattern.

TRACKER PLUGIN

       The tracker plugin uses the centralized database of meta information from the tracker project. See the
       tracker project website[3] for more information about tracker.

       share-pictures
           Enable or disable sharing of all pictures in the Tracker database.

       share-videos
           Enable or disable sharing of all videos in the Tracker database.

       share-music
           Enable or disable sharing of all music in the Tracker database.

MEDIAEXPORT PLUGIN

The MediaExport plugin is an alternative to the tracker-backed media export. It extracts meta-data by
itself and stores it in a SQLite[4] database in $XDG_CACHE_DIR/rygel/media-export.db on UNIX platforms.

Note

If both plugins, Tracker as well as MediaExport are enabled, MediaExport will disable itself in
favour of the Tracker plugin.

There are several options supported by this plugin:

uris
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's music, video and picture folders as defined per XDG special user
directories spec. These default folders can be referenced by @MUSIC@, @PICTURES@ and @VIDEOS@.
Locations can be entered as either fully escaped URIS or normal paths.

Note
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.

Example 1. Possible values for uris

uris=@MUSIC@;/home/user/My Pictures;file:///home/user/My%20Videos

extract-metadata
Set to false 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
include-filter, otherwise you will end up with a lot of files exposed which the client cannot display
anyway.

monitor-changes
Set to false if you don't want to have new files picked up automatically by rygel.

monitor-grace-timeout
Time in seconds to wait after a new file has been detected before trying to extract meta-data from
it. Useful if you're downloading to a directory watched by rygel. Default is 5 seconds.

virtual-folders
Set to false if you don't need the virtual folder hierarchy.

PLAYBIN PLUGIN

       The Playbin plugin implements a media renderer (Digtal Media Renderer, DMR in DLNA terms). This plugin
       was known as GstRenderer.

       This plugin has no special options.

ZDFMEDIATHEK

       The ZDF Mediathek[5] is an online archive of broadcasts from the second german television. This plugin
       can be used to subscribes to the RSS feeds of this service and expose the broadcasts via UPnP.

       rss
           A list of broadcast ids. How to get the broadcast ids from the web site is described in the file
           README.Mediathek (in german only).

       update-interval
           Time in seconds after which the plugin checks for new content. The default interval is 1800 seconds
           (30 minutes), the minimum interval 10 minutes.

       video-format
           The mediathek usually offers the videos in two formats, WMV and H.264. Possible values here are wmv
           and mp4. The default video format is wmv.

               Note
               Proxying of general RTSP in rygel as used by the H.264 streams is currently not working very
               well. Please enable mp4 only if your renderer can handle RTSP by itself.

GSTLAUNCH PLUGIN

       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.

       launch-items
           A list of of identifiers for the pipelines to be exposed.

       identifier-title
           Title of the device represented by this pipeline. Identifier is the identifier as set in launch-items

       identifier-mime
           Mime-type of the pipeline.

       identifier-launch
           Definition of the pipeline in gst-launch syntax. For some examples on writing pipelines see gst-
           launch(1).

       identifier-dlnaprofile
           DLNA profile for the stream.

       An example configuration is available in the distributed configuration file /etc/rygel.conf.

EXTERNAL

       The External plugin is an consumer of the MediaServer2 DBus interface specification[6]. 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 gnome-dvb-daemon[7], Rhythmbox[8] and Grilo[9] via the grilo-ms2
       project.

       You can disable the whole functionality by setting enabled=false in the [External] section of the
       configuration file.

       Individual peers may be enabled or disabled by creating sections corresponding to the D-Bus names of the
       peer:

           [org.gnome.UPnP.MediaServer2.Rhythmbox]
           enabled=false

       This plugin has no additional options.

MPRIS

       The MPRIS plugin is a consumer of the MPRIS2 DBus interface specification[10]. The implementation
       conforms to version 2.0 of the standard.

       rygel 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.

       Players that implement this spec and are known to work with rygel are Banshee[11], Rhythmbox[8] and
       Totem[12]

       You can disable the whole functionality by setting enabled=false in the [MRPIS] section of the
       configuration file.

       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:

           [org.mpris.MediaPlayer2.banshee]
           title=@REALNAME@'s Banshee on @HOSTNAME@

       This plugin has no additional options.

AUTHOR

       Jens Georg <mail@jensge.org>
           Wrote this manpage.

NOTES

        1. file an IOP bug
           https://bugzilla.gnome.org/enter_bug.cgi?product=Rygel&component=IOP

        2. GStreamer
           http://gstreamer.freedesktop.org

        3. tracker project website
           http://projects.gnome.org/tracker/

        4. SQLite
           http://sqlite.org

        5. ZDF Mediathek
           http://www.zdf.de/ZDFmediathek

        6. MediaServer2 DBus interface specification
           http://live.gnome.org/Rygel/MediaServer2Spec

        7. gnome-dvb-daemon
           http://live.gnome.org/DVBDaemon

        8. Rhythmbox
           http://www.rhythmbox.org

        9. Grilo
           http://live.gnome.org/Grilo

       10. MPRIS2 DBus interface specification
           http://www.mpris.org

       11. Banshee
           http://banshee.fm

       12. Totem
           http://live.gnome.org/Totem

rygel                                              03/01/2016                                      RYGEL.CONF(5)