From be51c32a74ab0b99833f3ad89caa4a8b10fa6f10 Mon Sep 17 00:00:00 2001 From: A Holt Date: Mon, 20 Aug 2018 14:15:26 -0400 Subject: [PATCH] Proposed README.rst cleanups @arky please revert any of these changes/suggestions as necessary! --- roles/transmission/README.rst | 53 ++++++++++++++++++----------------- 1 file changed, 28 insertions(+), 25 deletions(-) diff --git a/roles/transmission/README.rst b/roles/transmission/README.rst index f7680ee0f..12029afea 100644 --- a/roles/transmission/README.rst +++ b/roles/transmission/README.rst @@ -1,59 +1,62 @@ -===================== +=================== Transmission README -===================== -Transmission is a set of lightweight BitTorrent clients (in GUI, CLI and daemon form). All its incarnations feature a very simple, intuitive - interface on top on an efficient, cross-platform back-end. +=================== -The transmission program is used to download and seed Ka-Lite packages. Once the packages are downloaded, Please verify the content -before copying them to Ka-Lite content directory. +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"). + +Usage of Transmission consumes significant Internet data and system resources. +Caveat emptor! (That's Latin for "Buyer Beware") Access ------ -You can login transmission using its web interface http://box:9091/ with the following administration account. +Login to Transmission's web interface http://box:9091 using administrative account: Username: Admin Password: changeme -Alternatively you can also access transmission using the 'transmission-remote' or 'transmission-remote' on the command line. +Alternatively, you can type 'transmission-remote' at the command-line. Configuration --------------- -You can configure transmission using the web interface http://box:9091. +------------- -You can also edit the transmission settings in '/etc/transmission-daemon/settings.json'. Before you start editing the -'settings.json' file, Please ensure that transmission-daemon.service is stop. +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 +$ sudo nano /etc/transmission-daemon/settings.json Adding torrents --------------- -The transmission provisioning system is designed to add ka-Lite packages. You can also use transmission is -download torrent using the Transmission web interface or using 'transmission-remote' program. + +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 Known Issues -------------- -* Default Transmission user/group (See https://github.com/transmission/transmission/issues/537) -Currently you need to set these these in "transmission_user" and "transmission_group" variables. You can check -the value for these in transmission-daemon systemd unit file "lib/systemd/system/transmission-daemon.service" -* Random Ports -Currently it is not possible to use random ports in the range 65535-49152. It is difficult to open multiple ports in IIAB firewall. +------------ +* 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 the transmission settings '/etc/transmission-daemon/settings.json' are correct. +Check that Transmission's settings are correct in: /etc/transmission-daemon/settings.json