Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
negative0 committed Jun 17, 2020
1 parent e3fcf87 commit a3ae771
Show file tree
Hide file tree
Showing 15 changed files with 387 additions and 16 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

Large diffs are not rendered by default.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Large diffs are not rendered by default.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

48 changes: 32 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Rclone Web UI [![Google Summer of Code 19](https://img.shields.io/badge/Google%20Summer%20of%20Code-2019-blue.svg)](https://summerofcode.withgoogle.com/projects/#5104629795258368)
# 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-blue.svg)](https://www.ccextractor.org/) [![RClone](https://img.shields.io/badge/RClone-org-blue.svg)](https://rclone.org/)
[![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/)
## About

This project is developed as a part of Google Summer of Code '19 under [ccextractor.org](https://ccextractor.org) and [rclone.org](https://rclone.org) by [negative0](https://github.com/negative0).
This project is developed 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).

This is a reactjs based web UI for the rclone cli project @ [Rclone Website](https://rclone.org/)

### Work Products (GSoC):
### Work Products (GSoC 2019):

- Proposal for developing this project: [here](https://docs.google.com/document/d/1l6OHrM2XemHP-l2_iBdYPdPNVgiSB5t1es_-0ogrty0/edit?usp=sharing)
- The latest automated build can be found here: http://rclone.github.io/rclone-webui-react
Expand All @@ -16,32 +16,48 @@ This is a reactjs based web UI for the rclone cli project @ [Rclone Website](htt

## Intro

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

## Build Status

[![Build Status](https://travis-ci.com/rclone/rclone-webui-react.svg?branch=master)](https://travis-ci.com/rclone/rclone-webui-react)
[![Greenkeeper badge](https://badges.greenkeeper.io/rclone/rclone-webui-react.svg)](https://greenkeeper.io/)
[![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)
![Node CI](https://github.com/rclone/rclone-webui-react/workflows/Node%20CI/badge.svg)
![Code scanning](https://github.com/rclone/rclone-webui-react/workflows/Code%20scanning%20-%20action/badge.svg)

## 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](http://good2be.me/blog)
Read more about the project details at [chaitanya.codes](http://chaitanya.codes)

## Running the project through rclone:

If you have rclone installed, you can easily run this UI through rclone without any additional configuration.

Note: The instructions for installing rclone can be found [here](https://rclone.org/install/).
**Note: The instructions for installing rclone can be found [here](https://rclone.org/install/).**

To run the web-gui, simply run the following command:

```shell script
rclone rcd --rc-web-gui --rc-user=<user> --rc-pass=<pass>
rclone rcd --rc-web-gui --rc-user=<user> --rc-pass=<pass>
```
The web-gui should now be available at the url http://localhost:5572

You may have to clear the browser local storage if needed, after switching to the older version.

## Alternatively, you can use the hosted version:
With every release, we publish it to github-pages. You can directly use it without installing rclone locally.

Head over to https://rclone.github.io/rclone-webui-react/. And enter the IP address, username and password of rclone rc server.

While running the rclone rc server, use the following command,
```
rclone rcd --rc-user=abc --rc-pass=abcd --rc-allow-origin="https://rclone.github.io"
```
replace the username and password with your liking. If you are not comfortable with specifying it here, use the .htpasswd option.

```
rclone rcd --rc-allow-origin="https://rclone.github.io" --rc-htpasswd /path/to/.htpasswd
```

### Parameters:
--rc-web-gui - run the web-gui

Expand All @@ -66,7 +82,10 @@ The web-gui should now be available at the url http://localhost:5572
![Explorer](screenshots/remoteexplorer.png)

### Creating config
![New Config](screenshots/newRemote.png)
![New Config](screenshots/config.png)

### Mounts
![Mounts](screenshots/mounts.png)

## Get the automated script and get running

Expand Down Expand Up @@ -113,9 +132,6 @@ Now you can run the following commands:
```


**Windows:**
Coming soon

### Get the Project
```
git clone https://github.com/rclone/rclone-webui-react
Expand All @@ -132,7 +148,7 @@ If you are using NPM:
```

Using yarn:
```
```explorer
cd <cloned directory>
yarn install
```
Expand Down
Binary file added screenshots/config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified screenshots/dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified screenshots/login.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/mounts.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified screenshots/remoteexplorer.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit a3ae771

Please sign in to comment.