1
0
Fork 0
mirror of https://github.com/iiab/iiab.git synced 2025-03-09 15:40:17 +00:00
iiab/roles/kalite
georgejhunt 7f9957aa55
0.3 patch1 (#1377)
* expand zim_versions_idx to include menuItem name, mediaCount, articleCount, size

* create a stub menuItem if none exists

* remember to change consumer of zim_version_idx in iiab-admin

* comment out some debugging prints

* do not change the name of a variable in iiab.ini

* consistent variable names for *_enabled

* start work on menus for enabled iiab roles

* changes to display cups in home menu

* remove reference to admin console which may not be installed

* print error message

* dict.get errors

* handle undefined menuItem"

* handle undefined menuItem again

* some work on logos

* break out the zim_versions_idx routines for use by update_menus in admin-console

* remove old menuDef creation code

* new variable names for zim_versions_idx

* missing the tags data in zim_versions_idx

* un-break-apart iiab-make-kiwix-lib.py

* return an empty string

* make size human_readable

* getting console and iiab to work together on menus

* add the new zim_date field to zim_versions_idx

* get the latest into repo

* found lost code iiab-make-kiwix-lib.py

* Create Lokole admin user during setup

* Add requested content to lokole readme
Per iiab/iiab#1293

* Update default password

* Add Lokole-IIAB user manual

* Update default_vars.yml

* Update local_vars_min.yml

* Update local_vars_min.yml

* Update local_vars_medium.yml

* Update local_vars_min.yml

* Update default_vars.yml

* Update local_vars_big.yml

* Update local_vars_medium.yml

* Update default_vars.yml

* Update default_vars.yml

* Update local_vars_min.yml

* Update local_vars_medium.yml

* Update local_vars_big.yml

* Update default_vars.yml

* Update default_vars.yml

* Update local_vars_big.yml

* Update local_vars_medium.yml

* Update local_vars_min.yml

* Update default_vars.yml

* Update local_vars_big.yml

* Update local_vars_medium.yml

* Update local_vars_min.yml

* Change admin username to uppercase

* Revert "Lokole: change admin to Admin per IIAB app norms"

* Update main.yml

* Update README.rst

* Update capture-wsgi.py

* Update main.yml

* Update main.yml

* Update default_vars.yml

* Update local_vars_big.yml

* Update local_vars_medium.yml

* Update local_vars_min.yml

* Update main.yml

* Update main.yml

* Update main.yml

* Update main.yml

* Update default_vars.yml

* Update local_vars_big.yml

* Update local_vars_medium.yml

* Update local_vars_min.yml

* Address TODOs in Lokole documentation

See https://github.com/ascoderu/opwen-webapp/issues/81

* Update main.yml

* Update local_vars_big.yml

* Update local_vars_medium.yml

* Update local_vars_big.yml

* Update local_vars_min.yml

* Update default_vars.yml

* expand zim_versions_idx to include menuItem name, mediaCount, articleCount, size

* create a stub menuItem if none exists

* remember to change consumer of zim_version_idx in iiab-admin

* comment out some debugging prints

* do not change the name of a variable in iiab.ini

* consistent variable names for *_enabled

* start work on menus for enabled iiab roles

* changes to display cups in home menu

* remove reference to admin console which may not be installed

* print error message

* dict.get errors

* handle undefined menuItem"

* handle undefined menuItem again

* some work on logos

* break out the zim_versions_idx routines for use by update_menus in admin-console

* remove old menuDef creation code

* new variable names for zim_versions_idx

* missing the tags data in zim_versions_idx

* un-break-apart iiab-make-kiwix-lib.py

* return an empty string

* make size human_readable

* getting console and iiab to work together on menus

* add the new zim_date field to zim_versions_idx

* get the latest into repo

* found lost code iiab-make-kiwix-lib.py
2019-01-10 14:26:47 -08:00
..
defaults Update main.yml 2018-07-19 22:06:16 -04:00
tasks 0.3 patch1 (#1377) 2019-01-10 14:26:47 -08:00
templates No longer used in 2018 2018-10-15 01:58:34 -04:00
README.rst Update README.rst 2018-11-04 11:47:52 -05:00

==============
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.*

More Tips & Tricks
------------------

If you're online, please see "KA Lite Administration: What tips & tricks exist?" at: http://FAQ.IIAB.IO

If you're offline, Internet-in-a-Box's FAQ (Frequently Asked Questions) is here: http://box/info