2019-02-09 18:42:57 +08:00
---
2020-05-22 19:22:52 +08:00
date: 2020-05-22T15:09:46+01:00
2019-02-09 18:42:57 +08:00
title: "rclone serve dlna"
2020-05-16 22:11:55 +08:00
description: "Serve remote:path over DLNA"
2019-02-09 18:42:57 +08:00
slug: rclone_serve_dlna
url: /commands/rclone_serve_dlna/
2020-02-10 20:31:45 +08:00
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/serve/dlna/ and as part of making a release run "make commanddocs"
2019-02-09 18:42:57 +08:00
---
2020-05-22 18:17:37 +08:00
# rclone serve dlna
2019-02-09 18:42:57 +08:00
Serve remote:path over DLNA
2020-05-22 18:17:37 +08:00
## Synopsis
2019-02-09 18:42:57 +08:00
rclone serve dlna is a DLNA media server for media stored in a rclone remote. Many
devices, such as the Xbox and PlayStation, can automatically discover this server in the LAN
and play audio/video from it. VLC is also supported. Service discovery uses UDP multicast
packets (SSDP) and will thus only work on LANs.
Rclone will list all files present in the remote, without filtering based on media formats or
file extensions. Additionally, there is no media transcoding support. This means that some
players might show files that they are not able to play back correctly.
2020-05-22 18:17:37 +08:00
## Server options
2019-02-09 18:42:57 +08:00
Use --addr to specify which IP address and port the server should
listen on, eg --addr 1.2.3.4:8000 or --addr :8080 to listen to all
IPs.
2019-06-15 19:01:29 +08:00
Use --name to choose the friendly server name, which is by
default "rclone (hostname)".
Use --log-trace in conjunction with -vv to enable additional debug
logging of all UPNP traffic.
2019-02-09 18:42:57 +08:00
2020-05-22 18:17:37 +08:00
## Directory Cache
2019-02-09 18:42:57 +08:00
Using the `--dir-cache-time` flag, you can set how long a
directory should be considered up to date and not refreshed from the
backend. Changes made locally in the mount may appear immediately or
invalidate the cache. However, changes done on the remote will only
2020-02-10 23:00:32 +08:00
be picked up once the cache expires if the backend configured does not
support polling for changes. If the backend supports polling, changes
will be picked up on within the polling interval.
2019-02-09 18:42:57 +08:00
Alternatively, you can send a `SIGHUP` signal to rclone for
it to flush all directory caches, regardless of how old they are.
Assuming only one rclone instance is running, you can reset the cache
like this:
kill -SIGHUP $(pidof rclone)
If you configure rclone with a [remote control ](/rc ) then you can use
rclone rc to flush the whole directory cache:
rclone rc vfs/forget
Or individual files or directories:
rclone rc vfs/forget file=path/to/file dir=path/to/dir
2020-05-22 18:17:37 +08:00
## File Buffering
2019-02-09 18:42:57 +08:00
The `--buffer-size` flag determines the amount of memory,
that will be used to buffer data in advance.
Each open file descriptor will try to keep the specified amount of
data in memory at all times. The buffered data is bound to one file
descriptor and won't be shared between multiple open file descriptors
of the same file.
This flag is a upper limit for the used memory per file descriptor.
The buffer will only use memory for data that is downloaded but not
not yet read. If the buffer is empty, only a small amount of memory
will be used.
The maximum memory used by rclone for buffering can be up to
`--buffer-size * open files` .
2020-05-22 18:17:37 +08:00
## File Caching
2019-02-09 18:42:57 +08:00
These flags control the VFS file caching options. The VFS layer is
used by rclone mount to make a cloud storage system work more like a
normal file system.
You'll need to enable VFS caching if you want, for example, to read
and write simultaneously to a file. See below for more details.
Note that the VFS cache works in addition to the cache backend and you
may find that you need one or the other or both.
--cache-dir string Directory rclone will use for caching.
--vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s)
--vfs-cache-mode string Cache mode off|minimal|writes|full (default "off")
--vfs-cache-poll-interval duration Interval to poll the cache for stale objects. (default 1m0s)
--vfs-cache-max-size int Max total size of objects in the cache. (default off)
If run with `-vv` rclone will print the location of the file cache. The
files are stored in the user cache file area which is OS dependent but
can be controlled with `--cache-dir` or setting the appropriate
environment variable.
The cache has 4 different modes selected by `--vfs-cache-mode` .
The higher the cache mode the more compatible rclone becomes at the
cost of using disk space.
Note that files are written back to the remote only when they are
closed so if rclone is quit or dies with open files then these won't
get written back to the remote. However they will still be in the on
disk cache.
If using --vfs-cache-max-size note that the cache may exceed this size
for two reasons. Firstly because it is only checked every
--vfs-cache-poll-interval. Secondly because open files cannot be
evicted from the cache.
2020-05-22 18:17:37 +08:00
### --vfs-cache-mode off
2019-02-09 18:42:57 +08:00
In this mode the cache will read directly from the remote and write
directly to the remote without caching anything on disk.
This will mean some operations are not possible
* Files can't be opened for both read AND write
* Files opened for write can't be seeked
* Existing files opened for write must have O_TRUNC set
* Files open for read with O_TRUNC will be opened write only
* Files open for write only will behave as if O_TRUNC was supplied
* Open modes O_APPEND, O_TRUNC are ignored
* If an upload fails it can't be retried
2020-05-22 18:17:37 +08:00
### --vfs-cache-mode minimal
2019-02-09 18:42:57 +08:00
This is very similar to "off" except that files opened for read AND
write will be buffered to disks. This means that files opened for
write will be a lot more compatible, but uses the minimal disk space.
These operations are not possible
* Files opened for write only can't be seeked
* Existing files opened for write must have O_TRUNC set
* Files opened for write only will ignore O_APPEND, O_TRUNC
* If an upload fails it can't be retried
2020-05-22 18:17:37 +08:00
### --vfs-cache-mode writes
2019-02-09 18:42:57 +08:00
In this mode files opened for read only are still read directly from
the remote, write only and read/write files are buffered to disk
first.
This mode should support all normal file system operations.
If an upload fails it will be retried up to --low-level-retries times.
2020-05-22 18:17:37 +08:00
### --vfs-cache-mode full
2019-02-09 18:42:57 +08:00
In this mode all reads and writes are buffered to and from disk. When
a file is opened for read it will be downloaded in its entirety first.
This may be appropriate for your needs, or you may prefer to look at
the cache backend which does a much more sophisticated job of caching,
including caching directory hierarchies and chunks of files.
In this mode, unlike the others, when a file is written to the disk,
it will be kept on the disk after it is written to the remote. It
will be purged on a schedule according to `--vfs-cache-max-age` .
This mode should support all normal file system operations.
If an upload or download fails it will be retried up to
--low-level-retries times.
2020-05-22 18:17:37 +08:00
## Case Sensitivity
2020-02-10 22:52:31 +08:00
Linux file systems are case-sensitive: two files can differ only
by case, and the exact case must be used when opening a file.
Windows is not like most other operating systems supported by rclone.
File systems in modern Windows are case-insensitive but case-preserving:
although existing files can be opened using any case, the exact case used
to create the file is preserved and available for programs to query.
It is not allowed for two files in the same directory to differ only by case.
Usually file systems on MacOS are case-insensitive. It is possible to make MacOS
file systems case-sensitive but that is not the default
The "--vfs-case-insensitive" mount flag controls how rclone handles these
two cases. If its value is "false", rclone passes file names to the mounted
file system as is. If the flag is "true" (or appears without a value on
command line), rclone may perform a "fixup" as explained below.
The user may specify a file name to open/delete/rename/etc with a case
different than what is stored on mounted file system. If an argument refers
to an existing file with exactly the same name, then the case of the existing
file on the disk will be used. However, if a file name with exactly the same
name is not found but a name differing only by case exists, rclone will
transparently fixup the name. This fixup happens only when an existing file
is requested. Case sensitivity of file names created anew by rclone is
controlled by an underlying mounted file system.
Note that case sensitivity of the operating system running rclone (the target)
may differ from case sensitivity of a file system mounted by rclone (the source).
The flag controls whether "fixup" is performed to satisfy the target.
If the flag is not provided on command line, then its default value depends
on the operating system where rclone runs: "true" on Windows and MacOS, "false"
otherwise. If the flag is provided without a value, then it is "true".
2019-02-09 18:42:57 +08:00
```
rclone serve dlna remote:path [flags]
```
2020-05-22 18:17:37 +08:00
## Options
2019-02-09 18:42:57 +08:00
```
--addr string ip:port or :port to bind the DLNA http server to. (default ":7879")
--dir-cache-time duration Time to cache directory entries for. (default 5m0s)
--dir-perms FileMode Directory permissions (default 0777)
--file-perms FileMode File permissions (default 0666)
2019-06-15 19:01:29 +08:00
--gid uint32 Override the gid field set by the filesystem. (default 1000)
2019-02-09 18:42:57 +08:00
-h, --help help for dlna
2019-06-15 19:01:29 +08:00
--log-trace enable trace logging of SOAP traffic
--name string name of DLNA server
2019-02-09 18:42:57 +08:00
--no-checksum Don't compare checksums on up/download.
--no-modtime Don't read/write the modification time (can speed things up).
--no-seek Don't allow seeking in files.
--poll-interval duration Time to wait between polling for changes. Must be smaller than dir-cache-time. Only on supported remotes. Set to 0 to disable. (default 1m0s)
--read-only Mount read-only.
2019-06-15 19:01:29 +08:00
--uid uint32 Override the uid field set by the filesystem. (default 1000)
2019-02-09 18:42:57 +08:00
--umask int Override the permission bits set by the filesystem. (default 2)
--vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s)
--vfs-cache-max-size SizeSuffix Max total size of objects in the cache. (default off)
--vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off)
--vfs-cache-poll-interval duration Interval to poll the cache for stale objects. (default 1m0s)
2019-10-26 18:04:54 +08:00
--vfs-case-insensitive If a file name not found, find a case insensitive match.
2019-02-09 18:42:57 +08:00
--vfs-read-chunk-size SizeSuffix Read the source objects in chunks. (default 128M)
--vfs-read-chunk-size-limit SizeSuffix If greater than --vfs-read-chunk-size, double the chunk size after each chunk read, until the limit is reached. 'off' is unlimited. (default off)
2020-05-22 18:17:37 +08:00
--vfs-read-wait duration Time to wait for in-sequence read before seeking. (default 20ms)
2020-05-16 22:11:55 +08:00
--vfs-write-wait duration Time to wait for in-sequence write before giving error. (default 1s)
2019-02-09 18:42:57 +08:00
```
2019-06-20 23:18:02 +08:00
See the [global flags page ](/flags/ ) for global options not listed here.
2020-05-22 18:17:37 +08:00
## SEE ALSO
2019-02-09 18:42:57 +08:00
* [rclone serve ](/commands/rclone_serve/ ) - Serve a remote over a protocol.
