rclone / rclone/rclone

BYO Storage Provider

Open
#7,844 0 comments 6 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

new backend
Dominant language
Go
Stars
59.8k
Forks
5.4k
Avg merge
2d 14h
Merged PRs (30d)
48

Description

Hi,

I'm wondering if rclone could implement a sort of BYO Storage Provider, which allows an external program to provide the IO operations.

For example, rclone config would collect the following things from the user:

Command to get all file system entries:
        acme_proprietary.exe --list-all

Command to get file system entries in folder:
        acme_proprietary.exe --list $FOLDER

Command to retrieve file:
        acme_proprietary.exe --download $PATH --destination $DESTINATION

Command to delete file:
        acme_proprietary.exe --delete $PATH

Command to write file:
        acme_proprietary.exe --write $PATH --source $SOURCE

This would allow anyone to implement their own provider, without having to involve the rclone developers or have obscure providers added to the mainline code.

The associated forum post

None found

What is your current rclone version (output from rclone version)?

1.66.0

What problem are you are trying to solve?

I'd like to connect to many providers (BitBucket, proprietary PLM tools, sshfs), without asking the rclone developers to implement these. I could then get the benefits which rclone provides, such as serving the remote files over HTTP/WebDAV/FTP/SFTP/DLNA.

How do you think rclone should be changed to solve that?

By implementing a new provider which allows an external command to provide the IO operations.

How to use GitHub
  • Please use the 👍 reaction to show that you are affected by the same issue.
  • Please don't comment if you have no relevant information to add. It's just extra noise for everyone subscribed to this issue.
  • Subscribe to receive notifications on status change and new comments.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No files or tests are identified. Start by reviewing rclone's existing remote-provider and rclone config entry points, then determine how external commands would cover listing, retrieval, deletion, and writing. Done would mean a documented provider can invoke those operations and expose the resulting remote through rclone's existing services.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
backend, cli
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.