iiab/roles/transmission/README.rst

===================
Transmission README
===================

Transmission is a set of lightweight BitTorrent clients (in GUI, CLI and daemon form).  All these incarnations feature a very simple and intuitive interface, on top on an efficient, cross-platform back-end.

Transmission is intended to download KA Lite content to IIAB, from places like http://pantry.learningequality.org/downloads/ka-lite/0.17/content/ -- and also to seed it, in assistance of others.

Once the packages are downloaded, please verify the content before copying it (carefully) to KA Lite content directory: /library/ka-lite/content

Caution
-------

Usage of Transmission consumes significant Internet data and system resources.
Caveat emptor!  (That's Latin for "Buyer Beware")

Access
------

Login to Transmission's web interface http://box:9091 using administrative account:

Username: Admin
Password: changeme

Alternatively, you can type 'transmission-remote' at the command-line.

Configuration
-------------

You can configure Transmission using its web interface http://box:9091

You can also edit Transmission settings in '/etc/transmission-daemon/settings.json'.  Before you start editing the
'settings.json' file, please ensure that transmission-daemon.service is stopped:

$ sudo systemctl stop transmission-daemon.service

$ sudo nano /etc/transmission-daemon/settings.json

Adding torrents
---------------

Transmission can facilitate provisioning your IIAB, by adding KA Lite content from places like: http://pantry.learningequality.org/downloads/ka-lite/0.17/content/

You can also download other torrents using Transmission's web interface, or by typing 'transmission-remote' at the command-line.

$ transmission-remote -a <path_to_the.torrent>

Known Issues
------------

* Default Transmission user/group (See https://github.com/transmission/transmission/issues/537).  Currently you need to set these "transmission_user" and "transmission_group" variables.  Check their values in transmission-daemon's systemd unit file: lib/systemd/system/transmission-daemon.service

* Random Ports: Currently it is not possible to use random ports in the range 49152-65535.  It is difficult to open multiple ports in IIAB's iptables-based firewall.

Troubleshooting
---------------

Please check if the transmission daemon is running:

$ sudo systemctl status transmission-daemon.service

Check that Transmission's settings are correct in: /etc/transmission-daemon/settings.json
Proposed README.rst cleanups @arky please revert any of these changes/suggestions as necessary! 2018-08-20 18:15:26 +00:00			`===================`
Initial Import 2018-08-16 09:36:45 +00:00			`Transmission README`
Proposed README.rst cleanups @arky please revert any of these changes/suggestions as necessary! 2018-08-20 18:15:26 +00:00			`===================`
Initial Import 2018-08-16 09:36:45 +00:00
Proposed README.rst cleanups @arky please revert any of these changes/suggestions as necessary! 2018-08-20 18:15:26 +00:00			`Transmission is a set of lightweight BitTorrent clients (in GUI, CLI and daemon form). All these incarnations feature a very simple and intuitive interface, on top on an efficient, cross-platform back-end.`

			`Transmission is intended to download KA Lite content to IIAB, from places like http://pantry.learningequality.org/downloads/ka-lite/0.17/content/ -- and also to seed it, in assistance of others.`

			`Once the packages are downloaded, please verify the content before copying it (carefully) to KA Lite content directory: /library/ka-lite/content`
Correct transmission variables and use 'to_json' Ensure that transmission_http_port variable is not reset in iiab-gen-iptables. Remote the extra qoutes and also use to_json to clean the transmission_kalite_languages output. Restructure the defaults section. Update the README documentation. 2018-08-18 04:13:16 +00:00
Proof-of-Concept: Install and Start downloading a torrent 2018-08-16 18:54:55 +00:00			`Caution`
			`-------`
Proposed README.rst cleanups @arky please revert any of these changes/suggestions as necessary! 2018-08-20 18:15:26 +00:00
			`Usage of Transmission consumes significant Internet data and system resources.`
			`Caveat emptor! (That's Latin for "Buyer Beware")`
Initial Import 2018-08-16 09:36:45 +00:00
Minor syntax and cosmetics fixes 2018-08-18 04:32:45 +00:00			`Access`
			`------`
Initial Import 2018-08-16 09:36:45 +00:00
Proposed README.rst cleanups @arky please revert any of these changes/suggestions as necessary! 2018-08-20 18:15:26 +00:00			`Login to Transmission's web interface http://box:9091 using administrative account:`
Initial Import 2018-08-16 09:36:45 +00:00
Proof-of-Concept: Install and Start downloading a torrent 2018-08-16 18:54:55 +00:00			`Username: Admin`
			`Password: changeme`
Initial Import 2018-08-16 09:36:45 +00:00
Proposed README.rst cleanups @arky please revert any of these changes/suggestions as necessary! 2018-08-20 18:15:26 +00:00			`Alternatively, you can type 'transmission-remote' at the command-line.`
Correct transmission variables and use 'to_json' Ensure that transmission_http_port variable is not reset in iiab-gen-iptables. Remote the extra qoutes and also use to_json to clean the transmission_kalite_languages output. Restructure the defaults section. Update the README documentation. 2018-08-18 04:13:16 +00:00
			`Configuration`
Proposed README.rst cleanups @arky please revert any of these changes/suggestions as necessary! 2018-08-20 18:15:26 +00:00			`-------------`

			`You can configure Transmission using its web interface http://box:9091`
Correct transmission variables and use 'to_json' Ensure that transmission_http_port variable is not reset in iiab-gen-iptables. Remote the extra qoutes and also use to_json to clean the transmission_kalite_languages output. Restructure the defaults section. Update the README documentation. 2018-08-18 04:13:16 +00:00
Proposed README.rst cleanups @arky please revert any of these changes/suggestions as necessary! 2018-08-20 18:15:26 +00:00			`You can also edit Transmission settings in '/etc/transmission-daemon/settings.json'. Before you start editing the`
			`'settings.json' file, please ensure that transmission-daemon.service is stopped:`
Correct transmission variables and use 'to_json' Ensure that transmission_http_port variable is not reset in iiab-gen-iptables. Remote the extra qoutes and also use to_json to clean the transmission_kalite_languages output. Restructure the defaults section. Update the README documentation. 2018-08-18 04:13:16 +00:00
			`$ sudo systemctl stop transmission-daemon.service`

Proposed README.rst cleanups @arky please revert any of these changes/suggestions as necessary! 2018-08-20 18:15:26 +00:00			`$ sudo nano /etc/transmission-daemon/settings.json`
Correct transmission variables and use 'to_json' Ensure that transmission_http_port variable is not reset in iiab-gen-iptables. Remote the extra qoutes and also use to_json to clean the transmission_kalite_languages output. Restructure the defaults section. Update the README documentation. 2018-08-18 04:13:16 +00:00
Minor syntax and cosmetics fixes 2018-08-18 04:32:45 +00:00			`Adding torrents`
			`---------------`
Proposed README.rst cleanups @arky please revert any of these changes/suggestions as necessary! 2018-08-20 18:15:26 +00:00
			`Transmission can facilitate provisioning your IIAB, by adding KA Lite content from places like: http://pantry.learningequality.org/downloads/ka-lite/0.17/content/`

			`You can also download other torrents using Transmission's web interface, or by typing 'transmission-remote' at the command-line.`
Initial Import 2018-08-16 09:36:45 +00:00
Enable adding multiple language torrents. You can add multiple ka-lite language downloads by using provisioning system. Also added notes to the readme file. 2018-08-17 15:40:48 +00:00			`$ transmission-remote -a <path_to_the.torrent>`
Initial Import 2018-08-16 09:36:45 +00:00
Enable adding multiple language torrents. You can add multiple ka-lite language downloads by using provisioning system. Also added notes to the readme file. 2018-08-17 15:40:48 +00:00			`Known Issues`
Proposed README.rst cleanups @arky please revert any of these changes/suggestions as necessary! 2018-08-20 18:15:26 +00:00			`------------`

			`* Default Transmission user/group (See https://github.com/transmission/transmission/issues/537). Currently you need to set these "transmission_user" and "transmission_group" variables. Check their values in transmission-daemon's systemd unit file: lib/systemd/system/transmission-daemon.service`
Initial Import 2018-08-16 09:36:45 +00:00
Proposed README.rst cleanups @arky please revert any of these changes/suggestions as necessary! 2018-08-20 18:15:26 +00:00			`* Random Ports: Currently it is not possible to use random ports in the range 49152-65535. It is difficult to open multiple ports in IIAB's iptables-based firewall.`
Initial Import 2018-08-16 09:36:45 +00:00
Minor syntax and cosmetics fixes 2018-08-18 04:32:45 +00:00			`Troubleshooting`
Proposed README.rst cleanups @arky please revert any of these changes/suggestions as necessary! 2018-08-20 18:15:26 +00:00			`---------------`
Correct transmission variables and use 'to_json' Ensure that transmission_http_port variable is not reset in iiab-gen-iptables. Remote the extra qoutes and also use to_json to clean the transmission_kalite_languages output. Restructure the defaults section. Update the README documentation. 2018-08-18 04:13:16 +00:00
			`Please check if the transmission daemon is running:`

			`$ sudo systemctl status transmission-daemon.service`

Proposed README.rst cleanups @arky please revert any of these changes/suggestions as necessary! 2018-08-20 18:15:26 +00:00			`Check that Transmission's settings are correct in: /etc/transmission-daemon/settings.json`