mirror of
https://github.com/iiab/iiab.git
synced 2025-02-13 19:52:06 +00:00
60 lines
3.3 KiB
ReStructuredText
60 lines
3.3 KiB
ReStructuredText
==============
|
||
Kolibri README
|
||
==============
|
||
|
||
This Ansible role installs `Kolibri <https://learningequality.org/kolibri/>`_ within `Internet-in-a-Box (IIAB) <http://internet-in-a-box.org/>`_. Kolibri is an open-source educational platform specially designed to provide offline access to a wide range of quality, openly licensed educational contents in low-resource contexts like rural schools, refugee camps, orphanages, and also in non-formal school programs.
|
||
|
||
Using It
|
||
--------
|
||
|
||
If enabled and with the default settings Kolibri should be accessible at http://box:8009 (and in future at http://box/kolibri, work is ongoing in 2018 at `#913 <https://github.com/iiab/iiab/issues/913>`_).
|
||
|
||
To login to Kolibri enter::
|
||
|
||
Username: Admin
|
||
Password: changeme
|
||
|
||
Configuration Parameters
|
||
------------------------
|
||
|
||
Please look in `roles/kolibri/defaults/main.yml <https://github.com/iiab/iiab/blob/master/roles/kolibri/defaults/main.yml>`_ for the default values of the various install parameters. Everything in this README assumes the default values.
|
||
|
||
Automatic Device Provisioning
|
||
-----------------------------
|
||
|
||
When kolibri_provision is enabled (e.g. in `/etc/iiab/local_vars.yml <http://wiki.laptop.org/go/IIAB/local_vars.yml>`_) the installation will set up the following defaults::
|
||
|
||
Kolibri Facility name: 'Kolibri-in-a-Box'
|
||
Kolibri Preset type: formal # Options: formal, nonformal, informal
|
||
Kolibri default language: en # Options: ar, bn-bd, en, es-es, fa, fr-fr, hi-in, mr, nyn, pt-br, sw-tz, ta, te, ur-pk, yo, zu
|
||
Kolibri Admin username: Admin
|
||
Kolibri Admin password: changeme
|
||
|
||
*Feel free to override any of the above, by copying the relevant line from /opt/iiab/iiab/roles/kolibri/defaults/main.yml to /etc/iiab/local_vars.yml (then run 'cd /opt/iiab/iiab' followed by './runrole kolibri' per IIAB's general guidelines at http://FAQ.IIAB.IO).*
|
||
|
||
Cloning Content
|
||
---------------
|
||
|
||
Kolibri 0.10 introduced ``kolibri manage deprovision`` which will remove user configurations, leaving content intact — i.e. if student and teacher privacy requires their records be deleted. You can then copy or clone /library/kolibri to a new location, or to a new school entirely.
|
||
|
||
Troubleshooting
|
||
----------------
|
||
|
||
You can run the server manually with the following commands::
|
||
|
||
systemctl stop kolibri # Make sure the systemd service is not running
|
||
export KOLIBRI_HOME=/library/kolibri
|
||
export KOLIBRI_HTTP_PORT=8009 # Otherwise Kolibri will try to run on default port 8080
|
||
kolibri start
|
||
|
||
To return to using the systemd unit::
|
||
|
||
kolibri stop
|
||
systemctl start kolibri
|
||
|
||
Known Issues
|
||
-------------
|
||
|
||
* Kolibri migrations can take a long time on a Raspberry Pi. These long-running migrations could cause kolibri service timeouts. Try running migrations manually using command ``kolibri manage migrate`` after following the troubleshooting instructions above. Kolibri developers are trying to address this issue. (See `learningequality/kolibri#4310 <https://github.com/learningequality/kolibri/issues/4310>`_)
|
||
|
||
* Loading channels can take a long time on a Raspberry Pi. When generating channel contents for Khan Academy, the step indicated as “Generating channel listing. This could take a few minutes…” could mean ~30 minutes. The device’s computation power is the bottleneck. You might get logged out while waiting, but this is harmless and the process will continue. Sit tight!
|