mirror of
https://github.com/YunoHost-Apps/simple-torrent_ynh.git
synced 2024-09-03 20:26:18 +02:00
59 lines
2.4 KiB
Markdown
59 lines
2.4 KiB
Markdown
<!--
|
|
N.B.: This README was automatically generated by <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
|
|
It shall NOT be edited by hand.
|
|
-->
|
|
|
|
# Cloud Torrent for YunoHost
|
|
|
|
[](https://dash.yunohost.org/appci/app/cloud-torrent)  
|
|
|
|
[](https://install-app.yunohost.org/?app=cloud-torrent)
|
|
|
|
*[Read this README in other languages.](./ALL_README.md)*
|
|
|
|
> *This package allows you to install Cloud Torrent quickly and simply on a YunoHost server.*
|
|
> *If you don't have YunoHost, please consult [the guide](https://yunohost.org/install) to learn how to install it.*
|
|
|
|
## Overview
|
|
|
|
Cloud-Torrent is a a self-hosted remote torrent client, written in Go (golang). Started torrents remotely, download sets of files on the local disk of the server, which are then retrievable or streamable via HTTP.
|
|
|
|
### Features
|
|
|
|
- Individual file download control (1.1.3+)
|
|
- Run external program on tasks completion
|
|
- Stops task when seeding ratio reached
|
|
- Download/Upload speed limiter
|
|
- Detailed transfer stats in web UI.
|
|
- Torrent Watcher
|
|
- Extra trackers from external source
|
|
- Protocol Handler to magnet
|
|
- Magnet RSS subscribing supported
|
|
|
|
|
|
**Shipped version:** 0.9.1~ynh1
|
|
|
|
## Screenshots
|
|
|
|
|
|
|
|
## Documentation and resources
|
|
|
|
- Official admin documentation: <https://github.com/jpillora/cloud-torrent/wiki/>
|
|
- Upstream app code repository: <https://github.com/jpillora/cloud-torrent>
|
|
- YunoHost Store: <https://apps.yunohost.org/app/cloud-torrent>
|
|
- Report a bug: <https://github.com/YunoHost-Apps/cloud-torrent_ynh/issues>
|
|
|
|
## Developer info
|
|
|
|
Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/cloud-torrent_ynh/tree/testing).
|
|
|
|
To try the `testing` branch, please proceed like that:
|
|
|
|
```bash
|
|
sudo yunohost app install https://github.com/YunoHost-Apps/cloud-torrent_ynh/tree/testing --debug
|
|
or
|
|
sudo yunohost app upgrade cloud-torrent -u https://github.com/YunoHost-Apps/cloud-torrent_ynh/tree/testing --debug
|
|
```
|
|
|
|
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
|