# Rclone-serve

Rclone-serve is a self-hosted backup app. A fully self-contained rclone appliance: rclone's own official web GUI for guided remote setup (OAuth flows for OneDrive/Google Drive/Dropbox/etc. It is open source and self-hosted, installable on Docker Hub and Unraid.

Canonical page: https://ourlocalhost.com/app/2567/rclone-serve

## Description

A fully self-contained rclone appliance: rclone's own official web GUI for guided remote setup (OAuth flows for OneDrive/Google Drive/Dropbox/etc. included) plus rclone serve to expose a configured remote over a protocol other tools already speak - most usefully restic's own REST backend - so restic can talk to a cloud provider it has no native driver for directly, without a separate scheduled sync job in between. Owns its own config entirely; no dependency on any other rclone install.

## Platform availability

Available on 1 of 10 platforms: Unraid.

## Health score

83/100 (Excellent), based on 3 of 4 factors.
- Maintained: 99 (last commit 39 days ago)
- Popular: 96 (60,294 GitHub stars)
- Easy to install: 35 (1 install platform, install notes, Docker image)

## Links

- Docker Hub: https://hub.docker.com/repository/docker/mcjoppy/rclone-serve
- Official website: https://git.home.hudsonstreet.co.nz/mcjoppy/rclone-serve
- Unraid: https://ca.unraid.net/apps/rclone-serve-1b7hvcu1c2v8ei?q=rclone-serve

## Common questions

### Do I need to create an rclone remote before rclone-serve can expose a path?

Yes, run rclone config to create a named remote first. The saved remote is what the server points at, so if you skip it there is no storage to serve.

### Which port must be available for clients to connect to a served remote?

Start the server with an address and open port, such as :8080. The port must be open, otherwise clients cannot connect.

### How do I access the rclone GUI after startup?

Open the local login URL printed in the log. It carries the password, so keep it private.

### Why might rclone-serve use a lot of memory?

The most common cause is a single directory with millions of files. Before v1.70, rclone must load that directory entirely into memory as rclone objects.

---
Source: Our Local Host (https://ourlocalhost.com/app/2567/rclone-serve), the self-hosted and open-source app directory.
