1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/simple-torrent_ynh.git synced 2024-09-03 20:26:18 +02:00
simple-torrent_ynh/README.md
Éric Gaspar 243a22c111
Testing (#80)
* 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

* Delete .DS_Store

* Delete .DS_Store

* Delete .DS_Store

* V2 (#76)

* Auto-update README

* v2

* v2

* Update change_url

* Delete .DS_Store

* v2

* Auto-update README

* Auto-update README

* fix

* Update restore

---------

Co-authored-by: yunohost-bot <yunohost@yunohost.org>

* Auto-update README

* Auto-update README

* fix

* Update manifest.toml

* Auto-update README

* Upgrade auto-updater (#78)

* [autopatch] Upgrade auto-updater

* Auto-update README

* [autopatch] Upgrade auto-updater

---------

Co-authored-by: tituspijean <titus@pijean.ovh>

* Auto-update README

* Update manifest.toml

* fix

* Update scripts/install

Co-authored-by: Alexandre Aubin <alex.aubin@mailoo.org>

* Update scripts/install

* Fix upgrade setup_source, same as install

* Update manifest.toml

* Auto-update README

* Update tests.toml

* Update manifest.toml

* Auto-update README

---------

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>
Co-authored-by: tituspijean <titus@pijean.ovh>
Co-authored-by: Alexandre Aubin <alex.aubin@mailoo.org>
2023-03-21 08:16:46 +01:00

63 lines
2.6 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
[![Integration level](https://dash.yunohost.org/integration/simple-torrent.svg)](https://dash.yunohost.org/appci/app/simple-torrent) ![Working status](https://ci-apps.yunohost.org/ci/badges/simple-torrent.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/simple-torrent.maintain.svg)
[![Install Simple Torrent with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](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~ynh8
## Screenshots
![Screenshot of Simple Torrent](./doc/screenshots/screenshot.png)
## :red_circle: Antifeatures
- **Upstream not maintained**: This software is not maintained anymore. Expect it to break down over time, be exposed to unfixed security breaches, etc.
## Documentation and resources
* 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>