Deploy rclone index for your cloud storages easily
Keep in mind that there are already some other rclone index repositories out there that you can deploy for yourself, this repository is mainly my own approach for that purpose. To name a few of those repositories: (these repositories may be old, but they should still work)
- Multiple rclone remotes in one index
- No colons in URL (following MLTB method), unlike the default behavior of other similar repos
- Light mode and dark mode
- Easy deployment
- Docker and VPS supported (even for no-root environment)
- Many PaaS platforms supported (some are even free)
- Loading rclone configs via base64 or GitHub Gist link
- Authentication supported
https://demo.rclone-index.workers.dev/
CONFIG_BASE64(mandatory, select one)
Note
IMPORTANT: Select one between CONFIG_BASE64 or CONFIG_URL. CONFIG_BASE64 is recommended because it doesn't expose your rclone config as a link. Use this if you want maximum security.
Rclone config that has been encoded with base64. You can use https://emn178.github.io/online-tools/base64_encode.html to encode your rclone.conf content, copy the encoded config, and paste it to this variable.
CONFIG_URL(mandatory, select one)
Note
IMPORTANT: Select one between CONFIG_BASE64 or CONFIG_URL. CONFIG_URL is not recommended because it exposes your config as a link, even though the chance people may stumble into your link is very little as it is a private gist.
Raw rclone config URL. You can use https://gist.github.com, create a secret gist, paste your rclone.conf content, save it, and copy the raw URL of that gist.
PORT(Optional)
Server port you want to use for rclone index. If you use PaaS, it's most likely that PORT variable has been assigned by default, so you can leave this blank first to check. If you don't specify and the server you use doesn't assign PORT variable automatically, it will use 8080 port.
USERNAME(Optional)
Username for authentication (leave blank for no auth). It must be paired with PASSWORD variable if you want to add authentication.
PASSWORD(Optional)
Password for authentication (leave blank for no auth). It must be paired with USERNAME variable if you want to add authentication.
DARK_MODE(Optional)
Set this to true to enable dark mode. Leaving this empty or any value other than true will set it to light mode. You can also edit the dark mode's template at templates/dark.html. Thanks to @culturecloud for the dark mode template (I couldn't find it anywhere else)
Light mode (default):
Dark mode:
You need to make sure that Docker is installed in your server
- Clone this repo
git clone https://github.com/devolart/rclone-index
- Open the cloned repo directory
cd rclone-index
- Build the docker
sudo docker build . -t rclone-index
- Copy this command, modify the environment variables (remove if needed), and run it
sudo docker run -e CONFIG_BASE64= -e CONFIG_URL= -e PORT=8080 -e USERNAME= -e PASSWORD= -e DARK_MODE=false -p 8080:8080 rclone-index
- Copy these commands and modify the environment variables (remove if needed)
export CONFIG_BASE64=
export CONFIG_URL=
export PORT=8080
export USERNAME=
export PASSWORD=
export DARK_MODE=false
- Run this command
curl https://raw.githubusercontent.com/devolart/rclone-index/main/start.sh | bash
Make a new web service, use https://github.com/devolart/rclone-index as GitHub template, add environment variables (don't add PORT variable), and deploy it
Unfortunately, the original project has been suspended on Glitch
Fork this repo, connect your Clever Cloud account to the forked repo, add environment variables (don't add PORT variable), and deploy it
Make a new service, use https://github.com/devolart/rclone-index as GitHub template, add environment variables (set the port to 8080), expose 8080 port as HTTP to the internet, and deploy it
