mirror of
https://github.com/rclone/rclone.git
synced 2025-12-11 22:14:05 +01:00
docs: make command docs titles be one higher
This commit is contained in:
@@ -1,16 +1,16 @@
|
||||
---
|
||||
date: 2020-05-18T10:38:09+01:00
|
||||
date: 2020-05-22T09:52:00+01:00
|
||||
title: "rclone serve http"
|
||||
description: "Serve the remote over HTTP."
|
||||
slug: rclone_serve_http
|
||||
url: /commands/rclone_serve_http/
|
||||
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/serve/http/ and as part of making a release run "make commanddocs"
|
||||
---
|
||||
## rclone serve http
|
||||
# rclone serve http
|
||||
|
||||
Serve the remote over HTTP.
|
||||
|
||||
### Synopsis
|
||||
## Synopsis
|
||||
|
||||
rclone serve http implements a basic web server to serve the remote
|
||||
over HTTP. This can be viewed in a web browser or you can make a
|
||||
@@ -24,7 +24,7 @@ The server will log errors. Use -v to see access logs.
|
||||
--bwlimit will be respected for file transfers. Use --stats to
|
||||
control the stats printing.
|
||||
|
||||
### Server options
|
||||
## Server options
|
||||
|
||||
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
|
||||
@@ -72,7 +72,7 @@ to be used within the template to server pages:
|
||||
|-- .Size | Size in Bytes of the entry. |
|
||||
|-- .ModTime | The UTC timestamp of an entry. |
|
||||
|
||||
#### Authentication
|
||||
### Authentication
|
||||
|
||||
By default this will serve files without needing a login.
|
||||
|
||||
@@ -93,19 +93,19 @@ The password file can be updated while rclone is running.
|
||||
|
||||
Use --realm to set the authentication realm.
|
||||
|
||||
#### SSL/TLS
|
||||
### SSL/TLS
|
||||
|
||||
By default this will serve over http. If you want you can serve over
|
||||
https. You will need to supply the --cert and --key flags. If you
|
||||
wish to do client side certificate validation then you will need to
|
||||
supply --client-ca also.
|
||||
|
||||
--cert should be a either a PEM encoded certificate or a concatenation
|
||||
--cert should be either a PEM encoded certificate or a concatenation
|
||||
of that with the CA certificate. --key should be the PEM encoded
|
||||
private key and --client-ca should be the PEM encoded client
|
||||
certificate authority certificate.
|
||||
|
||||
### Directory Cache
|
||||
## Directory Cache
|
||||
|
||||
Using the `--dir-cache-time` flag, you can set how long a
|
||||
directory should be considered up to date and not refreshed from the
|
||||
@@ -131,7 +131,7 @@ Or individual files or directories:
|
||||
|
||||
rclone rc vfs/forget file=path/to/file dir=path/to/dir
|
||||
|
||||
### File Buffering
|
||||
## File Buffering
|
||||
|
||||
The `--buffer-size` flag determines the amount of memory,
|
||||
that will be used to buffer data in advance.
|
||||
@@ -148,7 +148,7 @@ will be used.
|
||||
The maximum memory used by rclone for buffering can be up to
|
||||
`--buffer-size * open files`.
|
||||
|
||||
### File Caching
|
||||
## File Caching
|
||||
|
||||
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
|
||||
@@ -185,7 +185,7 @@ for two reasons. Firstly because it is only checked every
|
||||
--vfs-cache-poll-interval. Secondly because open files cannot be
|
||||
evicted from the cache.
|
||||
|
||||
#### --vfs-cache-mode off
|
||||
### --vfs-cache-mode off
|
||||
|
||||
In this mode the cache will read directly from the remote and write
|
||||
directly to the remote without caching anything on disk.
|
||||
@@ -200,7 +200,7 @@ This will mean some operations are not possible
|
||||
* Open modes O_APPEND, O_TRUNC are ignored
|
||||
* If an upload fails it can't be retried
|
||||
|
||||
#### --vfs-cache-mode minimal
|
||||
### --vfs-cache-mode minimal
|
||||
|
||||
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
|
||||
@@ -213,7 +213,7 @@ These operations are not possible
|
||||
* Files opened for write only will ignore O_APPEND, O_TRUNC
|
||||
* If an upload fails it can't be retried
|
||||
|
||||
#### --vfs-cache-mode writes
|
||||
### --vfs-cache-mode writes
|
||||
|
||||
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
|
||||
@@ -223,7 +223,7 @@ This mode should support all normal file system operations.
|
||||
|
||||
If an upload fails it will be retried up to --low-level-retries times.
|
||||
|
||||
#### --vfs-cache-mode full
|
||||
### --vfs-cache-mode full
|
||||
|
||||
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.
|
||||
@@ -241,7 +241,7 @@ 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.
|
||||
|
||||
### Case Sensitivity
|
||||
## Case Sensitivity
|
||||
|
||||
Linux file systems are case-sensitive: two files can differ only
|
||||
by case, and the exact case must be used when opening a file.
|
||||
@@ -282,7 +282,7 @@ otherwise. If the flag is provided without a value, then it is "true".
|
||||
rclone serve http remote:path [flags]
|
||||
```
|
||||
|
||||
### Options
|
||||
## Options
|
||||
|
||||
```
|
||||
--addr string IPaddress:Port or :Port to bind server to. (default "localhost:8080")
|
||||
@@ -317,13 +317,13 @@ rclone serve http remote:path [flags]
|
||||
--vfs-case-insensitive If a file name not found, find a case insensitive match.
|
||||
--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)
|
||||
--vfs-read-wait duration Time to wait for in-sequence read before seeking. (default 5ms)
|
||||
--vfs-read-wait duration Time to wait for in-sequence read before seeking. (default 20ms)
|
||||
--vfs-write-wait duration Time to wait for in-sequence write before giving error. (default 1s)
|
||||
```
|
||||
|
||||
See the [global flags page](/flags/) for global options not listed here.
|
||||
|
||||
### SEE ALSO
|
||||
## SEE ALSO
|
||||
|
||||
* [rclone serve](/commands/rclone_serve/) - Serve a remote over a protocol.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user