transmission_ynh/README.md

# Transmission for YunoHost

[![Integration level](https://dash.yunohost.org/integration/transmission.svg)](https://dash.yunohost.org/appci/app/transmission) ![](https://ci-apps.yunohost.org/ci/badges/transmission.status.svg) ![](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 allow you to install Transmission quickly and simply on a YunoHost server.  
If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.*

## Overview

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

**Shipped version:** 2.94-2 (Debian repository version)

## Screenshots
![](transmission.jpg)

## Configuration

## Documentation

 * Official documentation: https://github.com/transmission/transmission/wiki
 * YunoHost documentation: https://yunohost.org/en/app_transmission

## YunoHost specific features

 * Integration with YunoHost Multimedia directories

#### Multi-users support

#### Supported architectures

* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/transmission%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/transmission/)
* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/transmission%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/transmission/)

## Limitations

## Additionnal informations
Alternative to WebUI :

You can use remote client on different platforms to manage your Transmission server:

* Dekstop: Transmission-remote-GUI: https://github.com/transmission-remote-gui/transgui
* Mobile: Transdroid: http://www.transdroid.org/
* More clients here: https://transmissionbt.com/resources/

You can use the following information to connect your server:

* Remote host: Your domain or IP address (don't add folder)
* Port: 443
* SSL: Enabled
* User: Your Yunohost Username
* Password: Password of the Yunohost User above
* RPC Path: /torrent/transmission/rpc (if you used the standard folder)

## Links

 * Report a bug: https://github.com/YunoHost-Apps/transmission_ynh/issues
 * Transmission website: https://transmissionbt.com/
 * Transmission repository: https://github.com/transmission/transmission
 * YunoHost website: https://yunohost.org/

---

## Developers infos

Please do 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.
```
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
```
Update README.md 2020-10-10 13:48:10 +02:00			`# Transmission for YunoHost`
Init 2013-10-29 14:14:27 +01:00
Update README.md 2020-03-29 13:52:27 +02:00			`[![Integration level](https://dash.yunohost.org/integration/transmission.svg)](https://dash.yunohost.org/appci/app/transmission) ![](https://ci-apps.yunohost.org/ci/badges/transmission.status.svg) ![](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)`

Normalization from example_ynh 2019-05-01 13:24:56 +02:00			`> *This package allow you to install Transmission quickly and simply on a YunoHost server.`
			`If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy 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
Fix linter warnings 2020-12-14 11:36:02 +01:00			`Shipped version: 2.94-2 (Debian repository version)`
Global refactoring 2017-06-13 23:37:51 +02:00
Normalization from example_ynh 2019-05-01 13:24:56 +02:00			`## Screenshots`
Fix image link 2020-11-19 14:03:12 +01:00			`![](transmission.jpg)`
Normalization from example_ynh 2019-05-01 13:24:56 +02:00
			`## Configuration`

			`## Documentation`

			`* Official documentation: https://github.com/transmission/transmission/wiki`
Fix linter warnings (#84) * Fix linter warnings * Update install 2021-03-22 13:32:37 +01:00			`* YunoHost documentation: https://yunohost.org/en/app_transmission`
Normalization from example_ynh 2019-05-01 13:24:56 +02:00
			`## YunoHost specific features`

			`* Integration with YunoHost Multimedia directories`

			`#### Multi-users support`

			`#### Supported architectures`

Update README.md 2020-10-10 13:48:10 +02:00			`* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/transmission%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/transmission/)`
Update readme 2019-05-20 18:29:04 +02:00			`* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/transmission%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/transmission/)`
Normalization from example_ynh 2019-05-01 13:24:56 +02:00
			`## Limitations`

			`## Additionnal informations`
Add remote client information RPC Add some exemples of clients and instructions to connect them 2020-10-10 13:35:30 +02:00			`Alternative to WebUI :`
fix readme md 2020-04-15 10:28:22 +02:00
Add remote client information RPC Add some exemples of clients and instructions to connect them 2020-10-10 13:35:30 +02:00			`You can use remote client on different platforms to manage your Transmission server:`

			`* Dekstop: Transmission-remote-GUI: https://github.com/transmission-remote-gui/transgui`
			`* Mobile: Transdroid: http://www.transdroid.org/`
			`* More clients here: https://transmissionbt.com/resources/`

			`You can use the following information to connect your server:`

			`* Remote host: Your domain or IP address (don't add folder)`
			`* Port: 443`
			`* SSL: Enabled`
			`* User: Your Yunohost Username`
			`* Password: Password of the Yunohost User above`
			`* RPC Path: /torrent/transmission/rpc (if you used the standard folder)`
Normalization from example_ynh 2019-05-01 13:24:56 +02:00
			`## Links`

			`* Report a bug: https://github.com/YunoHost-Apps/transmission_ynh/issues`
			`* Transmission website: https://transmissionbt.com/`
Update readme 2019-05-20 18:29:04 +02:00			`* Transmission repository: https://github.com/transmission/transmission`
Normalization from example_ynh 2019-05-01 13:24:56 +02:00			`* YunoHost website: https://yunohost.org/`

			`---`

Update README.md 2020-10-10 13:48:10 +02:00			`## Developers infos`
Normalization from example_ynh 2019-05-01 13:24:56 +02:00
			`Please do 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.`
			```
			`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`
			```