Manage Kolibri

Default User Roles

Kolibri users by default can be divided in 3 different roles with respective access to features.

Default user roles
Learners can:
  • View content and have their progress tracked
Coaches can:
  • View content and have their progress tracked
  • View Coach dashboard and track progress of other users and usage stats for individual exercises
  • Create/Edit/Delete Groups in Classes and add users to them
  • Create/Edit/Delete Exams and assign them to users
  • Create/Edit/Delete Lessons and assign them to users

Facility Coaches have access to all classes, Class Coaches only to ones they are assigned to

Admins can:
  • View content and have their progress tracked
  • View Coach dashboard and track progress of other users and usage stats for individual exercises
  • Create/Edit/Delete other Admins, Coaches, and Learners
  • Create/Edit/Delete Classes and enroll users in them
  • Create/Edit/Delete Groups in Classes and add users to them
  • Create/Edit/Delete Exams and assign them to users
  • Create/Edit/Delete Lessons and assign them to users
  • View/Edit Facility configuration settings
  • Export Detail and Summary logs usage data

Kolibri Superusers

Kolibri Superusers have all device permissions and are able to assign them to other users. Therefore Superusers can:

  • View content and have their progress tracked
  • View Coach dashboard and track progress of other users and usage stats for individual exercises
  • Create/Edit/Delete other Admins, Coaches, and Learners
  • Create/Edit/Delete Classes and enroll users in them
  • Create/Edit/Delete Groups in Classes and add users to them
  • Create/Edit/Delete Exams and assign them to users
  • Create/Edit/Delete Lessons and assign them to users
  • View/Edit Facility configuration settings
  • Export Detail and Summary logs usage data
  • Import/Export Content channels
  • View/Edit Permissions of other users

Tip

If you are unable to retrieve the username and password for a superuser account in your facility, you can create a new superuser account using the command line.

Assign Additional Permissions

By default, only Superusers can view the Device dashboard, import/export Content channels in Kolibri, and modify Permissions for other users. However, depending on the needs of the institution, Superusers can also grant these permissions to other users.

Manage Device

You can manage content and permissions, and view the detailed info of the device where Kolibri is running from the Device dashboard.

Note

To manage device settings you must have the appropriate permissions.

Assign Permissions

You can assign additional permissions to Kolibri users which will provide them access to more features compared to their user roles. To manage permissions for Kolibri users, use the Permission tab in the Device dashboard (Permissions icon).

manage permissions

Permission to Manage Content

To grant permission to manage content channels in Kolibri to another user, follow these steps.

  1. Click Edit permissions for the chosen user.
  2. Under Device Permissions activate the option Can import and export content channels.
  3. Click Save changes to apply and finish.
grant permissions to manage content

The users who have been granted the permissions to manage content channels will have a black key indicator in front of their name, and will be able to see the Device dashboard with the Content tab.

Superuser Permissions

To grant Superuser permissions to another user, follow these steps.

  1. Click Edit permissions for the chosen user.
  2. Activate the option Make superuser.
  3. Click Save changes to apply and finish.
grant superuser permissions

The users who have been granted the Superuser permissions will have a yellow key indicator in front of their name, and will be able to see the Device dashboard with both the Content and Permissions tabs.

permissions indicators

View Device Info

To view the detailed info of the device where Kolibri is running on, use the Info tab in the Device dashboard (Info icon). This information will be useful in case you need to report an issue with Kolibri on the Learning Equality Community Forums. Make note or copy the following device details:

  • Kolibri version
  • Server IP/URL(s)
  • Database path
  • Device name
  • Operating system
  • Free disk space
  • Server time
  • Server timezone
Find out the detailed device info in the Device > Info tab.

Find out the detailed device info in the Device > Info tab.

Manage Content

Note

To manage Kolibri content channels you must have the appropriate permissions.

Kolibri Content Channel is a collection of educational resources (video, audio, document files or interactive apps) prepared and organized by the content curator for their use in Kolibri. You can import and export content channels in Kolibri from the Content tab of the Device dashboard (Content icon).

manage content page with list of available channels

Each Kolibri content channel has its own token/ID in Kolibri Studio. You can freely view and browse content to import from the public channels in Kolibri, but in order to import content from private or unlisted channels, you will need the channel token or ID from the content curator who assembled it.

Note

The term Channel ID was valid for Kolibri versions up to 0.6, while from the Kolibri version 0.7 onward, we started using exclusively the term token to uniquely designate each channel.

Warning

When you use the Terminal or command prompt to import content channels in Kolibri from the command line, you still must use the 32 digit channel ID, as the command will not work with the token. Make sure to receive the correct channel ID from the person who curated the channel you need to import, or refer to Kolibri Studio user guide how to find it in Studio user interface, if you have channel editor access.

Import Content into Kolibri

Warning

Important: You cannot import your own files (videos, documents, etc.) as learning resources directly into Kolibri from your computer. Kolibri can only import content from:

  • already curated content channels on Kolibri Studio, if the computer running Kolibri is connected to internet

OR

  • an external storage drive (USB or hard drive) where content channels have been previously exported to from another Kolibri installation, if the computer running Kolibri is not connected to internet

To import your own files for use in Kolibri, you need to register at Kolibri Studio site (it’s free), and build your own content channel that you can subsequently import into Kolibri. Read more about how to do this in our Kolibri Studio user guide.

Tip

As a precaution, we recommend you avoid other interactions with Kolibri (view learner pages or manage users, for example) while content import is in progress.

To import content into Kolibri, follow these steps.

  1. Click Import button in the Content page.
  2. Choose the source option: Kolibri Studio or Attached drive or memory card.
choose source for importing content

Import Content from Kolibri Studio

If the computer where Kolibri is running has an Internet connection with the sufficient bandwidth, follow these steps to import content channels.

  1. Choose option Kolibri Studio, and you will be able to see all the available public content channels.

    Select from which public channel you want to import content from.

    Channels from which you have already imported some or all content onto your device will have the On your device icon.

  2. Click Select button for the desired channel, and wait for Kolibri to display the channel information and the topic tree.

    Warning

    This could take some time for big channels. Please be patient, as Kolibri needs to retrieve a lot of information to display.

  3. In the Select content from… page you will see all the details for the selected channel: description, version, total size and number of learning resources, with the information weather you have some of the resources from that channel already imported on the local device.

    Select topics and resources to import from channel.
  4. Under Choose content to import click the topics links to browse through the channel contents. Use the Select all checkbox to import the content channel in full, or select only certain topics or resources. As you keep selecting, you will see the total number and size on disk under Resources selected:, and the remaining space on your device.

  5. Click Import button once you finish selecting all the desired content.

  6. Wait for the content to be downloaded and click Close for the new channel to appear under the Content heading.

    wait for import channel to finish
  7. If you need to import content from a private/unlisted channel, click on Try adding the token link above the channel list.

  8. Enter the channel token/ID received from the channel curator on Kolibri Studio.

    enter content token to import from unlisted channel
  9. Click Confirm to unlock channel, or Cancel to exit.

  10. Proceed to select and import channel topics and resources as for the public channels.

    Unlisted or private channels in the list are indicated with the Unlisted channel icon.

  11. To add more learning resources from a channel that you previously imported content from, click Actions, select Import more, and repeat the selection procedure from step 3.

Import Content from a Local Drive

If the computer where Kolibri server is running does not have access to Internet or has insufficient bandwidth, you have the option to receive content channels stored on an external drive (USB stick or hard disk). Follow these steps to import content channels.

  1. Connect the external USB drive to your computer.
  2. Choose option for Attached drive or memory card, and click Continue.
  3. Kolibri will automatically detect and display the drive(s) with available Kolibri content files.
  4. Select the drive where the desired channel is stored, and click Continue.
  5. Click Select button for the desired channel, and follow the same steps for selecting topics and resources as for the import from Kolibri Studio.
import channel from detected local drive

Tip

Workaround for import from external drive on older devices.

If Kolibri is installed on an older or a low-resource device, you can try the following procedure for importing content channels for faster results.

  1. Stop Kolibri.
  2. Browse the local drive with the file explorer of your operating system.
  3. Copy the content folder located inside the KOLIBRI_DATA folder on the local drive.
  4. Paste the copied content folder inside the .kolibri folder on your hard disk. The location of the .kolibri folder will depend on your operating system (see the table below).
  5. Confirm the merge of the two folders.
  6. Restart Kolibri, and the new channels should now be available.
Operating system Location
Windows C:/Users/<your_username>/.kolibri/
OSX HD/Users/<your_username>/.kolibri/
Linux /home/<your_username>/.kolibri/

On Linux and OSX you will need to enable the Show hidden folders option in order to view the .kolibri folder.

Export from Kolibri to Local Drive

If you want to make available the content you have imported on your Kolibri device, to another computer where Kolibri is installed, follow these steps to export your content channels.

Note

You must have an external drive (SD card, USB stick or hard disk) attached to your device.

  1. Click Export button in Content page.

  2. Select the local drive (export destination) where you wish to export Kolibri content, and click Continue.

  3. In the Export to <name-of-your-drive> page you will be able to see all the available content channels on your device.

    Select from which channel you want to export to local drive.
  4. Click Select button for the desired channel, and wait for Kolibri to display the channel information and the topic tree.

  5. In the Select content from… page you will see all the details of the selected channel: description, version, total size and number of learning resources.

  6. Under Choose content to export you can browse the channel topics and individual resources. Use the Select all checkbox to import the content channel in full, or select only certain topics or resources. As you keep selecting, you will see the total number and size on disk under Resources selected:, and the remaining space on the destination drive.

  7. Click Export button once you finish selecting all the desired content.

  8. Wait for Kolibri to export the selected content and click Close.

  9. Once the export is finished, safely disconnect the drive according to the recommended procedure for your operating system, and proceed to import channels on other devices.

Note

This procedure makes a copy of the content folder located inside the .kolibri folder on your hard disk, and places it in the KOLIBRI_DATA folder on the selected local drive. This structure is recognized by the Import from local drive command.

structure of the local drive folders with exported content channels

Delete Channel

To delete a content channel from your device, follow these steps.

  1. Click Actions for the channel you want to delete.
  2. Select Delete option.
  3. Click Delete to proceed, or Cancel to exit without deleting the channel.
delete content channel from your device

Peer-to-Peer Content Synchronization

Stay tuned!

Manage Facility

You can edit facility configuration settings in Kolibri from the Settings tab in your Facility dashboard (Settings icon).

  1. Activate the options you want to make available for the users of your facility. You have the possibility to allow users to:

    • edit their full names and usernames
    • sign in without password (except Admin users)
    • download content items (videos, documents, etc.) on their own devices
    • allow guests to sign up and use Kolibri
  2. Click Save changes to apply and finish.

manage facility configuration settings

Note

To manage facility settings in Kolibri you must sign in as Superuser or Admin.

Manage Users

You can search for, filter, add, and edit user accounts in Kolibri from the Users tab in your Facility dashboard (Users icon).

manage users

Note

To manage Kolibri users you must sign in as Superuser or Admin.

Create a New User Account

To create a new user account, follow these steps.

  1. Click Add New button.

  2. Fill in the required information (name, username, password).

  3. Select user profile (Admin, Coach or Learner).

  4. Click Create Account to add the new user.

    add new account form

Coach Type

When you create a new Coach user account, or change the role to Coach for an existing user, you can choose between:

  • Class coach, that will have access to the coach dashboard and permissions to instruct ONLY the learners in the classes they are assigned to.

  • Facility coach, that will have access to the coach dashboard and permissions to instruct ALL the classes and the learners in the facility.

    choose between class coach and facility coach

Select Users by Type

  1. Click All Users selector to display user types.

  2. Toggle between options to filter the user roster according to type, or leave it as All Users to display all.

    select users

Edit User’s Account

To edit username, full name or account type, follow these steps.

  1. Click on the Manage button for the desired user and select the Edit option.
  2. Edit Full name or Username in the Edit user window.
  3. Click Save to update the edited information, or Cancel to exit without saving.
edit account info form

Reset User’s Password

  1. Click on the Manage button for the desired user and select the Reset password option.
  2. Enter the new password in both fields.
  3. Click Save to confirm, or Cancel to exit without changing the password.
edit password form

Delete User’s Account

  1. Click on the Manage button for the desired user and select the Delete option.
  2. Click Delete to confirm, or Cancel to exit without deleting the account.
confirm delete account

Warning

When you delete a user, all their learning records will be erased from the database.

Manage Classes

You can view, create and delete classes, as well as search, filter and enroll Kolibri users in them, using the Classes tab in your Facility dashboard (Classes icon). Default view displays the list of all classes in your facility, with the number of enrolled users for each class.

manage classes

Note

To manage Kolibri classes you must sign-in as Superuser or Admin.

Add New Class

To add a new class, follow these steps.

  1. Click New class button.
  2. Fill in the class name.
  3. Click Create to add the new class, or Cancel to exit.
add new class

Delete Class

To delete class, follow these steps.

  1. Click Delete class button for the chosen class from the list.
  2. Click Delete class in the confirmation window to proceed, or Cancel to exit without deleting the class.
delete class

Note

Users enrolled in the class you are deleting will not be removed from the database.

Edit Class, Learners and Coaches

A newly created class does not have any learners or coaches. To edit a class select it from the default view in the Classes tab. In this view, you can change class name, add or remove currently enrolled learners and assign or remove coaches from the class.

new class with no learners and coaches

Change Class Name

To edit class name, follow these steps.

  1. Click on the Edit button (Edit icon) next to the class’ name.
  2. Write the new name in the Class name field.
  3. Click Update to confirm the edited information, or Cancel to exit without saving.
change class name

Enroll Learners in Class

  1. Click the Enroll learners button on the class details page.

    add users to class
    • List in this view contains all the learners currently NOT enrolled for the selected class.
    • You can search for a specific learner by name.
  2. Use checkboxes to select all the learners in the list, or the search field for specific learners you want to enroll to class.

  3. Click Confirm button to finish enrolling the selected learners.

Remove Learners from Class

  1. Click Remove button for the chosen learner.

  2. Click Remove to confirm, or Cancel to exit without removing the learner.

    remove learner from class

Note

Learners removed from the class will not be deleted from the database, and you can still access their accounts from the Users tab in the Facility dashboard.

Assign Coaches to Class

  1. Click the Assign coaches button on the class details page.
assign coaches to class
  • List in this view contains all the users with Coach, Facility coach or Admin roles.
  • You can search for a specific user by name.
  1. Use checkboxes to select all the users in the list, or the search field for specific users you want to assign as a coach to class.
  2. Click Confirm button to finish.

Remove Coaches from a Class

  1. Click Remove button for the chosen user.
  2. Click Remove to confirm, or Cancel to exit without removing the coach.
remove user from class

Note

Coaches removed from the class will not be deleted from the database, and you can still access their accounts from the Users tab in the Facility dashboard.

Manage Data

You can download Kolibri Detail and Summary logs usage data and export in the CSV format from the Data tab in your Facility dashboard (Data icon).

options for exporting usage data

Note

To manage Kolibri users you must sign-in as Superuser or Admin.

Working with Kolibri from the Command Line

Warning

  • In Windows you need to open cmd.exe Command prompt in the folder where Kolibri executable is located: c:/Python34/Scripts.
  • On macOS you may need to prefix the commands with python, for example python kolibri start.
  • If you are running Kolibri with the PEX file, make sure to substitute the kolibri in below commands with the exact name of the file you downloaded preceded by ./. For example, to start Kolibri from the downloaded file kolibri-v0.10.pex, type ./kolibri-v0.10.pex start.
  • Make sure not to include the angle brackets “< >” in the commands below.*

If you see errors in the prompt/terminal output while running the commands below, ask for help at our Community Forums, or file an issue on GitHub.

Start/Stop Kolibri

In case you need to troubleshoot potential problems while running Kolibri, you may try to start it manually from the command line.

kolibri start --debug --foreground
kolibri stop

Run Kolibri from a Different Port

If you need to change the default port 8080 from which Kolibri is serving content, add the following flag to the previous command.

kolibri start --port <new-port-number>

Import Content Channels from Internet

To import content channels from Internet, run these two commands in sequence. The first downloads the channel database, and the second downloads the resources (videos, documents, etc.).

kolibri manage importchannel -- network <Channel ID>
kolibri manage importcontent -- network <Channel ID>

Warning

When you import content channels from the command line, you still must use the 32 digit channel ID, as the command will not work with the token. Make sure to receive the correct channel ID from the person who curated the unlisted channel you need to import, or refer to Kolibri Studio user guide how to find it in Studio user interface, if you have channel editor access.

Export Content Channels

To export Kolibri content channels on a local drive in order to share it with another device, run these two commands in sequence. The first exports the channel database, and the second exports the resources (videos, documents, etc.).

kolibri manage exportchannel -- <Channel ID> /path/to/local/drive/KOLIBRI_DATA
kolibri manage exportcontent -- <Channel ID> /mount/mydrive/KOLIBRI_DATA

The path should be to a folder named KOLIBRI_DATA at the root of the local drive, so it will get picked up later for importing via the Web UI.

Create a New Superuser

In case you need to create another Superuser, either to address additional need of managing facility, or if you lost the password for the old one, run the following command.

kolibri manage createsuperuser

You will be prompted to input the Username and Password and the new Superuser user account will be created.

Change Language

kolibri language setdefault <langcode>
Language <langcode>
English en
Spanish (Spain) es-es
French fr
Swahili (Tanzania) sw-tz
Arabic ar
Farsi fa
Hindi (India) hi-in
Urdu (Pakistan) ur-pk
Marathi mr
Chinyanja nyn
Portuguese (Brasil) pt-br
Telugu te
Tamil ta

Backup and Restore Kolibri Database

Kolibri automatically creates a backup of the database with every version upgrade. If for some reason you need to make a manual backup, use the following command.

kolibri manage dbbackup

This command will create a time-stamped .dump file in the ./kolibri/backups folder that you can use to restore the database with the following command.

kolibri manage dbrestore --latest

If you need to restore a backup version prior to the latest one, you must specify the full path to a specific *.dump file.

kolibri manage dbrestore ~/.kolibri/backups/db-xxxx.dump

Warning

This command is not intended for replication across different devices, but only for restoring on a single device from a local backup of the database.

Change the Location of Kolibri Content Files

Kolibri content channels may occupy a considerable amount of hard disk space over time. If you have concerns about running out of storage on your device, you can move the Kolibri content files to another drive.

Tip

If you have both SSD disk and HDD disk available on your device, it is recommended to install Kolibri on the SSD drive to allow faster access to the database, and move just the content file to the HDD drive.

To move the Kolibri content folders to another location, follow these steps.

  1. Stop Kolibri.
kolibri stop
  1. Create a new folder that will contain all the content files and resources on the destination drive.
kolibri manage content movedirectory <destination>

For example, if you created a new folder KolibriContent on an external drive, run this command.

kolibri manage content movedirectory /mnt/my_external_drive/KolibriContent

If you are on Windows, and the new folder KolibriContent is on the drive F:, run this command.

kolibri manage content movedirectory F:\KolibriContent
  1. Restart Kolibri.

This command will move the 2 subfolders databases and storage, from their default location inside the .kolibri/content folder in your device’s home directory, to a new location you specified in the command.

Change the Location of ALL Kolibri Files

If you want to change the directory where all of Kolibri’s runtime files are located, together with the imported content channels, you need to change the environment variable called KOLIBRI_HOME to the path of your choice.

If the variable is left unset, by default, Kolibri’s runtime files and content will be placed in your user’s home folder, under the .kolibri subfolder.

Note

Adjusting this environment variable behaves differently than the movedirectory command above:

  • Adjusting the environment variable will not automatically migrate over data. You need to copy the .kolibri folder manually to the new location.
  • If you do copy the .kolibri folder, the content will not be affected if it had been previously set using the movedirectory command.

There are many ways to set an environment variable either temporarily or permanently. To start Kolibri on OSX or Linux with a different home, follow these steps.

  1. Stop the server.
  2. Move the .kolibri folder to the new location.
  3. Run the following in Terminal:
KOLIBRI_HOME=/path/to/new/home kolibri start

When you start the server again, all your files should be seamlessly detected at that location.

To change the environment variable KOLIBRI_HOME on Windows, follow these steps.

  1. Stop the server.
  2. Move the .kolibri folder to the new location.
  3. Run the following in Command Prompt:
setx KOLIBRI_HOME "/path/to/new/home"

Restart the server, and your files should be seamlessly detected at the new location.

Alternatively, you can follow these steps in the GUI.

  1. Go to Computer > Advanced System Settings and press the Environment Variables button.

  2. Under User Variables for… press the New… button.

  3. Input the new path and press OK on both open windows.

    Set the new path for Kolibri home.
  4. Restart Kolibri.

Support and Troubleshooting

Report a problem with Kolibri

If you want to contact the Learning Equality Support team to report an issue, or share your experience about using Kolibri, please register at our Community Forums.

Once you register on our forums, please read the the first two pinned topics (Welcome to Learning Equality Support Community and How do I post to this forum? )

You can add a new topic with the + New Topic button on the right. Make sure to select the Kolibri category in the Create a New Topic window so it’s easier to classify and respond to.

add new topic on community forums

Our technical users, including software developers, should follow the instructions on our Developer documentation for reporting bugs.

Locate Kolibri log files

When you report a problem with Kolibri, we may ask you to send us Kolibri log files to help us find out why is it not working or crashing.

Open the .kolibri folder inside the Home folder of the device where Kolibri is running and locate these two files:

  • kolibri.log
  • debug.log

Warning

On Linux and MacOS systems you will need to activate the Show Hidden Files option in your file browser, in order to view the .kolibri folder.

Troubleshoot Network Issues

  1. Can you access Kolibri when you type http://127.0.0.1:8080 in the address bar of the browser?
  2. Can you access anything from the external IP of the device running Kolibri FROM the device itself?
  3. Can you ping the external IP address from another device on the network? For example, if Kolibri is on a device/computer with IP address 192.168.0.104, type this in the Terminal or Command prompt:
ping 192.168.0.104

About IP addresses

  • 0.0.0.0 = A special IP address on the server (your device running Kolibri and “serving” its content to others in the local network), which actually means “all available IP addresses”. It’s a kind of alias. But accessing 0.0.0.0 from another computer doesn’t make sense and doesn’t work. By default, Kolibri will serve on 0.0.0.0, which essentially means all IP addresses that are available on the device will render Kolibri accessible.
  • 127.0.0.1 = A device’s local IP address, meaning “myself”. Some people joke and say “There’s no place like 127.0.0.1”, meaning “there’s no place like home” :) This can be used on the serving device itself to test that Kolibri is running, in case you need a failsafe way of checking that Kolibri is in fact running and responsive.
  • 192.x.y.z = Addresses starting with 192 are local network IP addresses. The same thing can be said about 10.x.y.z. The address that you wanna use to enter on the clients/tablets in order to contact the server will in most cases start with 192 or 10.
  • Port number: Kolibri runs on port 8080. When you access something on an IP address, you need a port. Ports can be open or closed on the server, but they can also be regulated by firewall rules on the way. http:// <- this is the protocol that the browser reads out from the “URL”, which is just some text that describes Kolibri.
  • http://192.168.1.1:8080 means: “Connect to IP address 192.168.1.1 on port 8080 with the HTTP protocol”. The browser will the continue to try to reach this address, but may fail for instance if Kolibri isn’t running, or if a step along the way blocks access.

Troubleshoot Database Issues

In case you receive the database disk image is malformed error in Terminal, try running these commands (note that you must have the sqlite3 command available on your system).

sqlite3 ~/.kolibri/db.sqlite3 .dump | sqlite3 fixed.db
cp fixed.db ~/.kolibri/db.sqlite3

For further assistance, please report the issue on our Community Forums, stating the operating system and Kolibri version.

Videos are not playing

Make sure to check the system requirements to see if you can support video playback. Please report any issues on our Community Forums, stating the operating system and browser you are using.

Problems with import and export from USB drives

Kolibri needs read and write access to USB drives in order to import and export content. There are several possibilities why you may encounter issues during this procedure.

  • User account does not have access:
    • you installed Kolibri in your own environment running as a non-desktop user (for instance UWSGI)
    • you have upgraded Kolibri on Debian from a version prior to v0.10. Follow these instructions to change the ownership of Kolibri system service from one user account to another
    • to grant access to USB drives to other accounts, refer to the documentation of your operating system
  • Write access denied: Some USB drives will experience problems when they are unplugged from the computer in an “unclean” way. If you are denied access to write, look for options to “fix” or “repair” the file system.
  • Data failures: Copying the data can take a long time. If you do not see the final success confirmation message after the copy apparently finishes, do not assume that the data has been imported or exported correctly. Restart the process instead, otherwise you risk inconsistent and malfunctioning content data.
  • Hardware life expectancy: SD and flash storage drives can “expire”. Reading and writing large quantities of content data, especially on older or models with smaller capacity, may produce data errors over time.