Skip to content
A full fledged UI for the rclone cloud sync tool
JavaScript Other
Branch: master
Clone or download
Latest commit f33baec Aug 16, 2019

README.md

Rclone Web UI Google Summer of Code 19

CCExtractor RClone

This is a reactjs based web UI for the rclone cli project @ Rclone Website

This project can be unstable and is being actively developed. Feel free to create any issues, feature requests or enhancements as you encounter them.

Build Status

Build Status Greenkeeper badge Coverage Status

Getting Started

The project currently requires you to install and configure react and npm to run correctly. Read more about the project details at good2be.me

Screenshots

Dashboard

Dashboard

Login

Login

Remote Explorer

Explorer

Creating config

New Config

Get the automated script and get running

Bash users:

Download the sh file given here: webui.sh

Copy the file to root folder of rclone.

cp webui.sh <root-of-rclone>/

First of all open the webui.sh

You need to edit this code to the username and password you would like to use.

username='<your-username>'
password='<your-password>'

Save this file.

Now you can run the following commands:

  • Download the project:
./webui.sh get
  • Build the webui app:
./webui.sh build
  • Run the app with rclone backend:
./webui.sh run
  • At any point, you can update the webui with new changes from the repo (optional):
./webui.sh update

Windows: Coming soon

Get the Project

    git clone https://github.com/negative0/rclone-webui-react

OR download a zip from the option above.

Install dependencies

If you are using NPM:

Make sure that you are using the latest LTS version of NPM

    cd <cloned directory>
    npm install 

Using yarn:

    cd <cloned directory>
    yarn install

Run the project

    npm start

OR

    npm run start

Run tests

npm testOR yarn test if you want to run all jest tests. Test specific environment can be set using setupTests.js

With Coverage: npm run test:cov

Run Rclone

You have to run rclone with the following flags:

    rclone rcd --rc-user=<username> --rc-pass=<password> --rc-serve

Replace username and password with your custom username password. This will be required to login to rclone. rc-no-auth is not available due to security concerns.

--rc-serve: It serves the remote objects at localhost:5572/[remoteName:remotePath]/path/to/file. It enables us to download files via the RemoteExplorer through the browser.

Progress

For the progress and future implementation details please refer Progress.md

You can’t perform that action at this time.