mirror of
https://github.com/YunoHost-Apps/simple-torrent_ynh.git
synced 2024-09-03 20:26:18 +02:00
3db8f6cc2b
* Update upgrade * Update manifest.json * Auto-update README * Update restore * Update remove * Create DESCRIPTION.md * Auto-update README * Update DESCRIPTION.md * Auto-update README * Create updater.sh * Update arm64.src * Update manifest.json * Auto-update README * Update updater.sh * Update updater.sh * Update manifest.json * Upgrade to version 1.3.7 (#62) * Upgrade to v1.3.7 * Auto-update README Co-authored-by: yunohost-bot <yunohost-bot@users.noreply.github.com> Co-authored-by: Yunohost-Bot <> * Update manifest.json * Update check_process * keep config (#67) * Update upgrade * Update manifest.json * Auto-update README * Auto-update README * 4.3 * Update manifest.json * Auto-update README * Update manifest.json * Auto-update README * Update upgrade * fix linter (#72) * Update manifest.json * Auto-update README * Auto-update README * Fix linter * Update manifest.json Co-authored-by: Yunohost-Bot <> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: yunohost-bot <yunohost-bot@users.noreply.github.com> Co-authored-by: yunohost-bot <yunohost@yunohost.org>
72 lines
2.9 KiB
Markdown
72 lines
2.9 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.
|
|
-->
|
|
|
|
# Simple Torrent for YunoHost
|
|
|
|
[](https://dash.yunohost.org/appci/app/simple-torrent)  
|
|
[](https://install-app.yunohost.org/?app=simple-torrent)
|
|
|
|
*[Lire ce readme en français.](./README_fr.md)*
|
|
|
|
> *This package allows you to install Simple 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
|
|
|
|
SimpleTorrent 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:** 1.3.9~ynh4
|
|
|
|
## Screenshots
|
|
|
|
|
|
|
|
|
|
## Disclaimers / important information
|
|
|
|
## Configuration
|
|
|
|
Most of the items can be edited in Web-UI on the fly in the config board.
|
|
|
|
You can also configure Simple Torrent by editing this file `/var/www/simple-torrent/config.yml` using the [documentation](https://github.com/boypt/simple-torrent/wiki/Config-File).
|
|
|
|
## Limitations
|
|
|
|
- This app cannot be installed on a 32-bit ARM machine.
|
|
|
|
## Documentation and resources
|
|
|
|
* Official app website: <https://github.com/boypt/simple-torrent>
|
|
* Official admin documentation: <https://github.com/boypt/simple-torrent/wiki>
|
|
* Upstream app code repository: <https://github.com/boypt/simple-torrent>
|
|
* YunoHost documentation for this app: <https://yunohost.org/app_simple-torrent>
|
|
* Report a bug: <https://github.com/YunoHost-Apps/simple-torrent_ynh/issues>
|
|
|
|
## Developer info
|
|
|
|
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/simple-torrent_ynh/tree/testing).
|
|
|
|
To try the testing branch, please proceed like that.
|
|
|
|
``` bash
|
|
sudo yunohost app install https://github.com/YunoHost-Apps/simple-torrent_ynh/tree/testing --debug
|
|
or
|
|
sudo yunohost app upgrade simple-torrent -u https://github.com/YunoHost-Apps/simple-torrent_ynh/tree/testing --debug
|
|
```
|
|
|
|
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
|