{"id":13565977,"url":"https://github.com/rclone/rclone-webui-react","last_synced_at":"2025-05-15T20:05:27.191Z","repository":{"id":37704973,"uuid":"189567442","full_name":"rclone/rclone-webui-react","owner":"rclone","description":"A full fledged UI for the rclone cloud sync tool","archived":false,"fork":false,"pushed_at":"2024-06-11T21:45:19.000Z","size":9747,"stargazers_count":1394,"open_issues_count":85,"forks_count":174,"subscribers_count":39,"default_branch":"master","last_synced_at":"2025-05-12T05:02:17.377Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rclone.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-05-31T09:29:45.000Z","updated_at":"2025-05-11T12:32:16.000Z","dependencies_parsed_at":"2024-01-19T07:01:05.036Z","dependency_job_id":"4be5e3ad-4b61-4a59-899e-57804b929daf","html_url":"https://github.com/rclone/rclone-webui-react","commit_stats":null,"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rclone%2Frclone-webui-react","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rclone%2Frclone-webui-react/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rclone%2Frclone-webui-react/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rclone%2Frclone-webui-react/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rclone","download_url":"https://codeload.github.com/rclone/rclone-webui-react/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254414499,"owners_count":22067272,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T13:01:59.318Z","updated_at":"2025-05-15T20:05:19.111Z","avatar_url":"https://github.com/rclone.png","language":"JavaScript","funding_links":[],"categories":["JavaScript","HarmonyOS","Clients \u0026 GUIs"],"sub_categories":["Windows Manager","Web"],"readme":"# Rclone Web UI  [![Google Summer of Code 19](https://img.shields.io/badge/Google%20Summer%20of%20Code-2019%202020-blue.svg)](https://summerofcode.withgoogle.com/projects/#5104629795258368) [![CCExtractor](https://img.shields.io/badge/CCExtractor-org-red.svg)](https://www.ccextractor.org/) [![RClone](https://img.shields.io/badge/RClone-org-blue.svg)](https://rclone.org/)\n\n**Latest hosted release:** https://rclone.github.io/rclone-webui-react\n\n\n\n## Build Status\n\n![Node CI](https://github.com/rclone/rclone-webui-react/workflows/Node%20CI/badge.svg)\n![Code scanning](https://github.com/rclone/rclone-webui-react/workflows/Code%20scanning%20-%20action/badge.svg)\n[![Coverage Status](https://coveralls.io/repos/github/rclone/rclone-webui-react/badge.svg?branch=master)](https://coveralls.io/github/rclone/rclone-webui-react?branch=master)\n\n## About\n\nThis project under development as a part of Google Summer of Code 2019 and 2020 under [ccextractor.org](https://ccextractor.org) and [rclone.org](https://rclone.org) by [negative0](https://github.com/negative0).\n\nThis is a reactJS based web UI for the rclone cli project @ [Rclone Website](https://rclone.org/)  \n\n### Work Products (GSoC 2019):\n\n- Proposal for developing this project: [here](https://docs.google.com/document/d/1l6OHrM2XemHP-l2_iBdYPdPNVgiSB5t1es_-0ogrty0/edit?usp=sharing)\n- The latest automated build can be found here: http://rclone.github.io/rclone-webui-react\n- GSoC phase I plan: [here](http://good2be.me/blog/gsoc-phase-i.html)\n- The thread for beta testing is here: https://forum.rclone.org/t/beta-testing-webgui-for-rclone/11156\n\n## Intro\n\nThis project is being actively developed. Feel free to create any issues, feature requests or enhancements as you encounter them. \n\n## Getting Started\n\nThe project currently requires you to install and configure react and npm to run correctly.\n\n## Running the project through rclone:\n\nIf you have rclone installed, you can easily run this UI through rclone without any additional configuration.\n\n**Note: The instructions for installing rclone can be found [here](https://rclone.org/install/).**\n\nTo run the web-gui, simply run the following command:\n\n```shell script\nrclone rcd --rc-web-gui --rc-user=\u003cuser\u003e --rc-pass=\u003cpass\u003e \n```\nThe web-gui should now be available at the url http://localhost:5572\n\nYou may have to clear the browser local storage if needed, after switching to the older version.\n\n## Alternatively, you can use the hosted version:\nWith every release, we publish it to github-pages. You can directly use it without installing rclone locally.\n\nHead over to https://rclone.github.io/rclone-webui-react/. To login, enter the IP address, username and password of rclone rc server.\n\nWhile running the rclone rc server, use the following command,\n```\nrclone rcd --rc-user=abc --rc-pass=abcd --rc-allow-origin=\"https://rclone.github.io\" \n```\nreplace the username and password with your liking. If you are not comfortable with specifying it here, use the .htpasswd option.\n\n```\nrclone rcd --rc-allow-origin=\"https://rclone.github.io\" --rc-htpasswd /path/to/.htpasswd\n```\n\n### Parameters:\n--rc-web-gui - run the web-gui\n\n--rc-user - username to be used for login (Optional) default is gui.\n\n--rc-pass - password to be used for login (Optional) if not provided, rclone will generate one for you.\n\n--rc-addr - useful if you are running rclone on a headless machine, specify the private/public IP of your VM for rclone to bind to. (Optional)\n\n--rc-web-gui-update - Force update web-gui to the latest version.\n\n\n\n## Screenshots\n### Dashboard\n![Dashboard](screenshots/dashboard.png)\n\n### Login\n![Login](screenshots/login.png)\n\n### Remote Explorer\n![Explorer](screenshots/remoteexplorer.png)\n\n### Creating config\n![New Config](screenshots/config.png)\n\n### Mounts\n![Mounts](screenshots/mounts.png)\n\n## Get the automated script and get running\n\n**Bash users:**\n\nDownload the sh file given here: \n[webui.sh](https://raw.githubusercontent.com/rclone/rclone-webui-react/master/webui.sh)\n\nCopy the file to root folder of rclone.\n\n```\ncp webui.sh \u003croot-of-rclone\u003e/\n```\nFirst of all open the webui.sh\n\nYou need to edit this code to the username and password you would like to use.\n```\nusername='\u003cyour-username\u003e'\npassword='\u003cyour-password\u003e'\n```\nSave this file.\n\nNow you can run the following commands:\n\n- Download the project:\n```\n./webui.sh get\n```\n\n- Build the webui app:\n```\n./webui.sh build\n```\n\n- Run the app with rclone backend:\n```\n./webui.sh run\n```\n\n- At any point, you can update the webui with new changes from the repo (optional):\n\n```\n./webui.sh update\n```\n\n\n### Get the Project\n```\n    git clone https://github.com/rclone/rclone-webui-react\n```\nOR download a zip from the option above.\n\n### Install dependencies\nIf you are using NPM:\n\n**Make sure that you are using the latest LTS version of NPM**\n```\n    cd \u003ccloned directory\u003e\n    npm install \n```\n\nUsing yarn:\n```explorer\n    cd \u003ccloned directory\u003e\n    yarn install\n```\n\n\n### Run the project\n```\n    npm start\n```\nOR\n```\n    npm run start\n```\n\n### Run tests\n```npm test```OR ```yarn test``` if you want to run all jest tests. \nTest specific environment can be set using setupTests.js\n\n**With Coverage**: ```npm run test:cov```\n\n\n### Run Rclone\nYou have to run rclone with the following flags:\n```\n    rclone rcd --rc-user=\u003cusername\u003e --rc-pass=\u003cpassword\u003e --rc-serve\n```\nReplace 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.\n\n--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.\n\n## Progress\n\nFor the progress and future implementation details please refer Progress.md\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frclone%2Frclone-webui-react","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frclone%2Frclone-webui-react","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frclone%2Frclone-webui-react/lists"}