Skip to content

Commit 425ce41

Browse files
committed
doc: rclone serve to run RCLONE_SERVE_MODE
See: 224d28c
1 parent 5ed68f2 commit 425ce41

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,24 @@ Please note that variables only with capital letters are configurable by environ
9898
| `RCLONE_LOG_FILE` | to redirect logging to file | |
9999
| `RCLONE_MOUNT_USER_OPTS` | additioanl arguments will be appended to the basic options in the above command | |
100100

101+
### rclone serve
102+
103+
You can serve a folder tree mounted by `rclone mount` using the `RCLONE_SERVE_MODE` environment variable. This auxiliary service allows you to take advantage of cached contents without having to redefine the `--vfs-*` flags.
104+
105+
Here is the internal command for rclone serve
106+
107+
```bash
108+
rclone serve ${RCLONE_SERVE_MODE} ${rclone_mountpoint} \
109+
${RCLONE_SERVE_ARGS:---use-mmap --addr=:5678}
110+
```
111+
112+
, where related environment variables are
113+
114+
| ENV | Description | Default |
115+
|---|---|---|
116+
| `RCLONE_SERVE_MODE` | one of `dlna`, `docker`, `ftp`, `http`, `restic`, `sftp`, `webdav` | |
117+
| `RCLONE_SERVE_ARGS` | arguments for `rclone serve` | `--use-mmap --addr=:5678` |
118+
101119
## [mergerfs](https://github.com/trapexit/mergerfs) or unionfs (optional)
102120

103121
Along with the rclone folder, you can specify one local directory to be mergerfs with by `POOLING_FS=mergerfs`. Internally, it will execute a following command

0 commit comments

Comments
 (0)