mirror of
https://github.com/iiab/iiab.git
synced 2025-02-15 04:32:11 +00:00
Merge pull request #1059 from holta/kalite-cleanup2
Quick Doc Cleanups: KA Lite, Calibre-Web, Transmission
This commit is contained in:
A Holt
GitHub
commit
a1b1b83f39
4 changed files with 33 additions and 30 deletions
|
|
@ -86,7 +86,8 @@
|
|||
state: restarted
|
||||
when: calibreweb_enabled
|
||||
|
||||
- name: Enable http://box/calibre-web with Apache
|
||||
# Default: http://box/books
|
||||
- name: Enable http://box{{ calibreweb_url }} with Apache
|
||||
command: a2ensite calibre-web.conf
|
||||
when: calibreweb_enabled
|
||||
|
||||
|
|
|
|||
|
|
@ -2,48 +2,50 @@
|
|||
KA Lite README
|
||||
==============
|
||||
|
||||
This role installs KA Lite, an offline version of the Khan Academy (https://www.khanacademy.org/),
|
||||
written by Learning Equality (https://learningequality.org/ka-lite/).
|
||||
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 has 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 are
|
||||
separate flags to enable these two servers.
|
||||
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.
|
||||
|
||||
Access
|
||||
------
|
||||
[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.]
|
||||
|
||||
If enabled and with the default settings KA Lite should be accessible at http://schoolserver:8008/
|
||||
Using It
|
||||
--------
|
||||
|
||||
To login to kalite enter
|
||||
If enabled with the default settings, KA Lite should be accessible at http://box:8008 or http://box.lan:8008
|
||||
|
||||
User Name: Admin
|
||||
Password: changme
|
||||
After your Internet-in-a-Box (IIAB) is completely installed, log in to KA Lite to explore and configure::
|
||||
|
||||
Bulk Loading Videos
|
||||
-------------------
|
||||
Username: Admin
|
||||
Password: changeme
|
||||
|
||||
Videos and their corresponding png images can be copied into /library/ka-lite/content and will
|
||||
be recognized the next time kalite is started. The kalite website has instructions on getting
|
||||
videos with bitsync. These videos are also smaller than the ones downloaded with the kalite
|
||||
admin interface.
|
||||
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
|
||||
------------------------
|
||||
|
||||
Please look in defaults/main.yml for the default values of the various install parameters. Everything
|
||||
in this readme assumes the default values.
|
||||
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.
|
||||
|
||||
Trouble Shooting
|
||||
----------------
|
||||
Troubleshooting
|
||||
---------------
|
||||
|
||||
Starting with kalite 0.15 you can run the server manually with the following commands:
|
||||
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 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.*
|
||||
|
|
|
|||
|
|
@ -2,12 +2,12 @@
|
|||
|
||||
# Assume all XOs are F18 and nothing else is
|
||||
|
||||
- name: Calc KA Lite db file name (Fedora 18)
|
||||
- name: Set KA Lite's SQLite filename (Fedora 18)
|
||||
set_fact:
|
||||
kalite_db_name: "{{ kalite_root }}/kalite/database/data.sqlite"
|
||||
when: is_F18
|
||||
|
||||
- name: Calc KA Lite db file name (OS's other than Fedora 18)
|
||||
- name: Set KA Lite's SQLite filename (OS's other than Fedora 18)
|
||||
set_fact:
|
||||
kalite_db_name: "{{ kalite_root }}/database/data.sqlite"
|
||||
when: not is_F18
|
||||
|
|
@ -46,7 +46,7 @@
|
|||
- option: name
|
||||
value: "KA Lite"
|
||||
- option: description
|
||||
value: '"KA Lite is a server to present Khan Academy videos offline and to download them."'
|
||||
value: '"KA Lite downloads Khan Academy videos for offline use, with exercises and accounts if students want to track their own progress."'
|
||||
- option: path
|
||||
value: "{{ kalite_root }}"
|
||||
- option: port
|
||||
|
|
|
|||
|
|
@ -17,7 +17,7 @@ Caveat emptor! (That's Latin for "Buyer Beware")
|
|||
Using It
|
||||
--------
|
||||
|
||||
Install Transmission by setting 'transmission_install' and 'transmission_enabled' to True in /etc/iiab/local_vars.yml and then running::
|
||||
Install Transmission by setting 'transmission_install' and 'transmission_enabled' to True in `/etc/iiab/local_vars.yml <http://wiki.iiab.io/local_vars.yml>`_ — carefully choosing language(s) for KA Lite videos you want to download — and then run::
|
||||
|
||||
cd /opt/iiab/iiab
|
||||
./runrole transmission
|
||||
|
|
@ -59,7 +59,7 @@ Adding Torrents
|
|||
|
||||
Transmission can facilitate provisioning content onto your IIAB, e.g. by adding thousands of KA Lite videos from places like: http://pantry.learningequality.org/downloads/ka-lite/0.17/content/
|
||||
|
||||
Please read the lettered instructions (A, B, C, D) in /etc/iiab/local_vars.yml and 'KA Lite Administration: What tips & tricks exist?' at http://FAQ.IIAB.IO outlining how to use Transmission to download and then install KA Lite content.
|
||||
Please read the lettered instructions (A, B, C, D) in `/etc/iiab/local_vars.yml <http://wiki.iiab.io/local_vars.yml>`_ and 'KA Lite Administration: What tips & tricks exist?' at http://FAQ.IIAB.IO outlining how to use Transmission to download and then install KA Lite content.
|
||||
|
||||
You can also download other torrents using Transmission's web interface, or by typing 'transmission-remote' at the command-line::
|
||||
|
||||
|
|
@ -68,7 +68,7 @@ You can also download other torrents using Transmission's web interface, or by t
|
|||
Known Issues
|
||||
------------
|
||||
|
||||
* Default Transmission user/group may need fixing (https://github.com/transmission/transmission/issues/537). You can set Ansible variables 'transmission_user' and 'transmission_group' e.g. in /opt/iiab/iiab/roles/transmission/defaults/main.yml (you might need 'User=' and 'Group=' in systemd unit file /lib/systemd/system/transmission-daemon.service — both might need to be set to 'debian-transmission' — if so 'systemctl daemon-reload' then 'systemctl restart transmission-daemon').
|
||||
* Default Transmission user/group may need fixing (https://github.com/transmission/transmission/issues/537) in some circumstances. You can set Ansible variables 'transmission_user' and 'transmission_group' e.g. in /opt/iiab/iiab/roles/transmission/defaults/main.yml (you might need 'User=' and 'Group=' in systemd unit file /lib/systemd/system/transmission-daemon.service — e.g. both might need to be set to 'debian-transmission' — if so then run 'systemctl daemon-reload' and 'systemctl restart transmission-daemon').
|
||||
|
||||
* 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.
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue