/rclone_serve_http

title: "rclone serve http"
description: "Serve the remote over HTTP."
versionIntroduced: v1.39
# autogenerated - DO NOT EDIT, instead edit the source code in cmd/serve/http/ and as part of making a release run "make commanddocs"

> **Official documentation:** [https://rclone.org/commands/rclone_serve_http/](https://rclone.org/commands/rclone_serve_http/)

rclone serve http

Serve the remote over HTTP.

Synopsis

Run a basic web server to serve a remote over HTTP. This can be viewed in a web browser or you can make a remote of type http read from it.

You can use the filter flags (e.g. `--include`, `--exclude`) to control what is served.

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

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. By default it only listens on localhost. You can use port :0 to let the OS choose an available port.

If you set `--addr` to listen on a public or LAN accessible IP address then using Authentication is advised - see the next section for info.

You can use a unix socket by setting the url to `unix:///path/to/socket` or just by using an absolute path name.

`--addr` may be repeated to listen on multiple IPs/ports/sockets. Socket activation, described further below, can also be used to accomplish the same.

`--server-read-timeout` and `--server-write-timeout` can be used to control the timeouts on the server. Note that this is the total time for a transfer.

`--max-header-bytes` controls the maximum number of bytes the server will accept in the HTTP header.

`--baseurl` controls the URL prefix that rclone serves from. By default rclone will serve from the root. If you used `--baseurl "/rclone"` then rclone would serve from a URL starting with "/rclone/". This is useful if you wish to proxy rclone serve. Rclone automatically inserts leading and trailing "/" on `--baseurl`, so `--baseurl "rclone"`, `--baseurl "/rclone"` and `--baseurl "/rclone/"` are all treated identically.

`--disable-zip` may be set to disable the zipping download option.

TLS (SSL)

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` must be set to the path of a file containing either a PEM encoded certificate, or a concatenation of that with the CA certificate. `--key` must be set to the path of a file with the PEM encoded private key. If setting `--client-ca`, it should be set to the path of a file with PEM encoded client certificate authority certificates.

`--min-tls-version` is minimum TLS version that is acceptable. Valid values are "tls1.0", "tls1.1", "tls1.2" and "tls1.3" (default "tls1.0").

Socket activation

Instead of the listening addresses specified above, rclone will listen to all FDs passed by the service manager, if any (and ignore any arguments passed by `--addr`).

This allows rclone to be a socket-activated service. It can be configured with .socket and .service unit files as described in <https://www.freedesktop.org/software/systemd/man/latest/systemd.socket.html>.

Socket activation can be tested ad-hoc with the `systemd-socket-activate`command

systemd-socket-activate -l 8000 -- rclone serve

This will socket-activate rclone on the first connection to port 8000 over TCP.

Template

`--template` allows a user to specify a custom markup template for HTTP and WebDAV serve functions. The server exports the following markup to be used within the template to server pages:

| Parameter | Subparameter | Description | | :---------- | :----------- | :---------- | | .Name | | The full path of a file/directory. | | .Title | | Directory listing of '.Name'. | | .Sort | | The current sort used. This is changeable via '?sort=' parameter. Possible values: namedirfirst, name, size, time (default namedirfirst). | | .Order | | The current ordering used. This is changeable via '?order=' parameter. Possible values: asc, desc (default asc). | | .Query | | Currently unused. | | .Breadcrumb | | Allows for creating a relative navigation. | | | .Link | The link of the Text relative to the root. | | | .Text | The Name of the directory. | | .Entries | | Information about a specific file/directory. | | | .URL | The url of an entry. | | | .Leaf | Currently same as '.URL' but intended to be just the name. | | | .IsDir | Boolean for if an entry is a directory or not. | | | .Size | Size in bytes of the entry. | | | .ModTime | The UTC timestamp of an entry. |

The server also makes the following functions available so that they can be used within the template. These functions help extend the options for dynamic rendering of HTML. They can be used to render HTML based on specific conditions.

| Function | Description | | :---------- | :---------- | | afterEpoch | Returns the time since the epoch for the given time. | | contains | Checks whether a given substring is present or not in a given string. | | hasPrefix | Checks whether the given string begins with the specified prefix. | | hasSuffix | Checks whether the given string end with the specified suffix. |

Authentication

By default this will serve files without needing a login.

You can either use an htpasswd file which can take lots of users, or set a single username and password with the `--user` and `--pass` flags.

Alternatively, you can have the reverse proxy manage authentication and use the username provided in the configured head