10.9. Variables du config.php

Certaines des options de configuration ne peuvent pas être fixées dans l’interface d’administration du site mais doivent être gérées dans le fichier config.php. Dans cette section sont décrites les différentes variables qu’ils est possible d’utiliser ainsi que les raisons pour lesquelles vous devriez placer certaines d’entre-elles dans le fichier config.php.

Le fichier config.php``se trouve dans le dossier ``/htdocs de votre site. Si vous désirez afficher toutes les variables possibles et leurs valeurs fixées par défaut, vous les trouverez dans /htdocs/lib/config-defaults.php. Les valeurs par défaut ne devraient pas être modifiées dans le fichier config-defaults.php mais vous pouvez surcharger celle-ci en copiant la variable et changeant sa valeur lorsque vous la collez dans config.php.

10.9.1. Anatomie d’une variable de configuration

Une variable de configuration doit être écrite en respectant scrupuleusement sa syntaxe sinon le paramètre ne sera pas pris en compte. Dans Mahara, la syntaxe est toujours $cfg->variable = valeur;.

A typical configuration variable

Variable de configuration classique

  1. $cfg-> : Signifie « configuration » et indique que ce qui suit est une variable de configuration.
  2. variable = : C’est à cet endroit que vous indiquez le nom de la variable à définir. Généralement ce nom est composé d’un seul mot ou de plusieurs mots reliés avec un trait de soulignement. Le nom des variables ne peut pas contenir d’espace ou de caractères diacritiques.
  3. valeur : On indique ici la valeur que l’on désire placer dans la variable. Cette valeur peut prendre différentes formes, par exemple :
    • « true » ou « false » pour activer respectivement désactiver l’option
    • du texte
    • des chiffres
    • un chemin d’accès

Note

Si vous désirez modifier la valeur par défaut d’une variable dans votre installation de Mahara, copiez-la depuis le fichier config-defaults.php et collez-la dans config.php. De cette manière vous conservez la valeur par défaut et surtout la valeur que vous donnez à la valeur sera conservée après une mise à jour de votre installation. Si config-defaults.php peut être modifié par une mise à jour ou une réinstallation de Mahara, config.php n’est jamais touché.

10.9.2. openbadgedisplayer_source : Sources pour le plug-in d’affichage des Badges ouvertes (Open Badges)

$cfg->openbadgedisplayer_source = '{"nomCourt":"url","nomCourt":"url"}';

Afin de pouvoir afficher des Badges ouverts (Open Badges) dans le bloc « Badges ouverts », les sites qui hébergent les différents sacs à badges doivent être indiqués. Par défaut, seuls le sac à badges de Mozilla et celui de Open Badge Passport sont accessibles. Si vous avez d’autres sources que vous aimeriez autoriser, vous devez les ajouter aux sources par défaut.

10.9.3. passwordsaltmain : Défini un mot de passe global de salage pour le site

$cfg->passwordsaltmain = 'votre phrase secrète';

Le salage en cryptographie permet d’éviter des attaques pour entrer de manière non autorisée sur votre site. Le salage est une méthode qui ajoute à l’envoi d’un mot de passe une suite de caractère fixée dans un paramètre du site et connu que de l’administrateur de celui-ci. Ceci évite, si un mot de passe a été volé ou déterminé par des méthodes d’analyse fréquentielle qu’il puisse être utilisé tant que le pirate ne connaît pas la phrase de salage. En utilisant une phrase dans le paramètre « passwordsaltmain » permet à Mahara d’améliorer la sécurité de cryptage de ceux-ci dans la base de données, en plus de les rendre encore plus aléatoires.

Si vous ne fixer pas une phrase de salage, une alerte sera affiché à chaque fois que vous accédez sur la « Page d’accueil » site en tant qu’administrateur.

10.9.4. pathtoclam : Chemin d’accès au logiciel antivirus ClamAV

$cfg->pathtoclam = '/chemin/vers/votre/clamscan';

Si vous avez installé le logiciel antivirus ClamAV sur votre serveur et que vous n’avez pas défini de recherche de virus au niveau global du système, vous pouvez indiquer à Mahara où trouver le programme. Les fichiers qui seront téléversés seront alors contrôlés par ClamAV avant d’être effectivement disponibles. Pour des raisons de sécurité, le chemin d’accès à ClamAV doit être indiqué dans le fichier config.php pour éviter qu’une personne qui aurait accès à l’interface d’administration du site puisse modifier ou désactiver l’antivirus.

Vous pouvez contrôler que le chemin a bien été défini dans les « Paramètres de sécurité ».

10.9.5. probationenabled : Donne aux utilisateurs un statut de probation

$cfg->probationenabled = true; ou $cfg->probationenabled = false;

Si vous mettez $cfg->probationenabled = true;, vous devriez aussi mettre quelque chose comme $cfg->probationstartingpoints = 2;.

Vous pouvez fixer un niveau de probation pour éviter que des utilisateurs qui se sont enregistrés par eux-mêmes sur votre site ne viennent que pour polluer les forums avec du pourriel. Ceci est souvent un problème rencontré sur les site publics. Utilisez les deux variables suivantes pour vous en prémunir :

  • $cfg->probationenabled = true;: Ce paramètre active la possibilité de mettre des utilisateurs en phase de probation.
  • $cfg->probationstartingpoints = 2; : Cette option fixe le nombre de points de probation qu’un nouvel utilisateur auto-inscrit reçoit par défaut. Dans cet exemple, les utilisateurs reçoivent deux points qu’ils doivent faire disparaître avant d’être à même de participer aux activités de groupe, d’échange et de communication dans Mahara.

Vous pouvez modifier ce nombre de point de manière individuelle pour chaque utilisateur dans la page des préférences de l’utilisateur dans la zone d”Administration.

10.9.6. remoteavatarbaseurl : URL du serveur d’avatars distant

$cfg->remoteavatarbaseurl = 'http://exemple.edu/avatar/';

L’image du profil de vos utilisateurs peut être obtenu depuis un service comme Gravatar. Si vous hébergez votre propre service, comme par exemple Libravatar, vous pouvez faire pointer Mahara directement sur ce service à l’aide de cette variable de configuration.

Vous décidez dans les Préférences de l’utilisateur si l’avatar distant doit être affiché ou non.

10.9.7. renamecopies : Renommer les pages et les collections dupliquées

$cfg->renamecopies = true; ou $cfg->renamecopies = false;

L’administrateur du site peut décider de faire automatiquement commencer le nom des pages et collections dupliquées par « Copie de… » en utilisant la variable $cfg->renamecopies = true;. La valeur par défaut est $cfg->renamecopies = false;.

10.9.8. showloginsideblock : Affiche ou cache le bloc permettant de se connecter au Mahara

$cfg->showloginsideblock = true; ou $cfg->showloginsideblock = false;

Vous pouvez masquer le formulaire de connexion en mettant la variable $cfg->showloginsideblock = false; dans votre fichier config.php. Une fois que vous avez fait cela, seul un lien vers la page de connexion est affichée aux administrateurs et autres utilisateurs utilisant la méthode d’authentification interne à Mahara.

Link to the login form

Lien vers le formulaire de connexion

Cette option est utile lorsque vous effectuez la connexion à Mahara par un autre site distant (sso).

Par défaut, la valeur est fixée à « vrai » et le bloc de connexion est donc affiché.

10.9.9. sitethemeprefs : Choisir son thème de navigation parmi tous les thèmes

$cfg->sitethemeprefs = true; ou $cfg->sitethemeprefs = false;

Si l’administrateur du site l’autorise, vous pouvez choisir un thème, depuis les « Préférences utilisateur », pour naviguer dans votre portfolio. De ce fait vous n’êtes pas forcé d’utiliser le thème de votre institution, ou si vous êtes membres de plusieurs, de choisir parmi les thèmes fixes de chacune d’entre-elles.

10.9.10. skins : Habillage

$cfg->skins = true; ou $cfg->skins = false;

Vous pouvez permettre aux utilisateur de personnaliser l’apparence de leurs portfolios en plus du thème. Ceci se fait par l’ajout ou la création d’un habillage dans Mahara. Les habillages peuvent être créés de de manière globale au niveau du site, ou par des individus. Les institutions peuvent permettre ou interdire l’utilisation des habillages à leurs utilisateurs.

10.9.11. new in Mahara 16.04 urlsecret : Lance le cron ou la mise à jour seulement lorsque vous en êtes autorisé

$cfg->urlsecret = 'unpetitsecret';

Sans cette variable de configuration, n’importe qui peut lancer le cron (tâches programmées) sur votre site ou une mise à jour qui pourrait potentiellement poser problèmes.

Placez cette variable dans votre fichier config.php pour surcharger la valeur par défaut. Choisissez votre propre phrase secrète (mettez-la entre deux apostrophes) que seul un nombre restreint de personnes connaîtra. Vous ne pourrez lancer le cron ou une mise à jour depuis le navigateur qu’en connaissant la phrase secrète.

A chaque fois que vous voulez lancer manuellement le cron ou faire une mise à jour, vous devez ajouter la phrase secrète à la fin de l’URL. Les URL pour lancer le cron ou la mise à jour se présentent comme suit (remplacer « unpetitsecret » par votre mot ou phrase secrète) :

  • cron : /lib/cron.php?urlsecret=unpetitsecret
  • mise à jour : /admin/upgrade.php?urlsecret=unpetitsecret

Note

Si vous possédez un Mahara pour le développement, ou un serveur de test qui se trouve derrière un par feu, vous ne désirez peut-être pas ajouter la phrase secrète à l’URL à chaque fois, d’autant plus encore si vous êtes la seule personne à accéder à cette instance de Mahara. Vous pouvez alors placer l’instruction $cfg->urlsecret = null dans le fichier config.php pour éviter de saisie la phrase secrète. Toutefois, vous ne devriez pas faire cela pour un site en production ou pour un site qui est accessible par un grand nombre de personnes.

10.9.12. usersuniquebyusername : Le nom d’utilisateur stocké dans Mahara a la préemption sur celui qui permet de se connecter depuis une méthode d’authentification distante.

$cfg->usersuniquebyusername = true; ou $cfg->usersuniquebyusername = false;

Il s’agit d’une fonctionnalité expérimentale. Quand cette option est activée, cela signifie que quelle que soit le nom d’utilisateur du système d’authentification externe utilisé par une personne, elle se connectera sur le même compte que l’utilisateur a enregistré dans la base de données de Mahara; alors le nom d’utilisateur distant est remplacé par celui de la base de données interne à Mahara.