culturecloud / rclone-index

Serve your Rclone remotes as public/private index through HTTP, WebDAV.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Rclone Index

Serve your Rclone remotes as a public/private index through HTTP/WebDAV, on free tier PaaS like Replit, Render, Railway etc.

Features

  • Multiple Rclone remotes in a single index.
  • Can also be used to only serve a single remote.
  • Permalink for every file on all of your remotes.
  • Index and file links are secured with Basic Auth.
  • Built-in config file encryption support. Read this.
  • Customizable index template.
  • Ease of use thanks to automated shell scripts.
  • Dark mode.

NOTES:

  • Most of them are features of Rclone.
  • File links will not change as long as you don't rename your remotes.

Variables

  • AUTH_USER: Username for basic authentication.
  • AUTH_PASS: Password for basic authentication.
  • PORT: Your server port.
  • SERVE_REMOTE: The remote you want to serve in index. You can set it to serve a single remote or make a combine remote to serve multiple remotes in a single index. The later one takes some time to initiate if your combined remote has a lot of upstreams.

Every Rclone configuration from remotes to command arguments can be set using environment variables. Just read this.

About

Serve your Rclone remotes as public/private index through HTTP, WebDAV.


Languages

Language:HTML 92.5%Language:Shell 6.1%Language:Dockerfile 0.9%Language:Nix 0.4%