can’t innovate my ass Signed-off-by: FTCHD <144691102+FTCHD@users.noreply.github.com>
162 lines
6.3 KiB
Markdown
162 lines
6.3 KiB
Markdown
<h1 align="center">
|
||
<a href="https://rcloneui.com">
|
||
<img src="./public/banner.png" alt="Rclone UI" width="100%">
|
||
</a>
|
||
<br>
|
||
<a href="https://rcloneui.com">
|
||
The cross-platform GUI fer Rclone, arrr!
|
||
</a>
|
||
</h1>
|
||
|
||
<h3 align="center">
|
||
<strong>A trim, see-through layer atop <tt>rclone</tt> so ye can captain yer remotes & tasks like a true seadog.</strong>
|
||
</h3>
|
||
|
||
<br />
|
||
|
||
<p align="center">
|
||
<a href="https://github.com/rclone-ui/rclone-ui/releases/latest">
|
||
<img alt="Latest Release" src="https://img.shields.io/github/actions/workflow/status/rclone-ui/rclone-ui/release.yml?style=for-the-badge" />
|
||
</a>
|
||
|
||
<a href="#downloads-hoist-the-booty">
|
||
<img alt="Downloads" src="https://img.shields.io/badge/DOWNLOADS-blue?style=for-the-badge&label=Tap%20to%20see" />
|
||
</a>
|
||
|
||
<a href="https://tauri.app/?ref=rclone-ui">
|
||
<img alt="Tauri" src="https://img.shields.io/badge/Tauri-brown?style=for-the-badge&logo=rust&color=f85214" />
|
||
</a>
|
||
</p>
|
||
|
||
<p align="center">
|
||
<a href="#package-mangarrs">
|
||
<img alt="Choco" src="https://img.shields.io/badge/Choco-42345f?style=for-the-badge&logo=chocolatey" />
|
||
</a>
|
||
|
||
<a href="#package-mangarrs">
|
||
<img alt="Flathub" src="https://img.shields.io/badge/Flathub-000000?style=for-the-badge&logo=flathub" />
|
||
</a>
|
||
|
||
<a href="#package-mangarrs">
|
||
<img alt="Homebrew" src="https://img.shields.io/badge/BREW-1f1d1a?style=for-the-badge&logo=homebrew" />
|
||
</a>
|
||
</p>
|
||
|
||
<p align="center">
|
||
<a href="https://github.com/rclone-ui/rclone-ui/stargazers">
|
||
<img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/rclone-ui/rclone-ui" />
|
||
</a>
|
||
</p>
|
||
|
||
<br />
|
||
|
||
<a href="https://get.rcloneui.com/showcase">
|
||
<img src=".github/rclone-video.png" alt="The GUI for Rclone">
|
||
</a>
|
||
|
||
## Docker/Homelab/Server, Ye Scallywag
|
||
Command yer server, homelab, or yer mum's vessel with **the simplest way t' manage remote **`rclone`** instances, arrr!**
|
||
|
||
#### Docker Compose
|
||
```yaml
|
||
services:
|
||
rclone:
|
||
image: rclone/rclone
|
||
container_name: rclone
|
||
command: rcd --rc-addr=0.0.0.0:5572 --rc-no-auth
|
||
ports:
|
||
- 5572:5572
|
||
volumes:
|
||
- ./config:/config/rclone
|
||
- /path/to/data:/data
|
||
```
|
||
|
||
#### Docker CLI
|
||
```bash
|
||
docker run -d \
|
||
--name rclone \
|
||
-p 5572:5572 \
|
||
-v ./config:/config/rclone \
|
||
-v /path/to/data:/data \
|
||
rclone/rclone rcd --rc-addr=0.0.0.0:5572 --rc-no-auth
|
||
```
|
||
|
||
#### Without Docker, Ye Landlubber
|
||
Just fire up th' `rcd` daemon directly:
|
||
|
||
```bash
|
||
rclone rcd --rc-addr=0.0.0.0:5572 --rc-no-auth
|
||
```
|
||
|
||
#### Notes from the Captain
|
||
- After hoisting **`rclone`** using yer preferred method, open Rclone UI an' sail to Settings > Hosts.
|
||
- Make certain yer firewall an' reverse proxy (nginx/caddy/traefik) be allowin' traffic on port **`5572`**.
|
||
- Rclone UI can dock at any RCD port, so ye can customize the default **`5572`** port as ye please.
|
||
- Use **`--rc-user`** an' **`--rc-pass`** instead o' **`--rc-no-auth`** in production waters, matey.
|
||
|
||
## Package Mangarrs
|
||
- Flathub **`flatpak install com.rcloneui.RcloneUI`** or **[from th' store](https://flathub.org/en/apps/com.rcloneui.RcloneUI)**
|
||
- Brew **`brew install --cask rclone-ui`**
|
||
- Scoop **`scoop bucket add extras`** & **`scoop install rclone-ui`**
|
||
- Chocolatey **`choco install rclone-ui`**
|
||
- WinGet **`winget install --id=RcloneUI.RcloneUI -e`**
|
||
- NPM **`npx rclone-ui`**
|
||
|
||
## Downloads (hoist the booty!)
|
||
- **Windows** (**[Arm](https://get.rcloneui.com/win-arm)**, **[x64](https://get.rcloneui.com/win)**)
|
||
- **macOS** (**[Apple Silicon](https://get.rcloneui.com/mac)**, **[Intel](https://get.rcloneui.com/mac64)**)
|
||
- **Linux** (**[AppImage](https://get.rcloneui.com/linux)**, **[deb](https://get.rcloneui.com/linux-deb)**, **[rpm](https://get.rcloneui.com/linux-rpm)**)
|
||
- **Linux `Arm`** (**[AppImage](https://get.rcloneui.com/linux-arm)**, **[deb](https://get.rcloneui.com/linux-deb-arm)**, **[rpm](https://get.rcloneui.com/linux-rpm-arm)**)
|
||
|
||
## Chart o’ the Voyage (Roadmap)
|
||
> Plunder already claimed has been moved t’ the “Features” hold.
|
||
### [Spy the V3 Parley!](https://github.com/rclone-ui/rclone-ui/issues/37)
|
||
|
||
## 1 Star = 1 Mug o’ Grog
|
||
<a href="https://www.star-history.com/#rclone-ui/rclone-ui&Timeline">
|
||
<picture>
|
||
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=rclone-ui/rclone-ui&type=Timeline&theme=dark" />
|
||
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=rclone-ui/rclone-ui&type=Timeline" />
|
||
<img alt="Star History Chart (count the loot)" src="https://api.star-history.com/svg?repos=rclone-ui/rclone-ui&type=Timeline" />
|
||
</picture>
|
||
</a>
|
||
|
||
## Contribootin'
|
||
Ahoy, matey. We been awaitin' yer arrival.
|
||
|
||
Some fine plunder t' tackle:
|
||
- Patch an open [**Issue**](https://github.com/rclone-ui/rclone-ui/issues)
|
||
- Hoist th' repo t' Vite 7 & React 19
|
||
- Bring aboard th' React Compiler
|
||
- Shift th' Cron magic over t' Rust
|
||
|
||
🎁 **Merged PRs earn ye a Lifetime Letter o' Marque!**
|
||
|
||
<br />
|
||
|
||
<p align="center">
|
||
<a href="https://github.com/rclone-ui/rclone-ui/blob/main/README.md">
|
||
<img alt="English" src="https://img.shields.io/badge/ENGLISH-gray?style=for-the-badge" />
|
||
</a>
|
||
<a href="https://github.com/rclone-ui/rclone-ui/blob/main/README_CHINESE.md">
|
||
<img alt="Chinese" src="https://img.shields.io/badge/CHINESE-gray?style=for-the-badge" />
|
||
</a>
|
||
<a href="https://github.com/rclone-ui/rclone-ui/blob/main/README_JAPANESE.md">
|
||
<img alt="Japanese" src="https://img.shields.io/badge/JAPANESE-gray?style=for-the-badge" />
|
||
</a>
|
||
<a href="https://github.com/rclone-ui/rclone-ui/blob/main/README_POLISH.md">
|
||
<img alt="Polish" src="https://img.shields.io/badge/POLISH-gray?style=for-the-badge" />
|
||
</a>
|
||
<a href="https://github.com/rclone-ui/rclone-ui/blob/main/README_GERMAN.md">
|
||
<img alt="German" src="https://img.shields.io/badge/GERMAN-gray?style=for-the-badge" />
|
||
</a>
|
||
<a href="https://github.com/rclone-ui/rclone-ui/blob/main/README_SPANISH.md">
|
||
<img alt="Spanish" src="https://img.shields.io/badge/SPANISH-gray?style=for-the-badge" />
|
||
</a>
|
||
<a href="https://github.com/rclone-ui/rclone-ui/blob/main/README_ROMANIAN.md">
|
||
<img alt="Romanian" src="https://img.shields.io/badge/ROMANIAN-gray?style=for-the-badge" />
|
||
</a>
|
||
<a href="https://github.com/rclone-ui/rclone-ui/blob/main/README_PIRATE.md">
|
||
<img alt="Pirate" src="https://img.shields.io/badge/PIRATE-chartreuse?style=for-the-badge" />
|
||
</a>
|
||
</p> |