Gestion avancée¶

Faire fonctionner Kolibri à partir de la ligne de commande¶

Sous Windows, il vous faudra ouvrir l’invite de commande, par exemple au moyen du raccourci WIN + R, puis en tapant cmd.
Sur MacOS, ouvrez Spotlight et saisissez Terminal. Vous pouriez aussi avoir besoin de préfixer les commandes de python -m, par exemple python -m kolibri start.
Si vous utilisez Kolibri avec le fichier .pex, assurez-vous de remplacer kolibri dans les commandes ci-dessous par le nom exact du fichier que vous avez téléchargé précédé de ./. Par exemple, pour démarrer Kolibri à partir du fichier téléchargé kolibri-v0.12.pex, saisissez ./kolibri-v0.12.pex start.

Avertissement

Dans les commandes ci-dessous, les chevrons et le texte qu’ils contiennent <...> sont utilisés pour indiquer les paramètres substituables à modifier. Assurez-vous de les remplacer par vos propres informations.

En cas d’erreurs dans l’invite ou dans la sortie du terminal lors de l’exécution des commandes ci-dessous, demandez de l’aide sur nos Forums communautaires, ou signalez le problème sur GitHub.

Démarrer/Arrêter Kolibri¶

Dans le cas où vous auriez besoin de résoudre des problèmes potentiels pendant l’exécution de Kolibri, vous pouvez essayer de le démarrer manuellement à partir de la ligne de commande.

kolibri start --debug --foreground

kolibri stop

Importer des chaînes de contenu à partir d’Internet¶

Pour importer des chaînes de contenu à partir d’Internet, exécutez ces deux commandes en succession. La première télécharge la base de données des chaînes, et la seconde les ressources (vidéos, documents, etc.).

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

Par exemple (Channel ID sans chevrons <...>) :

kolibri manage importchannel -- network a9b25ac9814742c883ce1b0579448337
kolibri manage importcontent -- network a9b25ac9814742c883ce1b0579448337

Avertissement

Lorsque vous importez des chaînes de contenu à partir de la ligne de commande, vous devez toujours utiliser l’ID de chaîne à 32 chiffres, car la commande ne fonctionnera pas avec le jeton. Assurez-vous d’obtenir le bon ID de chaîne de la part de la personne ayant créé la chaîne non répertoriée que vous devez importer, ou référez-vous au Guide de l’utilisateur de Kolibri Studio pour découvrir comment le localiser dans l’interface utilisateur de Studio si vous avez accès aux chaînes en tant qu’éditeur.

Exporter des chaînes de contenu¶

Pour exporter des chaînes de contenu Kolibri sur un support amovible afin de les partager avec un autre appareil, exécutez ces deux commandes en succession. La première exporte la base de données des chaînes, et la seconde les ressources (vidéos, documents, etc.).

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

Le chemin doit pointer vers un dossier nommé KOLIBRI_DATA à la racine du support amovible, afin qu’il soit récupéré plus tard pour l’import via l’interface Web.

Réordonner des chaînes de contenu¶

Vous pouvez définir l’ordre spécifique des chaînes de contenu dans la page Apprendre selon vos préférences. Suivez les étapes suivantes.

Pour afficher la liste des chaînes dans l’ordre actuel, exécutez la commande :

kolibri manage listchannels

Les résultats ressembleront aux suivants :

Pos       ID                                      Name
---       --                                      ----
1         95a52b386f2c485cb97dd60901674a98        CK-12 Testing
2         a9b25ac9814742c883ce1b0579448337        TESSA - Teacher Resources

Pour définir la position d’une chaîne en particulier, exécutez la commande :

kolibri manage setchannelposition <Channel ID> <Pos>

Exemple reprenant les chaînes ci-dessus :

kolibri manage setchannelposition a9b25ac9814742c883ce1b0579 1

Pos       ID                                      Name
---       --                                      ----
1         a9b25ac9814742c883ce1b0579448337        TESSA - Teacher Resources
2         95a52b386f2c485cb97dd60901674a98        CK-12 Testing

Créer un nouveau super administrateur¶

Au cas où vous auriez besoin de créer un autre super admin, soit car vous avez besoin d’un utilisateur supplémentaire pour gérer l’établissement, soit parce que vous avez perdu le mot de passe de l’ancien super administrateur, exécutez la commande suivante.

kolibri manage createsuperuser

Vous serez invité à entrer votre Nom d’utilisateur et un Mot de passe et le nouveau compte super admin sera créé.

Importer des utilisateurs à partir d’un fichier CSV¶

Note

Cette fonctionnalité est actuellement en phase expérimentale, merci donc de transmettre à l’équipe de développement tous les détails concernant les problèmes que vous pourriez rencontrer lors de son utilisation.

La commande fonctionne sur les versions 0.9 et ultérieures de Kolibri.

Structure du fichier CSV¶

Pour importer des utilisateurs dans Kolibri à l’aide de cette commande, vous devrez fournir les données utilisateurs dans un fichier au format CSV (comma separated values). Vous pouvez exporter ce fichier CSV à partir de données tabulaires de n’importe quel tableur (Excel, Google Sheets, LibreOffice Calc, etc.).

Données utilisateurs dans un tableur.

La ligne d’en-tête est facultative, mais si vous ne l’incluez pas, Kolibri supposera que les données sont fournies dans l’ordre suivant :

<full_name>,<username>,<password>,<facility>,<class>
Si vous incluez une ligne d’en-tête, vous pouvez fournir moins de données ou les placer dans un ordre différent :

<full_name>,<username>,<password>

<username>,<full_name>
Seul le username est important.
Lorsque vous ne fournissez pas de mots de passe pour les utilisateurs importés, Kolibri leur assignera par défaut le mot de passe kolibri.
L’établissement peut correspondre soit au nom, soit à l’identifiant de l’établissement. Si vous ne fournissez pas d’établissements, Kolibri importera les utilisateurs dans l’établissement par défaut de l’appareil. Vous pouvez aussi spécifier l’établissement en ajoutant l’argument --facility dans la ligne de commande (voir ci-dessous).

kolibri manage importusers your-csv-file.csv

kolibri manage importusers your-csv-file.csv --facility <your-facility>

Changer le mot de passe d’un utilisateur¶

Exécutez la commande suivante pour changer le mot de passe d’un utilisateur.

kolibri manage changepassword <username>

On vous demandera deux fois d’entrer le nouveau mot de passe pour l’utilisateur.

Supprimer définitivement des utilisateurs¶

Si vous avez besoin de supprimer définitivement un utilisateur Kolibri et toutes les données associées à son compte, pour par exemple garantir ses droits à la vie privée conformément au RGPD, utilisez la commande suivante.

kolibri manage deleteuser <username>

Avertissement

Cela effacera définitivement toutes les données de l’utilisateur.

Sauvegarder et restaurer la base de données Kolibri¶

Kolibri sauvegarde automatiquement la base de données à chaque changement de version. Si pour une raison quelconque vous devriez effectuer une sauvegarde manuelle, utilisez la commande suivante.

kolibri manage dbbackup

Cette commande créera un fichier .dump horodaté dans le dossier ./kolibri/backups que vous pourrez utiliser pour restaurer la base de données grâce à la commande suivante.

kolibri manage dbrestore --latest

Pour restaurer la base de données à partir d’un fichier .dump spécifique, utilisez l’option --select pour voir l’ensemble des fichiers disponibles triés par date, et sélectionnez celui dont vous avez besoin.

kolibri manage dbrestore --select

Avertissement

Cette commande n’est pas destinée à la duplication sur différents appareils, mais seulement à la restauration sur un seul appareil à partir d’une sauvegarde locale de la base de données.

Changer l’emplacement des fichiers de contenu Kolibri¶

Les chaînes de contenu Kolibri peuvent occuper une quantité considérable d’espace sur le disque dur au fil du temps. Si vous craignez de manquer d’espace de stockage sur votre appareil, vous pouvez déplacer les fichiers de contenu de Kolibri sur un autre disque.

Astuce

Si vous disposez à la fois d’un disque SSD et d’un disque dur sur votre appareil, il est recommandé d’installer Kolibri sur le disque SSD pour permettre un accès plus rapide à la base de données, et de déplacer uniquement le fichier de contenu vers le disque dur.

Pour déplacer les dossiers de contenu Kolibri vers un autre emplacement, suivez les étapes suivantes.

Arrêtez Kolibri.

kolibri stop

Créez un nouveau dossier qui contiendra l’ensemble des fichiers de contenu et des ressources sur le disque de destination.

kolibri manage content movedirectory <destination>
Par exemple, si vous avez créé un nouveau dossier KolibriContent sur un disque externe, exécutez la commande suivante.
kolibri manage content movedirectory /mnt/my_external_drive/KolibriContent
Si vous travaillez sous Windows, et que le nouveau dossier KolibriContent se trouve sur le disque F:, lancez la commande suivante.
kolibri manage content movedirectory F:\KolibriContent

Redémarrez Kolibri.

Cette commande va déplacer les 2 sous-dossiers databases et storage, de leur emplacement par défaut dans le dossier .kolibri/content du répertoire d’accueil de votre appareil, vers le nouvel emplacement spécifié dans la commande.

Changer l’emplacement de TOUS les fichiers Kolibri¶

Si vous voulez souhaitez déplacer tous les fichiers d’exécution de Kolibri, ainsi que les chaînes de contenu importées, vous devez remplacer la variable d’environnement appelée KOLIBRI_HOME par le chemin de votre choix.

Si la variable n’est pas définie, par défaut, les fichiers d’exécution et le contenu de Kolibri seront placés dans le dossier personnel de votre utilisateur, au sein du sous-dossier » .kolibri « .

Note

L’ajustement de cette variable d’environnement se comporte différemment de la commande movedirectory ci-dessus :

Ajuster la variable d’environnement ne transfèrera pas automatiquement les données. Vous devrez copier le dossier .kolibri manuellement vers le nouvel emplacement.
Si vous copiez le dossier .kolibri, le contenu ne sera pas affecté s’il avait été précédemment défini en utilisant la commande movedirectory.

Il existe de nombreuses façons de définir une variable d’environnement de façon temporaire ou permanente. Pour démarrer Kolibri dans OSX ou Linux avec un accueil différent, suivez les étapes suivantes.

Arrêtez le serveur.
Déplacez le dossier .kolibri vers le nouvel emplacement.
Exécutez les opérations suivantes dans le Terminal :

KOLIBRI_HOME=/path/to/new/home kolibri start

Lorsque vous redémarrez le serveur, tous vos fichiers devraient être détectés sans problème à cet endroit.

Pour changer la variable d’environnement KOLIBRI_HOME dans Windows, suivez les étapes suivantes.

Arrêtez le serveur.
Déplacez le dossier .kolibri vers le nouvel emplacement.
Lancez la commande suivante dans l’invite de commande :

setx KOLIBRI_HOME "/path/to/new/home"

Redémarrez le serveur, et vos fichiers devraient être détectés sans problème dans le nouvel emplacement.

Sinon, vous pouvez suivre les étapes suivantes dans l’interface graphique.

Allez dans Ordinateur > Paramètres avancés du système et appuyez sur le bouton Variables d’environnement.
Dans la section Variables utilisateur pour…, appuyez sur le bouton Nouveau….
Saisissez KOLIBRI_HOME dans le champ Nom de la variable, et votre nouveau chemin dans le champ Valeur de la variable, et appuyez sur OK dans les deux fenêtres ouvertes.
Redémarrez Kolibri.

Personnaliser les paramètres de Kolibri avec le fichier OPTIONS.INI¶

Pour certains paramètres de configuration, vous devez utiliser le fichier options.ini. L’installation de Kolibri ne génère pas ce fichier par défaut, mais vous pouvez facilement en ajouter un vous-même. Suivez les étapes suivantes.

Ouvrez l’éditeur de texte de votre choix sur votre ordinateur (p. ex. Bloc-notes sur Windows).
Saisissez les sections et clés exigées (voir détails pour les paramètres disponibles ci-dessous) dans le format suivant :
[section] key1 = a key2 = b

Enregistrez le fichier options.ini obtenu du dossier .kolibri dans le dossier Accueil.

Note

Le fichier options.ini peut contenir plusieurs sections avec une ou plusieurs clés associées, selon les exigences de votre installation.

Exécuter Kolibri à partir d’un port différent¶

Si vous avez besoin que Kolibri démarre et fonctionne à partir d’un port autre que le port par défaut 8080, ajoutez la section [Deployment], et la clé HTTP_PORT avec la valeur du port en question dans le fichier options.ini.

[Deployment]
HTTP_PORT = 1234
# Substitute 1234 with your desired port number

Astuce

Si après avoir défini le port de votre choix dans le fichier options.ini, Kolibri fonctionne encore à partir d’un autre port, la variable d’environnement KOLIBRI_HTTP_PORT d’une installation précédente est probablement prioritaire. Vérifiez le fichier .bashrc sur Linux, ou lancez la commande set dans l’invite de commande dans Windows, pour le vérifier et le corriger si nécessaire.

Autoriser le profilage des requêtes¶

Si vous avez besoin de profiler les requêtes du serveur pour obtenir des informations plus détaillées sur la performance de Kolibri, ajoutez les éléments suivants au fichier options.ini.

[Server]
PROFILE = 1

Tester la performance du serveur Kolibri¶

Test d’évaluation de la performance¶

Vous pouvez utiliser la commande suivante pour obtenir des informations relatives à l’appareil sur lequel le serveur Kolibri est exécuté, et des détails sur la quantité de ressources qu’il utilise. Cette commande affiche une vue instantanée de l’état du serveur au moment où la commande est exécutée, et sa sortie variera en fonction de la charge actuelle du serveur. Si vous soupçonnez des problèmes de performances, saisissez cette commande dans le Terminal ou dans l’invite de commande.

kolibri manage benchmark

La commande aura une sortie similaire à celle-ci :

La sortie de la ligne de commande “kolibri manage benchmark”

Faites une capture d’écran du Terminal ou de la ligne de commande, ou copiez et collez la sortie dans le forum communautaire.

Profilage¶

Pour obtenir plus qu’un instantané des performances actuelles du serveur Kolibri, vous pouvez utiliser la commande de profilage. Une fois exécutée, la commande collectera une série d’indicateurs de performance toutes les 10 secondes et les enregistrera dans un fichier CSV. Saisissez cette commande dans le Terminal ou l’invite de commande.

kolibri manage profile

Astuce

La commande recueille et enregistre les informations 60 fois par défaut. Si vous voulez changer cette valeur, ajoutez l’option --num-samples suivi du nombre souhaité.

kolibri manage profile --num-samples=100

Chaque ligne du journal contient les informations suivantes :

La date et l’heure de l’exécution de chaque commande
Le nombre de sessions actives de Kolibri (y compris les sessions d’invités)
Le nombre d’utilisateurs connectés à Kolibri
Le nombre d’interactions des utilisateurs de Kolibri au cours de la minute écoulée
Le pourcentage total d’utilisation du processeur
L’espace total de la mémoire utilisé
Le total de la mémoire disponible
Le nombre de traitements en cours d’exécution dans le serveur
Le pourcentage de processeur utilisé par Kolibri
Le pourcentage de mémoire utilisée par Kolibri

Afin de nous aider à résoudre les problèmes potentiels sur votre serveur Kolibri, situez et envoyez-nous le fichier KOLIBRI_HOME/performance/date_time_performance.csv.

Profilage des requêtes du serveur¶

Si vous avez configuré la section [Server] du fichier OPTIONS.INI avec PROFILE = 1, la commande ci-dessus effectuera également un profilage de chaque requête faite par le serveur Kolibri, et enregistrera les résultats dans un second fichier journal sous le nom KOLIBRI_HOME/performance/date_time_requests_performance.csv

Chaque ligne du journal contient les informations suivantes :

L’horodatage
Le chemin de la requête
Le temps de traitement de la requête
La mémoire (en Ko) utilisée par Kolibri à réception de la requête
La mémoire (en Ko) utilisée par Kolibri lors de l’envoi de la réponse
Le pourcentage de processeur utilisé par Kolibri à réception de la requête
Le pourcentage de processeur utilisé par Kolibri lors de l’envoi de la requête
Un indicateur signalant si la requête est la plus lente depuis le début de l’analyse

Avertissement

Le profilage des requêtes du serveur peut consommer beaucoup de ressources de l’appareil, et potentiellement le ralentir. Pour cette raison, vous devez l’autoriser explicitement dans le fichier options.ini. Sans la clé PROFILE = 1, la commande ne profilera pas les requêtes du serveur (mais seulement l’état actuel du serveur), et ne génèrera pas le second fichier CSV.

Provisionner les disques durs pour plusieurs serveurs Kolibri¶

Pour la procédure d’installation et de provisionnement recommandée de plusieurs appareils serveur Kolibri, référez-vous à notre didacticiel sur le provisionnement de disques durs.