iiab/roles/kalite/README.rst

==============
KA Lite README
==============

This role installs KA Lite, an offline version of Khan Academy (https://www.khanacademy.org) created by Learning Equality
(https://learningequality.org/ka-lite/).

KA Lite downloads Khan Academy videos to your Internet-in-a-Box for offline use, with exercises and accounts if students want to track their own progress.

[Originally KA Lite had two servers, a light httpd server that serves Khan Academy videos, and a cron server that sets up cron jobs to download language packs and KA videos from the internet.  There were separate flags to enable these two servers.]

Using It
--------

If enabled with the default settings, KA Lite should be accessible at http://box:8008 or http://box.lan:8008

After your Internet-in-a-Box (IIAB) is completely installed, log in to KA Lite to explore and configure::

  Username: Admin
  Password: changeme

Bulk Downloading Videos
-----------------------

Videos and their corresponding PNG thumbnail images can be copied into /library/ka-lite/content and will be recognized the next time KA Lite is started.

Please see http://FAQ.IIAB.IO ("KA Lite Administration: What tips & tricks exist?") to use BitTorrent to download compressed KA Lite videos, that are much smaller than the ones downloaded via KA Lite's administrative interface.

As of August 2018, please also consider the `"Transmission" BitTorrent tool <https://github.com/iiab/iiab/tree/master/roles/transmission#transmission-readme>`_ that will automatically download thousands of KA Lite videos to your Internet-in-a-Box (IIAB) — if you install and enable "transmission" within /etc/iiab/local_vars.yml — carefully choosing the language(s) you want as downloading these videos can take many hours if not days!

Configuration Parameters
------------------------

Look at `role/kalite/defaults/main.yml <https://github.com/iiab/iiab/blob/master/roles/kalite/defaults/main.yml>`_ for the default values of the various install parameters.

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

Starting with KA Lite 0.15 (October 2015) you can run the server manually with the following commands:

* systemctl stop kalite-serve (make sure the systemd service is not running)
* export KALITE_HOME=/library/ka-lite (point kalite to the right environment)
* kalite start (start the server; can take more than 10 minutes in some environments)

To return to using the systemd unit:

* export KALITE_HOME=/library/ka-lite (point kalite to the right environment)
* kalite stop
* systemctl start kalite-serve

*In late 2017, Internet-in-a-Box added a virtual environment (/usr/local/kalite/venv/) to keep KA Lite's Python package/dependency risks under control.  As such the command* `/usr/bin/kalite <https://github.com/iiab/iiab/blob/master/roles/kalite/templates/kalite.sh.j2>`_ *is a wrapper to this virtualenv.*
initial checkin -- May 27, 2017 2017-05-27 18:09:50 +00:00			`==============`
cleaner README 2017-10-27 13:58:40 +00:00			`KA Lite README`
initial checkin -- May 27, 2017 2017-05-27 18:09:50 +00:00			`==============`

Update README.rst 2018-08-31 01:34:32 +00:00			`This role installs KA Lite, an offline version of Khan Academy (https://www.khanacademy.org) created by Learning Equality`
Update README.rst 2018-08-31 00:44:32 +00:00			`(https://learningequality.org/ka-lite/).`
initial checkin -- May 27, 2017 2017-05-27 18:09:50 +00:00
Update README.rst 2018-08-31 01:34:32 +00:00			`KA Lite downloads Khan Academy videos to your Internet-in-a-Box for offline use, with exercises and accounts if students want to track their own progress.`
initial checkin -- May 27, 2017 2017-05-27 18:09:50 +00:00
Update README.rst 2018-08-31 01:09:03 +00:00			`[Originally KA Lite had two servers, a light httpd server that serves Khan Academy videos, and a cron server that sets up cron jobs to download language packs and KA videos from the internet. There were separate flags to enable these two servers.]`

			`Using It`
			`--------`
initial checkin -- May 27, 2017 2017-05-27 18:09:50 +00:00
Update README.rst 2018-08-31 01:18:40 +00:00			`If enabled with the default settings, KA Lite should be accessible at http://box:8008 or http://box.lan:8008`
initial checkin -- May 27, 2017 2017-05-27 18:09:50 +00:00
Update README.rst 2018-08-31 01:49:27 +00:00			`After your Internet-in-a-Box (IIAB) is completely installed, log in to KA Lite to explore and configure::`
initial checkin -- May 27, 2017 2017-05-27 18:09:50 +00:00
Update README.rst 2018-08-31 00:44:32 +00:00			`Username: Admin`
Update README.rst 2018-08-31 01:09:03 +00:00			`Password: changeme`
initial checkin -- May 27, 2017 2017-05-27 18:09:50 +00:00
Update README.rst 2018-08-31 01:41:34 +00:00			`Bulk Downloading Videos`
			`-----------------------`
initial checkin -- May 27, 2017 2017-05-27 18:09:50 +00:00
Update README.rst 2018-08-31 01:18:40 +00:00			`Videos and their corresponding PNG thumbnail images can be copied into /library/ka-lite/content and will be recognized the next time KA Lite is started.`
Update README.rst 2018-08-31 00:44:32 +00:00
Update README.rst 2018-08-31 01:18:40 +00:00			`Please see http://FAQ.IIAB.IO ("KA Lite Administration: What tips & tricks exist?") to use BitTorrent to download compressed KA Lite videos, that are much smaller than the ones downloaded via KA Lite's administrative interface.`

			As of August 2018, please also consider the `"Transmission" BitTorrent tool <https://github.com/iiab/iiab/tree/master/roles/transmission#transmission-readme>`_ that will automatically download thousands of KA Lite videos to your Internet-in-a-Box (IIAB) — if you install and enable "transmission" within /etc/iiab/local_vars.yml — carefully choosing the language(s) you want as downloading these videos can take many hours if not days!
initial checkin -- May 27, 2017 2017-05-27 18:09:50 +00:00
			`Configuration Parameters`
			`------------------------`

Update README.rst 2018-08-31 00:44:32 +00:00			Look at `role/kalite/defaults/main.yml <https://github.com/iiab/iiab/blob/master/roles/kalite/defaults/main.yml>`_ for the default values of the various install parameters.
initial checkin -- May 27, 2017 2017-05-27 18:09:50 +00:00
Update README.rst 2018-08-31 00:44:32 +00:00			`Troubleshooting`
			`---------------`
initial checkin -- May 27, 2017 2017-05-27 18:09:50 +00:00
Update README.rst 2018-08-31 00:44:32 +00:00			`Starting with KA Lite 0.15 (October 2015) you can run the server manually with the following commands:`
initial checkin -- May 27, 2017 2017-05-27 18:09:50 +00:00
			`* systemctl stop kalite-serve (make sure the systemd service is not running)`
			`* export KALITE_HOME=/library/ka-lite (point kalite to the right environment)`
Update README.rst 2018-08-31 00:44:32 +00:00			`* kalite start (start the server; can take more than 10 minutes in some environments)`
initial checkin -- May 27, 2017 2017-05-27 18:09:50 +00:00
			`To return to using the systemd unit:`

			`* export KALITE_HOME=/library/ka-lite (point kalite to the right environment)`
			`* kalite stop`
			`* systemctl start kalite-serve`
Update README.rst 2018-08-31 00:44:32 +00:00
Update README.rst 2018-08-31 01:48:28 +00:00			In late 2017, Internet-in-a-Box added a virtual environment (/usr/local/kalite/venv/) to keep KA Lite's Python package/dependency risks under control. As such the command `/usr/bin/kalite <https://github.com/iiab/iiab/blob/master/roles/kalite/templates/kalite.sh.j2>`_ is a wrapper to this virtualenv.