external/iiab
1
0
Fork 0
mirror of https://github.com/iiab/iiab.git synced 2025-03-09 15:40:17 +00:00
Code Issues Releases Wiki Activity

Merge pull request #1841 from holta/kolibri-readme2

Browse source 
Update Kolibri's README.rst for IIAB 7.0
This commit is contained in:
A Holt 2019-07-08 07:13:22 -04:00 • committed by GitHub
commit 44eb7c1f86
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

16
roles/kolibri/README.rst
View file

@ -4,10 +4,12 @@ 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. 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.
Kolibri's online User Guide is here: `https://kolibri.readthedocs.io <https://kolibri.readthedocs.io/>`_
Using It 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>`_). If enabled and with the default settings, Kolibri should be accessible at: http://box/kolibri
To login to Kolibri enter:: To login to Kolibri enter::
@ -17,15 +19,15 @@ To login to Kolibri enter::
Configuration Parameters 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. Please look in `/opt/iiab/iiab/roles/kolibri/defaults/main.yml <defaults/main.yml>`_ for the default values of the various install parameters. Everything in this README assumes the default values.
Automatic Device Provisioning 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:: When kolibri_provision is enabled (e.g. in `/etc/iiab/local_vars.yml <http://FAQ.IIAB.IO#What_is_local_vars.yml_and_how_do_I_customize_it.3F>`_) the installation will set up the following defaults::
Kolibri Facility name: 'Kolibri-in-a-Box' Kolibri Facility name: 'Kolibri-in-a-Box'
Kolibri Preset type: formal # Options: formal, nonformal, informal 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 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 username: Admin
Kolibri Admin password: changeme Kolibri Admin password: changeme
@ -42,12 +44,12 @@ Troubleshooting
You can run the server manually with the following commands:: You can run the server manually with the following commands::
systemctl stop kolibri # Make sure the systemd service is not running systemctl stop kolibri # Make sure the systemd service is not running
export KOLIBRI_HOME=/library/kolibri export KOLIBRI_HOME=/library/kolibri
export KOLIBRI_HTTP_PORT=8009 # Otherwise Kolibri will try to run on default port 8080 export KOLIBRI_HTTP_PORT=8009 # Otherwise Kolibri will try to run on default port 8080
kolibri start kolibri start
To return to using the systemd unit:: To return to using the systemd unit file::
kolibri stop kolibri stop
systemctl start kolibri systemctl start kolibri
@ -59,4 +61,4 @@ Known Issues
* 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! * 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!
* More up-to-date list of Kolibri issues being worked on, as of March 2019: `#1545 <https://github.com/iiab/iiab/issues/1545>`_ * Active list of Kolibri issues, as of July 2019: `#1545 <https://github.com/iiab/iiab/issues/1545>`_