github.com/ncw/rclone@v1.48.1-0.20190724201158-a35aa1360e3e/docs/content/commands/rclone_serve_ftp.md

github.com/ncw/rclone@v1.48.1-0.20190724201158-a35aa1360e3e/docs/content/commands/rclone_serve_ftp.md (about)

1 ---
2 date: 2019-06-20T16:09:42+01:00
3 title: "rclone serve ftp"
4 slug: rclone_serve_ftp
5 url: /commands/rclone_serve_ftp/
6 ---
7 ## rclone serve ftp
8
9 Serve remote:path over FTP.
10
11 ### Synopsis
12
13
14 rclone serve ftp implements a basic ftp server to serve the
15 remote over FTP protocol. This can be viewed with a ftp client
16 or you can make a remote of type ftp to read and write it.
17
18 ### Server options
19
20 Use --addr to specify which IP address and port the server should
21 listen on, eg --addr 1.2.3.4:8000 or --addr :8080 to listen to all
22 IPs. By default it only listens on localhost. You can use port
23 :0 to let the OS choose an available port.
24
25 If you set --addr to listen on a public or LAN accessible IP address
26 then using Authentication is advised - see the next section for info.
27
28 #### Authentication
29
30 By default this will serve files without needing a login.
31
32 You can set a single username and password with the --user and --pass flags.
33
34 ### Directory Cache
35
36 Using the `--dir-cache-time` flag, you can set how long a
37 directory should be considered up to date and not refreshed from the
38 backend. Changes made locally in the mount may appear immediately or
39 invalidate the cache. However, changes done on the remote will only
40 be picked up once the cache expires.
41
42 Alternatively, you can send a `SIGHUP` signal to rclone for
43 it to flush all directory caches, regardless of how old they are.
44 Assuming only one rclone instance is running, you can reset the cache
45 like this:
46
47 kill -SIGHUP $(pidof rclone)
48
49 If you configure rclone with a [remote control](/rc) then you can use
50 rclone rc to flush the whole directory cache:
51
52 rclone rc vfs/forget
53
54 Or individual files or directories:
55
56 rclone rc vfs/forget file=path/to/file dir=path/to/dir
57
58 ### File Buffering
59
60 The `--buffer-size` flag determines the amount of memory,
61 that will be used to buffer data in advance.
62
63 Each open file descriptor will try to keep the specified amount of
64 data in memory at all times. The buffered data is bound to one file
65 descriptor and won't be shared between multiple open file descriptors
66 of the same file.
67
68 This flag is a upper limit for the used memory per file descriptor.
69 The buffer will only use memory for data that is downloaded but not
70 not yet read. If the buffer is empty, only a small amount of memory
71 will be used.
72 The maximum memory used by rclone for buffering can be up to
73 `--buffer-size * open files`.
74
75 ### File Caching
76
77 These flags control the VFS file caching options. The VFS layer is
78 used by rclone mount to make a cloud storage system work more like a
79 normal file system.
80
81 You'll need to enable VFS caching if you want, for example, to read
82 and write simultaneously to a file. See below for more details.
83
84 Note that the VFS cache works in addition to the cache backend and you
85 may find that you need one or the other or both.
86
87 --cache-dir string Directory rclone will use for caching.
88 --vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s)
89 --vfs-cache-mode string Cache mode off|minimal|writes|full (default "off")
90 --vfs-cache-poll-interval duration Interval to poll the cache for stale objects. (default 1m0s)
91 --vfs-cache-max-size int Max total size of objects in the cache. (default off)
92
93 If run with `-vv` rclone will print the location of the file cache. The
94 files are stored in the user cache file area which is OS dependent but
95 can be controlled with `--cache-dir` or setting the appropriate
96 environment variable.
97
98 The cache has 4 different modes selected by `--vfs-cache-mode`.
99 The higher the cache mode the more compatible rclone becomes at the
100 cost of using disk space.
101
102 Note that files are written back to the remote only when they are
103 closed so if rclone is quit or dies with open files then these won't
104 get written back to the remote. However they will still be in the on
105 disk cache.
106
107 If using --vfs-cache-max-size note that the cache may exceed this size
108 for two reasons. Firstly because it is only checked every
109 --vfs-cache-poll-interval. Secondly because open files cannot be
110 evicted from the cache.
111
112 #### --vfs-cache-mode off
113
114 In this mode the cache will read directly from the remote and write
115 directly to the remote without caching anything on disk.
116
117 This will mean some operations are not possible
118
119 * Files can't be opened for both read AND write
120 * Files opened for write can't be seeked
121 * Existing files opened for write must have O_TRUNC set
122 * Files open for read with O_TRUNC will be opened write only
123 * Files open for write only will behave as if O_TRUNC was supplied
124 * Open modes O_APPEND, O_TRUNC are ignored
125 * If an upload fails it can't be retried
126
127 #### --vfs-cache-mode minimal
128
129 This is very similar to "off" except that files opened for read AND
130 write will be buffered to disks. This means that files opened for
131 write will be a lot more compatible, but uses the minimal disk space.
132
133 These operations are not possible
134
135 * Files opened for write only can't be seeked
136 * Existing files opened for write must have O_TRUNC set
137 * Files opened for write only will ignore O_APPEND, O_TRUNC
138 * If an upload fails it can't be retried
139
140 #### --vfs-cache-mode writes
141
142 In this mode files opened for read only are still read directly from
143 the remote, write only and read/write files are buffered to disk
144 first.
145
146 This mode should support all normal file system operations.
147
148 If an upload fails it will be retried up to --low-level-retries times.
149
150 #### --vfs-cache-mode full
151
152 In this mode all reads and writes are buffered to and from disk. When
153 a file is opened for read it will be downloaded in its entirety first.
154
155 This may be appropriate for your needs, or you may prefer to look at
156 the cache backend which does a much more sophisticated job of caching,
157 including caching directory hierarchies and chunks of files.
158
159 In this mode, unlike the others, when a file is written to the disk,
160 it will be kept on the disk after it is written to the remote. It
161 will be purged on a schedule according to `--vfs-cache-max-age`.
162
163 This mode should support all normal file system operations.
164
165 If an upload or download fails it will be retried up to
166 --low-level-retries times.
167
168
169 ```
170 rclone serve ftp remote:path [flags]
171 ```
172
173 ### Options
174
175 ```
176 --addr string IPaddress:Port or :Port to bind server to. (default "localhost:2121")
177 --dir-cache-time duration Time to cache directory entries for. (default 5m0s)
178 --dir-perms FileMode Directory permissions (default 0777)
179 --file-perms FileMode File permissions (default 0666)
180 --gid uint32 Override the gid field set by the filesystem. (default 1000)
181 -h, --help help for ftp
182 --no-checksum Don't compare checksums on up/download.
183 --no-modtime Don't read/write the modification time (can speed things up).
184 --no-seek Don't allow seeking in files.
185 --pass string Password for authentication. (empty value allow every password)
186 --passive-port string Passive port range to use. (default "30000-32000")
187 --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)
188 --public-ip string Public IP address to advertise for passive connections.
189 --read-only Mount read-only.
190 --uid uint32 Override the uid field set by the filesystem. (default 1000)
191 --umask int Override the permission bits set by the filesystem. (default 2)
192 --user string User name for authentication. (default "anonymous")
193 --vfs-cache-max-age duration Max age of objects in the cache. (default 1h0m0s)
194 --vfs-cache-max-size SizeSuffix Max total size of objects in the cache. (default off)
195 --vfs-cache-mode CacheMode Cache mode off|minimal|writes|full (default off)
196 --vfs-cache-poll-interval duration Interval to poll the cache for stale objects. (default 1m0s)
197 --vfs-read-chunk-size SizeSuffix Read the source objects in chunks. (default 128M)
198 --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)
199 ```
200
201 See the [global flags page](/flags/) for global options not listed here.
202
203 ### SEE ALSO
204
205 * [rclone serve](/commands/rclone_serve/) - Serve a remote over a protocol.
206