michael.reber/rclone-webui
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

add badges and logo

Browse Source
This commit is contained in:
Luc Appelman 2021-10-30 15:42:24 +02:00 committed by GitHub
parent e0fa025971
commit a3f8273c15
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 27 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
README.md
View File

@ -1,5 +1,14 @@
# Rclone WebUI
<p float="left">
<img src="./public/android-chrome-192x192.png" alt="Rclone WebUI Logo" width="192" height="192" />
<img src="./rclone-webui-text-759x192.png" alt="Rclone WebUI Logo" width="759" height="192" />
</p>
![GitHub](https://img.shields.io/github/license/controlol/rclone-webui)
![GitHub Workflow Status](https://img.shields.io/github/workflow/status/controlol/rclone-webui/Update%20Release%20V1.0?label=Build%20Release)
![GitHub top language](https://img.shields.io/github/languages/top/controlol/rclone-webui)
## Description
A simple information panel showing you all you need to know about your Rclone instance.
### Features
@ -23,14 +32,11 @@ A simple information panel showing you all you need to know about your Rclone in
#### What is Rclone
Rclone is a open source tool to transfer files from your local system to many types of cloud hosted storage. You can take a look at the project [here](https://rclone.org/)
## Installation
Download package from [here]()
Place the contents in a folder and remember it's location, I like to use /webui because I will be running this in a docker container.
## Usage
Start Rclone remote control server
```rclone rcd --rc-serve --rc-user <YOURUSER> --rc-pass <YOURPASS> /webui```
You can see the last argument is the folder where you placed the WebUI earlier. This is the same as specifying `--rc-files=/webui`. More documentation on rcd is available [here](https://rclone.org/rc).<br/>
```
rclone rcd --rc-web-gui --rc-user <YOURUSER> --rc-pass <YOURPASS> --rc-web-fetch-url=https://api.github.com/repos/controlol/rclone-webui/releases/latest
```
If you are on a headless machine you can add the argument `--rc-web-gui-no-open-browser` so Rclone won't try to open a browser.
## Screenshots
@ -50,6 +56,20 @@ If you are on a headless machine you can add the argument `--rc-web-gui-no-open-
## Used in other projects
This project is also used in [gdrive-rclone-docker#webui](https://github.com/controlol/gdrive-rclone-docker/tree/webui)
## Installation
Alternatively you can manually download the WebUI locally and specify the location of the files.
Download package from [here](https://github.com/controlol/rclone-webui/releases/download/v1.0/rclone-webui-release-V1.0.zip) and place the contents in a folder and remember it's location, I like to use /webui because I will be running this in a docker container.
```
curl https://github.com/controlol/rclone-webui/releases/download/v1.0/rclone-webui-release-V1.0.zip > rclone-webui-release-V1.0.zip
unzip rclone-webui-release-V1.0.zip
cp build /webui
rclone rcd --rc-web-gui --rc-user <YOURUSER> --rc-pass <YOURPASS> /webui
```
You can see the last argument is the folder where you placed the WebUI earlier. This is the same as specifying `--rc-files=/webui`. More documentation on rcd is available [here](https://rclone.org/rc).<br/>
## Building from source
#### Prerequisites