https://github.com/shoshinnikita/rview
Web-based UI for Rclone
https://github.com/shoshinnikita/rview
golang libvips rclone rclone-gui server-side-rendering webgui
Last synced: 4 months ago
JSON representation
Web-based UI for Rclone
- Host: GitHub
- URL: https://github.com/shoshinnikita/rview
- Owner: ShoshinNikita
- License: mit
- Created: 2022-10-14T18:26:56.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-15T19:49:02.000Z (5 months ago)
- Last Synced: 2024-12-17T09:03:08.029Z (4 months ago)
- Topics: golang, libvips, rclone, rclone-gui, server-side-rendering, webgui
- Language: Go
- Homepage:
- Size: 6.46 MB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# `Rview` - web-based UI for Rclone
More screenshots here
***
- [Features](#features)
- [Limitations](#limitations)
- [Demo](#demo)
- [Run](#run)
- [Advanced](#advanced)
- [Configuration](#configuration)
- [Development](#development)
- [Metrics \& Pprof](#metrics--pprof)
- [Thanks](#thanks)
## Features
- :framed_picture: **Automatic thumbnail generation**: You don't have to download hundreds of MiBs to preview your images.
Image thumbnails are generated with the help of [libvips](https://github.com/libvips/libvips), an extremely
fast image processing library.
- :mag: **Search**: You can search for files by their name. Search tips can be found [here](./docs/search.md).
- :iphone: **Responsive**: UI is designed to be responsive, which means you can browse you files on both desktop
and mobile.
- :feather: **Lightweight & minimalistic**: All pages are rendered on the server side using Go templates. JavaScript
is used only to make UI interactive.
## Limitations
- **Rview** is read-only and there are no plans to change that. You should use Rclone directly
to upload, edit, or delete files.
- **Rview** does not provide any authentication mechanism. It is therefore highly recommended to use a proxy
such as Nginx or Caddy. Enabling gzip compression is also recommended, as it can significantly improve response time.
## Demo
Check out the live demo [here](https://rview.0x5f3759df.stream), credentials for Basic Auth: `rview:rview`.
## Run
1. You have to install [docker](https://docs.docker.com/) and [docker compose](https://docs.docker.com/compose/).
2. Let's consider you use Rclone S3 backend, and your `~/.config/rclone/rclone.conf` looks like this:
```ini
[my-s3]
type = s3
provider = Other
access_key_id =
secret_access_key =
endpoint =
```
3. Create `docker-compose.yml` with the following content:
```yml
version: "2"
services:
rview:
image: ghcr.io/shoshinnikita/rview:main
container_name: rview
volumes:
- ./var:/srv/var # mount app data directory
- ~/.config/rclone/rclone.conf:/config/rclone/rclone.conf # mount Rclone config file
ports:
- "127.0.0.1:8080:8080"
command: "--rclone-target=my-s3:" # pass Rclone target from the config file
```
4. Run this command:
```sh
docker compose up
```
5. Go to http://localhost:8080.
### Advanced
You can run **Rview** with an existing Rclone instance and without access to the internet.
Read more [here](./docs/advanced_setup.md).
## Configuration
```
--rclone-target Rclone target, required
--rclone-url Url of an existing rclone instance, optional. If url is
not specified, a local rclone instance will be launched
with the default config file. Url should include credentials
for Basic Auth, e.g., http://user:pass@rclone:80
--dir Directory for app data: thumbnails and etc. (default: ./var)
--port Server port (default: 8080)
--image-preview-mode Available image preview modes:
- thumbnails (default): generate thumbnails
- original: show original images
- none: don't show preview for images
--thumbnails-max-age-days Max age of thumbnails, days (default: 365)
--thumbnails-max-total-size-mb Max total size of thumbnails, MiB (default: 500)
--thumbnails-workers-count Number of workers for thumbnail generation (default: # of threads)
--read-static-files-from-disk Read static files directly from disk
--debug-log-level Display debug log messages
--version Print version and exit
```
## Development
First, you have to install the following dependencies:
1. [Rclone](https://github.com/rclone/rclone) - instructions can be found [here](https://rclone.org/install/).
2. [libvips](https://github.com/libvips/libvips) - on Ubuntu you can install it with the following command:
```bash
sudo apt-get install libvips-tools
```
After completion of these steps you should be able to run **Rview**:
```bash
# Build and run
make build && make run
# Or just
make
# Build, run tests and lint code
make check
```
By default `make run` uses environment variables from `.env` file. You can redefine these variables via `.env.local` file.
### Metrics & Pprof
**Rview** exposes Prometheus metrics on `/debug/metrics`. The list of all metrics can be found [here](pkg/metrics/metrics.go)
[Pprof endpoints](https://pkg.go.dev/net/http/pprof#hdr-Usage_examples) are available on `/debug/pprof/`.
## Thanks
Special thanks to these open-source projects:
- [Rclone](https://github.com/rclone/rclone) - rsync for cloud storage.
- [libvips](https://github.com/libvips/libvips) - A fast image processing library with low memory needs.
- [Material Icon Theme](https://github.com/PKief/vscode-material-icon-theme) - Material Design icons for VS Code.
- [Feather](https://github.com/feathericons/feather) - Simply beautiful open source icons.