transmission_ynh/README.md

<!--
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.
-->

# Transmission for YunoHost

[![Integration level](https://dash.yunohost.org/integration/transmission.svg)](https://dash.yunohost.org/appci/app/transmission) ![Working status](https://ci-apps.yunohost.org/ci/badges/transmission.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/transmission.maintain.svg)

[![Install Transmission with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=transmission)

*[Lire ce readme en français.](./README_fr.md)*

> *This package allows you to install Transmission 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

Transmission is a fast, easy, and free BitTorrent client.

### YunoHost specific features

 * Integration with YunoHost Multimedia directories


**Shipped version:** 3.00~ynh3

## Screenshots

![Screenshot of Transmission](./doc/screenshots/transmission.jpg)

## Documentation and resources

* Official app website: <https://www.transmissionbt.com>
* Official admin documentation: <https://github.com/transmission/transmission/wiki>
* Upstream app code repository: <https://github.com/transmission/transmission>
* YunoHost Store: <https://apps.yunohost.org/app/transmission>
* Report a bug: <https://github.com/YunoHost-Apps/transmission_ynh/issues>

## Developer info

Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/transmission_ynh/tree/testing).

To try the testing branch, please proceed like that.

``` bash
sudo yunohost app install https://github.com/YunoHost-Apps/transmission_ynh/tree/testing --debug
or
sudo yunohost app upgrade transmission -u https://github.com/YunoHost-Apps/transmission_ynh/tree/testing --debug
```

**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
Auto-update README 2022-07-03 20:38:51 +02:00			`<!--`
			`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.`
			`-->`

Update README.md 2020-10-10 13:48:10 +02:00			`# Transmission for YunoHost`
Init 2013-10-29 14:14:27 +01:00
Testing (#101) * Auto-update README * Bullseye (#95) * Upgrade to bullseye * Auto-update README * Auto-update README * Update check_process * Update manifest.json Co-authored-by: yunohost-bot <yunohost@yunohost.org> * Update manifest.json * Update upgrade * Auto-update README * Version 2 (#99) * Update install * v2 * Auto-update README * v2 * fix * Auto-update README * Delete updater.sh * fix * fix * Update restore * fix * Update manifest.toml * add sudirs * Update install * cleaning * Update upgrade * Update tests.toml * Update manifest.toml * Update manifest.toml * cleaning * Auto-update README * cleaning * fix --------- Co-authored-by: yunohost-bot <yunohost@yunohost.org> * Auto-update README * Update manifest.toml * Auto-update README * Update upgrade * Update tests.toml * Fix upgrade script for old versions (#102) We moved from /home/yunohost.transmission to /home/yunohost.app/transmission. Dangling symlinks might exist in the $MEDIA_DIRECTORY... Removing this before ynh_multimedia_build_main_dir will fix this, and the symlinks will be recreated after by ynh_multimedia_addfolder. Also, we're using rm and not ynh_secure_remove because of https://github.com/YunoHost/issues/issues/2253 --------- Co-authored-by: yunohost-bot <yunohost@yunohost.org> Co-authored-by: Salamandar <6552989+Salamandar@users.noreply.github.com> 2023-09-28 12:25:27 +02:00			`[![Integration level](https://dash.yunohost.org/integration/transmission.svg)](https://dash.yunohost.org/appci/app/transmission) ![Working status](https://ci-apps.yunohost.org/ci/badges/transmission.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/transmission.maintain.svg)`

Change badge to svg 2020-12-17 10:22:52 +01:00			`[![Install Transmission with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=transmission)`
Global refactoring 2017-06-13 23:37:51 +02:00
updated readme and french translation (#77) * Add README_fr 2020-11-19 14:00:06 +01:00			`[Lire ce readme en français.](./README_fr.md)`

Auto-update README 2022-07-03 20:38:51 +02:00			`> *This package allows you to install Transmission 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.*`
Global refactoring 2017-06-13 23:37:51 +02:00
Normalization from example_ynh 2019-05-01 13:24:56 +02:00			`## Overview`
Add a one click install button on the Readme 2017-08-16 11:59:57 +02:00
Normalization from example_ynh 2019-05-01 13:24:56 +02:00			`Transmission is a fast, easy, and free BitTorrent client.`
Add a one click install button on the Readme 2017-08-16 11:59:57 +02:00
Testing (#101) * Auto-update README * Bullseye (#95) * Upgrade to bullseye * Auto-update README * Auto-update README * Update check_process * Update manifest.json Co-authored-by: yunohost-bot <yunohost@yunohost.org> * Update manifest.json * Update upgrade * Auto-update README * Version 2 (#99) * Update install * v2 * Auto-update README * v2 * fix * Auto-update README * Delete updater.sh * fix * fix * Update restore * fix * Update manifest.toml * add sudirs * Update install * cleaning * Update upgrade * Update tests.toml * Update manifest.toml * Update manifest.toml * cleaning * Auto-update README * cleaning * fix --------- Co-authored-by: yunohost-bot <yunohost@yunohost.org> * Auto-update README * Update manifest.toml * Auto-update README * Update upgrade * Update tests.toml * Fix upgrade script for old versions (#102) We moved from /home/yunohost.transmission to /home/yunohost.app/transmission. Dangling symlinks might exist in the $MEDIA_DIRECTORY... Removing this before ynh_multimedia_build_main_dir will fix this, and the symlinks will be recreated after by ynh_multimedia_addfolder. Also, we're using rm and not ynh_secure_remove because of https://github.com/YunoHost/issues/issues/2253 --------- Co-authored-by: yunohost-bot <yunohost@yunohost.org> Co-authored-by: Salamandar <6552989+Salamandar@users.noreply.github.com> 2023-09-28 12:25:27 +02:00			`### YunoHost specific features`
Normalization from example_ynh 2019-05-01 13:24:56 +02:00
			`* Integration with YunoHost Multimedia directories`

Add remote client information RPC Add some exemples of clients and instructions to connect them 2020-10-10 13:35:30 +02:00
Testing (#104) * Auto-update README * Bullseye (#95) * Upgrade to bullseye * Auto-update README * Auto-update README * Update check_process * Update manifest.json Co-authored-by: yunohost-bot <yunohost@yunohost.org> * Update manifest.json * Update upgrade * Auto-update README * Version 2 (#99) * Update install * v2 * Auto-update README * v2 * fix * Auto-update README * Delete updater.sh * fix * fix * Update restore * fix * Update manifest.toml * add sudirs * Update install * cleaning * Update upgrade * Update tests.toml * Update manifest.toml * Update manifest.toml * cleaning * Auto-update README * cleaning * fix --------- Co-authored-by: yunohost-bot <yunohost@yunohost.org> * Auto-update README * Update manifest.toml * Auto-update README * Update upgrade * Update tests.toml * Fix upgrade script for old versions (#102) We moved from /home/yunohost.transmission to /home/yunohost.app/transmission. Dangling symlinks might exist in the $MEDIA_DIRECTORY... Removing this before ynh_multimedia_build_main_dir will fix this, and the symlinks will be recreated after by ynh_multimedia_addfolder. Also, we're using rm and not ynh_secure_remove because of https://github.com/YunoHost/issues/issues/2253 * Update manifest.toml * Auto-update README * Update remove * Update upgrade * cleaning * Update upgrade * Update install * Update manifest.toml * Update upgrade * Update manifest.toml * Auto-update README --------- Co-authored-by: yunohost-bot <yunohost@yunohost.org> Co-authored-by: Salamandar <6552989+Salamandar@users.noreply.github.com> 2023-10-04 08:35:00 +02:00			`Shipped version: 3.00~ynh3`
Add remote client information RPC Add some exemples of clients and instructions to connect them 2020-10-10 13:35:30 +02:00
Testing (#101) * Auto-update README * Bullseye (#95) * Upgrade to bullseye * Auto-update README * Auto-update README * Update check_process * Update manifest.json Co-authored-by: yunohost-bot <yunohost@yunohost.org> * Update manifest.json * Update upgrade * Auto-update README * Version 2 (#99) * Update install * v2 * Auto-update README * v2 * fix * Auto-update README * Delete updater.sh * fix * fix * Update restore * fix * Update manifest.toml * add sudirs * Update install * cleaning * Update upgrade * Update tests.toml * Update manifest.toml * Update manifest.toml * cleaning * Auto-update README * cleaning * fix --------- Co-authored-by: yunohost-bot <yunohost@yunohost.org> * Auto-update README * Update manifest.toml * Auto-update README * Update upgrade * Update tests.toml * Fix upgrade script for old versions (#102) We moved from /home/yunohost.transmission to /home/yunohost.app/transmission. Dangling symlinks might exist in the $MEDIA_DIRECTORY... Removing this before ynh_multimedia_build_main_dir will fix this, and the symlinks will be recreated after by ynh_multimedia_addfolder. Also, we're using rm and not ynh_secure_remove because of https://github.com/YunoHost/issues/issues/2253 --------- Co-authored-by: yunohost-bot <yunohost@yunohost.org> Co-authored-by: Salamandar <6552989+Salamandar@users.noreply.github.com> 2023-09-28 12:25:27 +02:00			`## Screenshots`
Add remote client information RPC Add some exemples of clients and instructions to connect them 2020-10-10 13:35:30 +02:00
Testing (#101) * Auto-update README * Bullseye (#95) * Upgrade to bullseye * Auto-update README * Auto-update README * Update check_process * Update manifest.json Co-authored-by: yunohost-bot <yunohost@yunohost.org> * Update manifest.json * Update upgrade * Auto-update README * Version 2 (#99) * Update install * v2 * Auto-update README * v2 * fix * Auto-update README * Delete updater.sh * fix * fix * Update restore * fix * Update manifest.toml * add sudirs * Update install * cleaning * Update upgrade * Update tests.toml * Update manifest.toml * Update manifest.toml * cleaning * Auto-update README * cleaning * fix --------- Co-authored-by: yunohost-bot <yunohost@yunohost.org> * Auto-update README * Update manifest.toml * Auto-update README * Update upgrade * Update tests.toml * Fix upgrade script for old versions (#102) We moved from /home/yunohost.transmission to /home/yunohost.app/transmission. Dangling symlinks might exist in the $MEDIA_DIRECTORY... Removing this before ynh_multimedia_build_main_dir will fix this, and the symlinks will be recreated after by ynh_multimedia_addfolder. Also, we're using rm and not ynh_secure_remove because of https://github.com/YunoHost/issues/issues/2253 --------- Co-authored-by: yunohost-bot <yunohost@yunohost.org> Co-authored-by: Salamandar <6552989+Salamandar@users.noreply.github.com> 2023-09-28 12:25:27 +02:00			`![Screenshot of Transmission](./doc/screenshots/transmission.jpg)`
Normalization from example_ynh 2019-05-01 13:24:56 +02:00
Auto-update README 2022-07-03 20:38:51 +02:00			`## Documentation and resources`
Normalization from example_ynh 2019-05-01 13:24:56 +02:00
Auto-update README 2022-07-03 20:38:51 +02:00			`* Official app website: <https://www.transmissionbt.com>`
			`* Official admin documentation: <https://github.com/transmission/transmission/wiki>`
			`* Upstream app code repository: <https://github.com/transmission/transmission>`
Auto-update README 2023-10-31 15:39:02 +01:00			`* YunoHost Store: <https://apps.yunohost.org/app/transmission>`
Auto-update README 2022-07-03 20:38:51 +02:00			`* Report a bug: <https://github.com/YunoHost-Apps/transmission_ynh/issues>`
Normalization from example_ynh 2019-05-01 13:24:56 +02:00
Auto-update README 2022-07-03 20:38:51 +02:00			`## Developer info`
Normalization from example_ynh 2019-05-01 13:24:56 +02:00
Auto-update README 2022-07-03 20:38:51 +02:00			`Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/transmission_ynh/tree/testing).`
Normalization from example_ynh 2019-05-01 13:24:56 +02:00
			`To try the testing branch, please proceed like that.`
Auto-update README 2022-07-03 20:38:51 +02:00
			``` bash
Normalization from example_ynh 2019-05-01 13:24:56 +02:00			`sudo yunohost app install https://github.com/YunoHost-Apps/transmission_ynh/tree/testing --debug`
			`or`
			`sudo yunohost app upgrade transmission -u https://github.com/YunoHost-Apps/transmission_ynh/tree/testing --debug`
			```
Auto-update README 2022-07-03 20:38:51 +02:00
			`More info regarding app packaging: <https://yunohost.org/packaging_apps>`