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 ipv6
27 Set to false to disable binding to IPv6 addresses
28 interface=INTERFACE
30 Semicolon separated list separated of the network interfaces rygel
31 should listen on. May be an IP, an interface name or on Linux even
32 the ESSID of a wireless network.
33 port=PORT
35 Set the listen-port.
36 enable-transcoding
38 Set to true to enable transcoding in general.
39 log-level=DOMAIN:LEVEL[,DOMAIN:LEVEL,...]
41 Comma-separated list of DOMAIN:LEVEL pairs, allowing to set the log
42 level individually for each domain, where DOMAIN is eiher "*",
43 "rygel" or the name of a plugin. Allowed log levels are 1=error,
44 2=critical, 3=warning, 4=message/info, 5=debug. Note that on recent
45 versions of GLib (>= 2.36) it is required to set the environment
46 variable G_MESSAGES_DEBUG to all to get any debug output.
47 plugin-path=PATH
49 Set the plugin search path.
50 engine-path=PATH
52 Set the engine search path.
53 media-engine=ENGINE
55 Name of the loadable module to use as media engine back-end.
56 allow-upload
58 Allow uploading of media files via UPnP.
59 allow-deletion
61 Allow remote media file deletion via UPnP.
62 video-upload-folder
64 If allow-upload is true, use this folder to store uploaded videos.
65 It defaults to @VIDEOS@ which expands to the default directory for
66 video files (usually $HOME/Videos).
67 music-upload-folder
69 If allow-upload is true, use this folder to store uploaded music
70 files. It defaults to @MUSIC@ which expands to the default
71 directory for music files (usually $HOME/Music).
72 picture-upload-folder
74 If allow-upload is true, use this folder to store uploaded
75 pictures. It defaults to @PICTURES@ which expands to the default
76 directory for picture files (usually $HOME/Pictures).
77 force-downgrade-for
79 Semicolon-separated list of device user-agents (or parts thereof)
80 which need a forced downgrade to MediaServer:1 and/or
81 ContentDirectory:1.
82 Warning
85 Only use this parameter if you know what your're doing or are
86 being told to do so; overriding the default value might cause
87 incompatibilites. If you find that adding your device here
88 enables its usage with Rygel, please file an IOP bug[1] so we
89 can include it into the default configuration.
90 acl-fallback-policy
92 This is the default policy that is used if no access control
93 provider is found on the D-Bus. Use true to allow access from every
94 peer, false to deny all access. If it is not specified, the default
95 fall-back policy is true.
96 strict-dlna
98 Disabled by default. Use true to disable a set of features that
99 improve compatibility with many clients, but break standard
100 conformance
101
103 The settings in the [Database]section are for the database support
104 library.
105 debug
107 Set to true to show the SQL statements used.
108
110 The settings in the [GstMediaEngine] section are specific to the
111 GStreamer media engine, which is the default media engine. See the
112 media-engine setting. These following options are available for the
113 GStreamer[2] media engine.
114 transcoders
116 A semicolon-separated list of the active transcoders. This setting
117 has no effect if enable-transcoding is set to false. Possible
118 values are: lpcm,mp3,mp2ts,aac,avc or wmv. Its default value is
119 lpcm;mp3;mp2ts;aac;wmv.
120
122 Sections for plugins are denoted with [PluginName] and can contain
123 options specific to a plugin (see below) as well these common options:
124 title=TITLE
126 Title of the device implemented by this plugin. There are some
127 variables which will be replaced by rygel. @REALNAME@ will be
128 subsituted by the user's real name, @USERNAME@ by the user's login
129 id and @HOSTNAME@ by the name of the machine rygel runs on.
130 enabled
132 You can individually enable or disable plugins by setting this to
133 true or false.
134 energy-management
136 Set to true to if you would like the UPnP device to contain a
137 EnergyManagement service. Note that additional configuration is
138 required, see EnergyManagement settings.
139 diagnostics
141 Set to true if you would like the UPnP device to contain a
142 BasicManagement:2 service that allows running tools like ping,
143 nslookup and traceroute remotely.
144 server-name
146 A string that will be sent as the "Server:" header in a HTTP
147 response.
148
150 The settings in [EnergyManagement-IFACENAME] sections specify the
151 settings that relate to EnergyManagement services on this interface.
152 Example: [EnergyManagement-eth0].
153 mode-on-suspend
155 The NetworkInterfaceMode that should be used when suspended.
156 Default is "Unimplemented", other valid values are
157 "IP-up-Periodic”, "IP-down-no-Wake", "IP-down-with-WakeOn",
158 "IP-down-with-WakeAuto", "IP-down-with-WakeOnAuto".
159 supported-transport
161 Optional WakeSupportedTransport that the service should advertize.
162 Valid values are "UDP-Broadcast", "UDP-Unicast", "TCP-Unicast",
163 "Other".
164 password
166 Optional hexadecimal password that will be used to build the
167 WakeOnPattern.
168
170 The tracker plugin uses the centralized database of meta information
171 from the tracker project. See the tracker project website[3] for more
172 information about tracker.
173 share-pictures
175 Enable or disable sharing of all pictures in the Tracker database.
176 share-videos
178 Enable or disable sharing of all videos in the Tracker database.
179 share-music
181 Enable or disable sharing of all music in the Tracker database.
182
184 The MediaExport plugin is an alternative to the tracker-backed media
185 export. It extracts meta-data by itself and stores it in a SQLite[4]
186 database in $XDG_CACHE_DIR/rygel/media-export.db on UNIX platforms.
187 Note
189 If both plugins, Tracker as well as MediaExport are enabled,
190 MediaExport will disable itself in favour of the Tracker plugin.
191 There are several options supported by this plugin:
193 uris
195 A list of URIS to expose via UPnP. May be files, folders or
196 anything supported by GVFS. If left emtpy it defaults to export the
197 user's music, video and picture folders as defined per XDG special
198 user directories spec. These default folders can be referenced by
199 @MUSIC@, @PICTURES@ and @VIDEOS@. Locations can be entered as
200 either fully escaped URIS or normal paths.
201 Note
204 If you enter a normal path that contains whitespace there is no
205 need to escape them with either a backslash or putting the
206 string in quotes.
207 Note
210 It is strongly advised against using an exported folder as a
211 target for downloads when extract-metadata is enabled. Rygel
212 will most likely ignore the files then because they will fail
213 to extract.
214 Example 1. Possible values for uris
216 uris=@MUSIC@;/home/user/My Pictures;file:///home/user/My%20Videos
218 extract-metadata
220 Set to false if you do not care about duration or any other
221 meta-data like artist. This speeds up the initial crawl of the
222 media a lot. Use it to quickly share some files via UPnP. Make sure
223 to define an include-filter, otherwise you will end up with a lot
224 of files exposed which the client cannot display anyway.
225 monitor-changes
227 Set to false if you don't want to have new files picked up
228 automatically by rygel.
229 monitor-grace-timeout
231 Time in seconds to wait after a new file has been detected before
232 trying to extract meta-data from it. Useful if you're downloading
233 to a directory watched by rygel. Default is 5 seconds.
234 virtual-folders
236 Set to false if you don't need the virtual folder hierarchy.
237
239 The Playbin plugin implements a media renderer (Digtal Media Renderer,
240 DMR in DLNA terms). This plugin was known as GstRenderer.
241 It is highly recommended to leave the sink choice to playbin. If,
243 however, the default choices don't work for you they can be
244 reconfigured as follows
245 audio-sink
247 Definition of the audio sink to use. Can be a single element or a
248 partial pipeline definition in gst-launch's syntax
249 video-sink
251 Definition of the video sink to use. Can be a single element or a
252 partial pipeline definition in gst-launch's syntax
253
255 The LightMediaScanner plugin exports the contents of the
256 lightmediascanner daemon[5]
257 This plugin does not have any special options.
259
261 The GstLaunch plugin allows to expose GStreamer pipelines using the
262 same syntax as the gst-launch utilty. You can configure several items
263 in this plugins.
264 launch-items
266 A list of of identifiers for the pipelines to be exposed.
267 identifier-title
269 Title of the device represented by this pipeline. Identifier is the
270 identifier as set in launch-items
271 identifier-mime
273 Mime-type of the pipeline.
274 identifier-launch
276 Definition of the pipeline in gst-launch syntax. For some examples
277 on writing pipelines see gst-launch(1).
278 identifier-dlnaprofile
280 DLNA profile for the stream.
281 An example configuration is available in the distributed configuration
283 file /etc/rygel.conf.
284
286 The External plugin is an consumer of the MediaServer2 DBus interface
287 specification[6]. This allows external programs to share their data via
288 UPnP by implementing this DBus specification. The plugin picks up any
289 implementation of this interface on the session bus and exposes the
290 presented media via UPnP. Known implementors of this spec are
291 gnome-dvb-daemon[7], Rhythmbox[8] and Grilo[9] via the grilo-ms2
292 project.
293 You can disable the whole functionality by setting enabled=false in the
295 [External] section of the configuration file.
296 Individual peers may be enabled or disabled by creating sections
298 corresponding to the D-Bus names of the peer:
299 [org.gnome.UPnP.MediaServer2.Rhythmbox]
301 enabled=false
302 This plugin has no additional options.
304
306 The MPRIS plugin is a consumer of the MPRIS2 DBus interface
307 specification[10]. The implementation conforms to version 2.0 of the
308 standard.
309 rygel exposes media players that implement the provider side of this
311 DBus specification as DLNA Digital Media Renderers (DMR) similar to the
312 Playbin plugin. This means that you can easily turn your media player
313 into a DMR by implementing this DBus specification.
314 Players that implement this spec and are known to work with rygel are
316 Banshee[11], Rhythmbox[8] and GNOME Videos (previously known as
317 Totem)[12]
318 You can disable the whole functionality by setting enabled=false in the
320 [MRPIS] section of the configuration file.
321 The configuration of this plugin is special. Plugin configuration is
323 not done on the plugin but rather per peer that is found providing the
324 MPRIS2 interface. See the following example to set the title for
325 Banshee on MPRIS:
326 [org.mpris.MediaPlayer2.banshee]
328 title=@REALNAME@'s Banshee on @HOSTNAME@
329 This plugin has no additional options.
331
333 rygel(1), gst-launch(1)
334
336 Jens Georg <mail@jensge.org>
337 Wrote this manpage.
338
340 1. file an IOP bug
341 https://gitlab.gnome.org/GNOME/rygel/issues/new/?issuable_template=IOP
342 2. GStreamer
344 http://gstreamer.freedesktop.org
345 3. tracker project website
347 https://wiki.gnome.org/Projects/Tracker
348 4. SQLite
350 http://sqlite.org
351 5. lightmediascanner daemon
353 https://github.com/profusion/lightmediascanner
354 6. MediaServer2 DBus interface specification
356 https://wiki.gnome.org/Projects/Rygel/MediaServer2Spec
357 7. gnome-dvb-daemon
359 https://wiki.gnome.org/Projects/DVBDaemon
360 8. Rhythmbox
362 http://www.rhythmbox.org
363 9. Grilo
365 https://wiki.gnome.org/Projects/Grilo
366 10. MPRIS2 DBus interface specification
368 https://specifications.freedesktop.org/mpris-spec/latest/
369 11. Banshee
371 http://banshee.fm
372 12. GNOME Videos (previously known as Totem)
374 https://wiki.gnome.org/Apps/Videos
375rygel 08/02/2023 RYGEL.CONF(5)