minidlna.conf.5

   1 .\" Man page for minidlna.conf
   2 .\"
   3 .\" This man page is based on the comments in the default configuration file
   4 .\" shipped with the minidlna source. Consequently, it is licensed under the
   5 .\" GPLv2.
   6 .\"
   7 .\" Copyright (C) 2009 Justin Maggard <jmaggard@users.sourceforge.net>
   8 .\" Copyright (C) 2010-2011 Benoît Knecht <benoit.knecht@fsfe.org>
   9 .\"
  10 .\"    This package is free software; you can redistribute it and/or modify
  11 .\"    it under the terms of the GNU General Public License version 2 as
  12 .\"    published by the Free Software Foundation.
  13 .\"
  14 .\"    This package is distributed in the hope that it will be useful,
  15 .\"    but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 .\"    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17 .\"    GNU General Public License for more details.
  18 .\"
  19 .\"    You should have received a copy of the GNU General Public License
  20 .\"    along with this program. If not, see <http://www.gnu.org/licenses/>
  21 .\"
  22 .\" On Debian systems, the complete text of the GNU General
  23 .\" Public License version 2 can be found in "/usr/share/common-licenses/GPL-2".
  24 .Dd July 21, 2012
  25 .Dt MINIDLNA.CONF \&5 "File Formats Manual"
  26 .Os Debian
  27 .Sh NAME
  28 .Nm minidlna.conf
  29 .Nd MiniDLNA server configuration file
  30 .Sh SYNOPSIS
  31 .Nm /etc/minidlna.conf
  32 .Sh DESCRIPTION
  33 .Xr minidlna 1
  34 reads configuration options from the system-wide configuration file
  35 .Pa /etc/minidlna.conf ,
  36 or the file specified with
  37 .Fl f
  38 on the command line. The file contains keyword-argument pairs, one per line.
  39 Lines starting with
  40 .Ql #
  41 and empty lines are interpreted as comments.
  42 .Pp
  43 The possible
  44 keywords and their meanings are as follows:
  45 .Bl -tag -width Ds
  46 .It Cm album_art_names
  47 List of filenames to check for when searching for album art cache, separated by
  48 forward slashes
  49 .Pq Ql / .
  50 This option can be specified more than once.
  51 .It Cm db_dir
  52 Path to the directory
  53 .Nm minidlna
  54 should use to store its database and album art cache. Uses
  55 .Pa /var/lib/minidlna
  56 by default.
  57 .It Cm enable_tivo
  58 Set to
  59 .Dq yes
  60 to enable support for streaming JPEG and mp3 files to a TiVo supporting HMO.
  61 Set to
  62 .Dq no
  63 otherwise.
  64 .It Cm friendly_name
  65 Customize the name that the
  66 .Nm minidlna
  67 server sends to clients. Defaults to
  68 .Dq hostname:\ username .
  69 .It Cm inotify
  70 Set to
  71 .Dq yes
  72 to enable inotify monitoring of the files under
  73 .Cm media_dir
  74 to automatically discover new files. Set to
  75 .Dq no
  76 to disable inotify.
  77 .It Cm listening_ip
  78 IPv4 address
  79 .Nm minidlna
  80 should listen on
  81 .Pq e.g. Dq 198.51.100.1/24 .
  82 If omitted, the mask defaults to /24. This option can be specified more than
  83 once. If unspecified or empty,
  84 .Nm minidlna
  85 binds to the network interfaces given in
  86 .Cm network_interface ;
  87 if it is also unspecified or empty, it binds to all the valid network
  88 interfaces
  89 .Pq except loopback .
  90 .It Cm log_dir
  91 Path to the directory where the log file should be stored. Defaults to
  92 .Pa /var/log .
  93 .It Cm log_level
  94 Defines the type of messages that should be logged, and down to which level of
  95 importance they should be considered.
  96 .Pp
  97 The possible types are
  98 .Dq artwork ,
  99 .Dq database ,
 100 .Dq general ,
 101 .Dq http ,
 102 .Dq inotify ,
 103 .Dq metadata ,
 104 .Dq scanner ,
 105 .Dq ssdp
 106 and
 107 .Dq tivo .
 108 .Pp
 109 The levels are
 110 .Dq off ,
 111 .Dq fatal ,
 112 .Dq error ,
 113 .Dq warn ,
 114 .Dq info
 115 and
 116 .Dq debug ,
 117 listed here in order of decreasing importance.
 118 .Dq off
 119 turns off logging messages entirely,
 120 .Dq fatal
 121 logs the most critical messages only, and so on down to
 122 .Dq debug
 123 that logs every single messages.
 124 .Pp
 125 The types are comma-separated, followed by an equal sign
 126 .Pq Ql = ,
 127 followed by a level that applies to the preceding types. This can be repeated,
 128 separating each of these constructs with a comma.
 129 .Pp
 130 Defaults to
 131 .Dq general,\:artwork,\:database,\:inotify,\:scanner,\:metadata,\:http,\:\
 132 ssdp,\:tivo=warn
 133 which logs every type of message at the
 134 .Dq warn
 135 level.
 136 .It Cm media_dir
 137 Path to the directory containing the media files the
 138 .Nm minidlna
 139 server should share. Use this option several times if you have more than one
 140 directory to share. To restrict a path to one specific media type, you can use
 141 the following syntax: the letter
 142 .Ql A ,
 143 .Ql V
 144 or
 145 .Ql P ,
 146 followed by a comma
 147 .Pq Ql \&,
 148 followed by the path. The meaning of the first letter is as follows:
 149 .Bl -bullet -offset indent -compact
 150 .It
 151 .Ql A
 152 for audio files;
 153 .It
 154 .Ql V
 155 for video files;
 156 .It
 157 .Ql P
 158 for image files.
 159 .El
 160 For example, if you want to include only video files located under the
 161 .Pa /opt/media/videos
 162 directory, you would use
 163 .Cm media_dir=V,/opt/media/videos .
 164 .Pp
 165 After making changes to this option, you need to rebuild the database.
 166 If you use an init script to start/stop
 167 .Nm minidlna,
 168 then you should run
 169 .Pq as root
 170 .Ic service
 171 .Cm minidlna
 172 .Cm force-reload .
 173 Otherwise, just add
 174 .Fl R
 175 to your usual
 176 .Nm minidlna
 177 command line
 178 .Po
 179 .Ic minidlna
 180 .Op ...
 181 .Fl R
 182 .Pc .
 183 .It Cm minissdpdsocket
 184 Path to the MiniSSDPd socket, if you want to use
 185 .Nm minidlna
 186 together with MiniSSDPd. Defaults to
 187 .Pa /run/minissdpd.sock .
 188 .It Cm model_name
 189 Set the model name reported to clients.
 190 Defaults to
 191 .Dq Windows Media Connect compatible (MiniDLNA) .
 192 .It Cm model_number
 193 Set the model number reported to clients. Defaults to the version number of
 194 .Nm minidlna .
 195 .It Cm network_interface
 196 Network interface(s) to bind to
 197 .Pq e.g. eth0 ,
 198 comma delimited. This option can be specified more than once. If unspecified or empty,
 199 .Nm minidlna
 200 binds to the IPs given in
 201 .Cm listening_ip ;
 202 if it is also unspecified or empty, it binds to all the valid network
 203 interfaces
 204 .Pq except loopback .
 205 .It Cm notify_interval
 206 Set the notify interval, in seconds. The default is 895 seconds.
 207 .It Cm port
 208 Port number for HTTP traffic
 209 .Pq descriptions, SOAP, media transfe .
 210 This option is mandatory, unless the port number is specified on the
 211 command-line using
 212 .Fl p Pq see Xr minidlna 1 .
 213 .It Cm presentation_url
 214 Define the URL presented to clients
 215 .Pq e.g. Dq http://example.com:80 .
 216 The default is
 217 .Ql / .
 218 .It Cm root_container
 219 Use a different container as the root of the tree exposed to clients. The
 220 possible values
 221 .Bl -bullet -offset indent -compact
 222 .It
 223 .Ql \&.
 224 to use the standard container (this is the default);
 225 .It
 226 .Ql B
 227 to use the
 228 .Dq Browse Directory
 229 container;
 230 .It
 231 .Ql M
 232 to use the
 233 .Dq Music
 234 container;
 235 .It
 236 .Ql V
 237 to use the
 238 .Dq Video
 239 container;
 240 .It
 241 .Ql P
 242 to use the
 243 .Dq Pictures
 244 container.
 245 .El
 246 If you specify
 247 .Ql B
 248 and the client device is audio only, then
 249 .Dq Music/Folders
 250 will be used as the root container.
 251 .It Cm serial
 252 Set the serial number reported to clients. Defaults to
 253 .Dq 00000000 .
 254 .It Cm strict_dlna
 255 Set to
 256 .Dq yes
 257 to strictly adhere to DLNA standards. This will allow server-side downscaling
 258 of very large JPEG images, which may hurt JPEG serving performance on (at
 259 least) Sony DLNA products. Set to
 260 .Dq no
 261 otherwise.
 262 .El
 263 .Sh FILES
 264 .Bl -tag -width Ds
 265 .It Pa /etc/minidlna.conf
 266 System-wide default configuration file.
 267 .El
 268 .Sh SEE ALSO
 269 .Xr minidlna 1