1RYGEL.CONF(5) Rygel User Manual RYGEL.CONF(5)
2
6 rygel.conf - Rygel configuration file
7
9 $XDG_CONFIG_DIR/rygel.conf
10 /etc/rygel.conf
12
14 rygel reads its configuration values from the file
15 $XDG_CONFIG_DIR/rygel.conf or a file given on command line with the
16 --config option. If that file does not exist it uses the file
17 /etc/rygel.conf.
18 Most of the options may be overriden by commandline arguments or
20 envronment variables. See rygel(1) for details on those.
21
23 Lists in the configuration files are separated by a semicolon (;).
24 Boolean values may be either true or false.
25 interface=INTERFACE
27 Semicolon separated list separated of the network interfaces rygel
28 should listen on. May be an IP, an interface name or on Linux even
29 the ESSID of a wireless network.
30 port=PORT
32 Set the listen-port.
33 enable-transcoding
35 Set to true to enable transcoding in general.
36 log-level=DOMAIN:LEVEL[,DOMAIN:LEVEL,...]
38 Comma-separated list of DOMAIN:LEVEL pairs, allowing to set the log
39 level individually for each domain, where DOMAIN is eiher "*",
40 "rygel" or the name of a plugin. Allowed log levels are 1=error,
41 2=critical, 3=warning, 4=message/info, 5=debug. Note that on recent
42 versions of GLib (>= 2.36) it is required to set the environment
43 variable G_MESSAGES_DEBUG to all to get any debug output.
44 plugin-path=PATH
46 Set the plugin search path.
47 engine-path=PATH
49 Set the engine search path.
50 media-engine=ENGINE
52 Name of the loadable module to use as media engine back-end.
53 allow-upload
55 Allow uploading of media files via UPnP.
56 allow-deletion
58 Allow remote media file deletion via UPnP.
59 video-upload-folder
61 If allow-upload is true, use this folder to store uploaded videos.
62 It defaults to @VIDEOS@ which expands to the default directory for
63 video files (usually $HOME/Videos).
64 music-upload-folder
66 If allow-upload is true, use this folder to store uploaded music
67 files. It defaults to @MUSIC@ which expands to the default
68 directory for music files (usually $HOME/Music).
69 picture-upload-folder
71 If allow-upload is true, use this folder to store uploaded
72 pictures. It defaults to @PICTURES@ which expands to the default
73 directory for picture files (usually $HOME/Pictures).
74 force-downgrade-for
76 Semicolon-separated list of device user-agents (or parts thereof)
77 which need a forced downgrade to MediaServer:1 and/or
78 ContentDirectory:1.
79 Warning
82 Only use this parameter if you know what your're doing or are
83 being told to do so; overriding the default value might cause
84 incompatibilites. If you find that adding your device here
85 enables its usage with Rygel, please file an IOP bug[1] so we
86 can include it into the default configuration.
87
89 The settings in the [Database]section are for the database support
90 library.
91 debug
93 Set to true to show the SQL statements used.
94
96 The settings in the [GstMediaEngine] section are specific to the
97 GStreamer media engine, which is the default media engine. See the
98 media-engine setting. These following options are available for the
99 GStreamer[2] media engine.
100 transcoders
102 A semicolon-separated list of the active transcoders. This setting
103 has no effect if enable-transcoding is set to false. Possible
104 values are: lpcm,mp3,mp2ts,aac,avc or wmv. Its default value is
105 lpcm;mp3;mp2ts;aac;wmv.
106
108 Sections for plugins are denoted with [PluginName] and can contain
109 options specific to a plugin (see below) as well these common options:
110 title=TITLE
112 Title of the device implemented by this plugin. There are some
113 variables which will be replaced by rygel. @REALNAME@ will be
114 subsituted by the user's real name, @USERNAME@ by the user's login
115 id and @HOSTNAME@ by the name of the machine rygel runs on.
116 enabled
118 You can individually enable or disable plugins by setting this to
119 true or false.
120 energy-management
122 Set to true to if you would like the UPnP device to contain a
123 EnergyManagement service. Not that additional configuration is
124 required, see EnergyManagement settings.
125 diagnostics
127 Set to true if you would like the UPnP device to contain a
128 BasicManagement:2 service that allows running tools like ping,
129 nslookup and traceroute remotely.
130 server-name
132 A string that will be sent as the "Server:" header in a HTTP
133 response.
134
136 The settings in [EnergyManagement-IFACENAME] sections specify the
137 settings that relate to EnergyManagement services on this interface.
138 Example: [EnergyManagement-eth0].
139 mode-on-suspend
141 The NetworkInterfaceMode that should be used when suspended.
142 Default is "Unimplemented", other valid values are
143 "IP-up-Periodic”, "IP-down-no-Wake", "IP-down-with-WakeOn",
144 "IP-down-with-WakeAuto", "IP-down-with-WakeOnAuto".
145 supported-transport
147 Optional WakeSupportedTransport that the service should advertize.
148 Valid values are "UDP-Broadcast", "UDP-Unicast", "TCP-Unicast",
149 "Other".
150 password
152 Optional hexadecimal password that will be used to build the
153 WakeOnPattern.
154
156 The tracker plugin uses the centralized database of meta information
157 from the tracker project. See the tracker project website[3] for more
158 information about tracker.
159 share-pictures
161 Enable or disable sharing of all pictures in the Tracker database.
162 share-videos
164 Enable or disable sharing of all videos in the Tracker database.
165 share-music
167 Enable or disable sharing of all music in the Tracker database.
168
170 The MediaExport plugin is an alternative to the tracker-backed media
171 export. It extracts meta-data by itself and stores it in a SQLite[4]
172 database in $XDG_CACHE_DIR/rygel/media-export.db on UNIX platforms.
173 Note
175 If both plugins, Tracker as well as MediaExport are enabled,
176 MediaExport will disable itself in favour of the Tracker plugin.
177 There are several options supported by this plugin:
179 uris
181 A list of URIS to expose via UPnP. May be files, folders or
182 anything supported by GVFS. If left emtpy it defaults to export the
183 user's music, video and picture folders as defined per XDG special
184 user directories spec. These default folders can be referenced by
185 @MUSIC@, @PICTURES@ and @VIDEOS@. Locations can be entered as
186 either fully escaped URIS or normal paths.
187 Note
190 If you enter a normal path that contains whitespace there is no
191 need to escape them with either a backslash or putting the
192 string in quotes.
193 Example 1. Possible values for uris
195 uris=@MUSIC@;/home/user/My Pictures;file:///home/user/My%20Videos
197 extract-metadata
199 Set to false if you do not care about duration or any other
200 meta-data like artist. This speeds up the initial crawl of the
201 media a lot. Use it to quickly share some files via UPnP. Make sure
202 to define an include-filter, otherwise you will end up with a lot
203 of files exposed which the client cannot display anyway.
204 monitor-changes
206 Set to false if you don't want to have new files picked up
207 automatically by rygel.
208 monitor-grace-timeout
210 Time in seconds to wait after a new file has been detected before
211 trying to extract meta-data from it. Useful if you're downloading
212 to a directory watched by rygel. Default is 5 seconds.
213 virtual-folders
215 Set to false if you don't need the virtual folder hierarchy.
216
218 The Playbin plugin implements a media renderer (Digtal Media Renderer,
219 DMR in DLNA terms). This plugin was known as GstRenderer.
220 This plugin has no special options.
222
224 The LightMediaScanner plugin exports the contents of the
225 lightmediascanner daemon[5]
226 This plugin does not have any special options.
228
230 The GstLaunch plugin allows to expose GStreamer pipelines using the
231 same syntax as the gst-launch utilty. You can configure several items
232 in this plugins.
233 launch-items
235 A list of of identifiers for the pipelines to be exposed.
236 identifier-title
238 Title of the device represented by this pipeline. Identifier is the
239 identifier as set in launch-items
240 identifier-mime
242 Mime-type of the pipeline.
243 identifier-launch
245 Definition of the pipeline in gst-launch syntax. For some examples
246 on writing pipelines see gst-launch(1).
247 identifier-dlnaprofile
249 DLNA profile for the stream.
250 An example configuration is available in the distributed configuration
252 file /etc/rygel.conf.
253
255 The External plugin is an consumer of the MediaServer2 DBus interface
256 specification[6]. This allows external programs to share their data via
257 UPnP by implementing this DBus specification. The plugin picks up any
258 implementation of this interface on the session bus and exposes the
259 presented media via UPnP. Known implementors of this spec are
260 gnome-dvb-daemon[7], Rhythmbox[8] and Grilo[9] via the grilo-ms2
261 project.
262 You can disable the whole functionality by setting enabled=false in the
264 [External] section of the configuration file.
265 Individual peers may be enabled or disabled by creating sections
267 corresponding to the D-Bus names of the peer:
268 [org.gnome.UPnP.MediaServer2.Rhythmbox]
270 enabled=false
271 This plugin has no additional options.
273
275 The MPRIS plugin is a consumer of the MPRIS2 DBus interface
276 specification[10]. The implementation conforms to version 2.0 of the
277 standard.
278 rygel exposes media players that implement the provider side of this
280 DBus specification as DLNA Digital Media Renderers (DMR) similar to the
281 Playbin plugin. This means that you can easily turn your media player
282 into a DMR by implementing this DBus specification.
283 Players that implement this spec and are known to work with rygel are
285 Banshee[11], Rhythmbox[8] and GNOME Videos (previously known as
286 Totem)[12]
287 You can disable the whole functionality by setting enabled=false in the
289 [MRPIS] section of the configuration file.
290 The configuration of this plugin is special. Plugin configuration is
292 not done on the plugin but rather per peer that is found providing the
293 MPRIS2 interface. See the following example to set the title for
294 Banshee on MPRIS:
295 [org.mpris.MediaPlayer2.banshee]
297 title=@REALNAME@'s Banshee on @HOSTNAME@
298 This plugin has no additional options.
300
302 rygel(1), gst-launch(1)
303
305 Jens Georg <mail@jensge.org>
306 Wrote this manpage.
307
309 1. file an IOP bug
310 https://bugzilla.gnome.org/enter_bug.cgi?product=Rygel&component=IOP
311 2. GStreamer
313 http://gstreamer.freedesktop.org
314 3. tracker project website
316 https://wiki.gnome.org/Projects/Tracker
317 4. SQLite
319 http://sqlite.org
320 5. lightmediascanner daemon
322 https://github.com/profusion/lightmediascanner
323 6. MediaServer2 DBus interface specification
325 https://wiki.gnome.org/Projects/Rygel/MediaServer2Spec
326 7. gnome-dvb-daemon
328 https://wiki.gnome.org/Projects/DVBDaemon
329 8. Rhythmbox
331 http://www.rhythmbox.org
332 9. Grilo
334 https://wiki.gnome.org/Projects/Grilo
335 10. MPRIS2 DBus interface specification
337 http://www.mpris.org
338 11. Banshee
340 http://banshee.fm
341 12. GNOME Videos (previously known as Totem)
343 https://wiki.gnome.org/Apps/Videos
344rygel 09/04/2018 RYGEL.CONF(5)