Rclone-serve

A fully self-contained rclone appliance: rclone's own official web GUI for guided remote setup (OAuth flows for OneDrive/Google Drive/Dropbox/etc.

  • Backup
  • Cloud
  • Tools & Utilities
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
  • TrueNAS (not listed)
  • Umbrel (not listed)
  • ZimaOS (not listed)
  • Proxmox (not listed)
  • Helm (not listed)
  • Mac (not listed)
  • Windows (not listed)
  • Linux (not listed)
  • Any server (not listed)

Health score?A 0-100 score computed nightly from four factors: maintained (40%: recent commits and steady activity), popular (25%: GitHub stars, log scale), easy to install (20%: platforms, install notes, setup guides, Docker image) and light to run (15%: minimum RAM, ARM support). When the source code has been checked, a fifth factor, security check (20%: automated scan for committed secrets, unsafe desktop-app settings, known-vulnerable dependencies and project hygiene; any serious finding caps it at 20), is added. Factors without data are left out and the rest are rescaled.

83/100 Excellent

Maintained
99last commit 39 days ago
Popular
9660,294 GitHub stars
Easy to install
351 install platform, install notes, Docker image
Light to run
No data

Based on 3 of 4 factors.

Availability: platform listings confirmed today, links checked 24 days ago

No GitHub repository data collected yet.

Resources & Compatibility

ARM (e.g. Raspberry Pi) is not supported.

Checked 54 days ago - source: Docker Hub image tags and published docs

First-install notes

  • Set up a storage remote first Run rclone config to create a named remote, such as an SFTP remote with the host, username, and password or SSH key. This saved remote is what you point the server at, so if you skip it there is no storage to serve. source
  • Start it on an open port When starting the server, set the address with an IP and port, such as addr=:8080, and choose a protocol like webdav or nfs. The port is the door you use to reach the files, so it must be open or clients cannot connect. source
  • Use the printed local URL If a GUI starts, open or save the printed local login URL from the log, such as http://127.0.0.1:50802/login?pass=.... It is a quick way to confirm the app is up and manage it, but keep the URL private because it carries the password. source

Fetched 54 days ago - each note links to its source

Alternatives

No alternatives collected yet.

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.

Answers sourced from github.com, github.com, github.com, rclone.org

Community

Collected 48 days ago - public community threads