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
98 The settings in the [Database]section are for the database support
99 library.
100 debug
102 Set to true to show the SQL statements used.
103
105 The settings in the [GstMediaEngine] section are specific to the
106 GStreamer media engine, which is the default media engine. See the
107 media-engine setting. These following options are available for the
108 GStreamer[2] media engine.
109 transcoders
111 A semicolon-separated list of the active transcoders. This setting
112 has no effect if enable-transcoding is set to false. Possible
113 values are: lpcm,mp3,mp2ts,aac,avc or wmv. Its default value is
114 lpcm;mp3;mp2ts;aac;wmv.
115
117 Sections for plugins are denoted with [PluginName] and can contain
118 options specific to a plugin (see below) as well these common options:
119 title=TITLE
121 Title of the device implemented by this plugin. There are some
122 variables which will be replaced by rygel. @REALNAME@ will be
123 subsituted by the user's real name, @USERNAME@ by the user's login
124 id and @HOSTNAME@ by the name of the machine rygel runs on.
125 enabled
127 You can individually enable or disable plugins by setting this to
128 true or false.
129 energy-management
131 Set to true to if you would like the UPnP device to contain a
132 EnergyManagement service. Note that additional configuration is
133 required, see EnergyManagement settings.
134 diagnostics
136 Set to true if you would like the UPnP device to contain a
137 BasicManagement:2 service that allows running tools like ping,
138 nslookup and traceroute remotely.
139 server-name
141 A string that will be sent as the "Server:" header in a HTTP
142 response.
143
145 The settings in [EnergyManagement-IFACENAME] sections specify the
146 settings that relate to EnergyManagement services on this interface.
147 Example: [EnergyManagement-eth0].
148 mode-on-suspend
150 The NetworkInterfaceMode that should be used when suspended.
151 Default is "Unimplemented", other valid values are
152 "IP-up-Periodic”, "IP-down-no-Wake", "IP-down-with-WakeOn",
153 "IP-down-with-WakeAuto", "IP-down-with-WakeOnAuto".
154 supported-transport
156 Optional WakeSupportedTransport that the service should advertize.
157 Valid values are "UDP-Broadcast", "UDP-Unicast", "TCP-Unicast",
158 "Other".
159 password
161 Optional hexadecimal password that will be used to build the
162 WakeOnPattern.
163
165 The tracker plugin uses the centralized database of meta information
166 from the tracker project. See the tracker project website[3] for more
167 information about tracker.
168 share-pictures
170 Enable or disable sharing of all pictures in the Tracker database.
171 share-videos
173 Enable or disable sharing of all videos in the Tracker database.
174 share-music
176 Enable or disable sharing of all music in the Tracker database.
177
179 The MediaExport plugin is an alternative to the tracker-backed media
180 export. It extracts meta-data by itself and stores it in a SQLite[4]
181 database in $XDG_CACHE_DIR/rygel/media-export.db on UNIX platforms.
182 Note
184 If both plugins, Tracker as well as MediaExport are enabled,
185 MediaExport will disable itself in favour of the Tracker plugin.
186 There are several options supported by this plugin:
188 uris
190 A list of URIS to expose via UPnP. May be files, folders or
191 anything supported by GVFS. If left emtpy it defaults to export the
192 user's music, video and picture folders as defined per XDG special
193 user directories spec. These default folders can be referenced by
194 @MUSIC@, @PICTURES@ and @VIDEOS@. Locations can be entered as
195 either fully escaped URIS or normal paths.
196 Note
199 If you enter a normal path that contains whitespace there is no
200 need to escape them with either a backslash or putting the
201 string in quotes.
202 Note
205 It is strongly advised against using an exported folder as a
206 target for downloads when extract-metadata is enabled. Rygel
207 will most likely ignore the files then because they will fail
208 to extract.
209 Example 1. Possible values for uris
211 uris=@MUSIC@;/home/user/My Pictures;file:///home/user/My%20Videos
213 extract-metadata
215 Set to false if you do not care about duration or any other
216 meta-data like artist. This speeds up the initial crawl of the
217 media a lot. Use it to quickly share some files via UPnP. Make sure
218 to define an include-filter, otherwise you will end up with a lot
219 of files exposed which the client cannot display anyway.
220 monitor-changes
222 Set to false if you don't want to have new files picked up
223 automatically by rygel.
224 monitor-grace-timeout
226 Time in seconds to wait after a new file has been detected before
227 trying to extract meta-data from it. Useful if you're downloading
228 to a directory watched by rygel. Default is 5 seconds.
229 virtual-folders
231 Set to false if you don't need the virtual folder hierarchy.
232
234 The Playbin plugin implements a media renderer (Digtal Media Renderer,
235 DMR in DLNA terms). This plugin was known as GstRenderer.
236 It is highly recommended to leave the sink choice to playbin. If,
238 however, the default choices don't work for you they can be
239 reconfigured as follows
240 audio-sink
242 Definition of the audio sink to use. Can be a single element or a
243 partial pipeline definition in gst-launch's syntax
244 video-sink
246 Definition of the video sink to use. Can be a single element or a
247 partial pipeline definition in gst-launch's syntax
248
250 The LightMediaScanner plugin exports the contents of the
251 lightmediascanner daemon[5]
252 This plugin does not have any special options.
254
256 The GstLaunch plugin allows to expose GStreamer pipelines using the
257 same syntax as the gst-launch utilty. You can configure several items
258 in this plugins.
259 launch-items
261 A list of of identifiers for the pipelines to be exposed.
262 identifier-title
264 Title of the device represented by this pipeline. Identifier is the
265 identifier as set in launch-items
266 identifier-mime
268 Mime-type of the pipeline.
269 identifier-launch
271 Definition of the pipeline in gst-launch syntax. For some examples
272 on writing pipelines see gst-launch(1).
273 identifier-dlnaprofile
275 DLNA profile for the stream.
276 An example configuration is available in the distributed configuration
278 file /etc/rygel.conf.
279
281 The External plugin is an consumer of the MediaServer2 DBus interface
282 specification[6]. This allows external programs to share their data via
283 UPnP by implementing this DBus specification. The plugin picks up any
284 implementation of this interface on the session bus and exposes the
285 presented media via UPnP. Known implementors of this spec are
286 gnome-dvb-daemon[7], Rhythmbox[8] and Grilo[9] via the grilo-ms2
287 project.
288 You can disable the whole functionality by setting enabled=false in the
290 [External] section of the configuration file.
291 Individual peers may be enabled or disabled by creating sections
293 corresponding to the D-Bus names of the peer:
294 [org.gnome.UPnP.MediaServer2.Rhythmbox]
296 enabled=false
297 This plugin has no additional options.
299
301 The MPRIS plugin is a consumer of the MPRIS2 DBus interface
302 specification[10]. The implementation conforms to version 2.0 of the
303 standard.
304 rygel exposes media players that implement the provider side of this
306 DBus specification as DLNA Digital Media Renderers (DMR) similar to the
307 Playbin plugin. This means that you can easily turn your media player
308 into a DMR by implementing this DBus specification.
309 Players that implement this spec and are known to work with rygel are
311 Banshee[11], Rhythmbox[8] and GNOME Videos (previously known as
312 Totem)[12]
313 You can disable the whole functionality by setting enabled=false in the
315 [MRPIS] section of the configuration file.
316 The configuration of this plugin is special. Plugin configuration is
318 not done on the plugin but rather per peer that is found providing the
319 MPRIS2 interface. See the following example to set the title for
320 Banshee on MPRIS:
321 [org.mpris.MediaPlayer2.banshee]
323 title=@REALNAME@'s Banshee on @HOSTNAME@
324 This plugin has no additional options.
326
328 rygel(1), gst-launch(1)
329
331 Jens Georg <mail@jensge.org>
332 Wrote this manpage.
333
335 1. file an IOP bug
336 https://gitlab.gnome.org/GNOME/rygel/issues/new/?issuable_template=IOP
337 2. GStreamer
339 http://gstreamer.freedesktop.org
340 3. tracker project website
342 https://wiki.gnome.org/Projects/Tracker
343 4. SQLite
345 http://sqlite.org
346 5. lightmediascanner daemon
348 https://github.com/profusion/lightmediascanner
349 6. MediaServer2 DBus interface specification
351 https://wiki.gnome.org/Projects/Rygel/MediaServer2Spec
352 7. gnome-dvb-daemon
354 https://wiki.gnome.org/Projects/DVBDaemon
355 8. Rhythmbox
357 http://www.rhythmbox.org
358 9. Grilo
360 https://wiki.gnome.org/Projects/Grilo
361 10. MPRIS2 DBus interface specification
363 https://specifications.freedesktop.org/mpris-spec/latest/
364 11. Banshee
366 http://banshee.fm
367 12. GNOME Videos (previously known as Totem)
369 https://wiki.gnome.org/Apps/Videos
370rygel 09/18/2021 RYGEL.CONF(5)