Open main menu

Manuel:LocalSettings.php

This page is a translated version of the page Manual:LocalSettings.php and the translation is 100% complete.

Other languages:
Bahasa Indonesia • ‎Deutsch • ‎English • ‎Nederlands • ‎Tiếng Việt • ‎Türkçe • ‎dansk • ‎español • ‎français • ‎français cadien • ‎magyar • ‎polski • ‎português do Brasil • ‎čeština • ‎Ελληνικά • ‎български • ‎русский • ‎العربية • ‎ತುಳು • ‎中文 • ‎日本語 • ‎한국어
Avertissement Avertissement : Ne modifiez pas LocalSettings.php avec des éditeurs de documents comme Notepad, TextEdit, ou d'autres qui ajoutent un Byte Order Mark (marque d'ordre d'octets) aux fichiers. Cela casserait le programme PHP de votre wiki. Utilisez plutôt un éditeur de code comme Vim, Notepad++, ou Atom. Ceux là gèrent l'encodage des fichiers de manière appropriée. Ils peuvent aussi être utilisés pour réparer les fichiers précédemment cassés par des éditeurs de documents.

Le fichier LocalSettings.php offre les paramètres de configuration de base (basés sur le fichier DefaultSettings.php ) pour une installation MediaWiki. Prenez votre temps pour vérifier ces paramètres dans le fichier. Celui-ci est habituellement généré par l'installateur de MediaWiki basé sur le Web, mais vous pouvez modifier les paramètres, éventuellement de concert avec les paramètres Apache. Pour les installations MediaWiki configurées en tant que wiki ferme, un fichier nommé CommonSettings.php peut être utilisé.

Contents

Emplacement sur le serveur

Le fichier LocalSettings.php n'est pas une page wiki et vous ne pouvez pas y accéder avec votre navigateur web. Au contraire, c'est un fichier dans le système de fichiers du serveur. Son contenu est généré lors de la configuration initiale du wiki et le fichier résultant doit être copié manuellement sur le serveur. Le fichier doit être situé dans le dossier où vous avez installé MediaWiki, au même niveau que les dossiers comme includes/ et skins/, et les fichiers comme api.php. Si ce fichier n'y est pas, le wiki ne fonctionnera pas du tout - si le wiki fonctionne, le fichier est là. Si vous ne savez pas où il est, vous pouvez entrer une commande telle que find / -iname LocalSettings.php -print dans une fenêtre de terminal pour le localiser.

(Si vous utilisez Vagrant, voyez aussi MediaWiki-Vagrant#Paramètres MediaWiki).

Sécurité

LocalSettings.php contient généralement des données sensibles telles que les connexions de base de données. Ces données ne devraient jamais être révélées au public ! En raison d'une violation de sécurité quelque part sur le serveur, il peut arriver que d'autres utilisateurs soient en mesure d'afficher le contenu des fichiers. Afin d'améliorer la sécurité de vos données, vous devez définir des autorisations UNIX en conséquence pour ce fichier. L'utilisateur du serveur web doit avoir accès à ce fichier. Si c'est le même compte que le propriétaire du fichier, alors vous pouvez initialiser ces autorisations à 600. Parfois, l'utilisateur du serveur web n'est pas le propriétaire du fichier, mais il est dans le groupe UNIX des utilisateurs propriétaire. Dans ce cas, les autorisations à 640 devraient convenir. Pour une sécurité améliorée, vous devriez restreindre le plus possible les autorisations.

En outre, vous pouvez créer un utilisateur MySQL, qui est limité uniquement à l'accès de la base de données seule utilisée par le wiki et à fournir les informations d'identification de cet utilisateur dans LocalSettings.php. Aussi vous pouvez configurer votre serveur de base de données pour accepter uniquement les connexions depuis localhost - ce qui devrait empêcher l'accès de l'extérieur en cas de fuite des informations d'identification.

Contenu du fichier

Lorsque vous modifiez LocalSettings.php, assurez-vous de l'enregistrer à nouveau dans le bon encodage. Vous devez utiliser l'encodage "ANSI en UTF-8" - c'est un encodage UTF-8 sans marqueur d'ordre des octets (byte order mark, BOM).

LocalSettings.php contient du code PHP ; principalement la définition des variables et de leurs valeurs. La modification d'un paramètre signifie habituellement la modification de la valeur d'une variable PHP. Vos modifications prendront effet immédiatement après avoir sauvegardé le fichier sur le serveur: Il n'est pas nécessaire de redémarrer manuellement quoi que ce soit. Quoi qu'il en soit, dans certains cas, vous devrez peut-être effacer le cache de votre navigateur pour voir réellement les modifications que vous avez apportées.

Les valeurs par défaut de beaucoup d'autres paramètres sont définies dans includes/DefaultSettings.php, qui ne doit pas être édité ; si la variable que vous voulez changer n'est pas déjà mentionnée dans votre LocalSettings.php, copiez la ligne appropriée de DefaultSettings.php et modifiez-la de manière appropriée dans LocalSettings.php. Dans LocalSettings.php, vous pouvez ajouter de nouvelles lignes à la fin.

Dans le fichier, il peut également y avoir plusieurs lignes telles que 'require_once "$IP/extensions/extension.php" ;', qui pointent vers les extensions. Ces lignes permettent d'activer l'extension concernée dans le wiki. Ces extensions peuvent nécessiter la définition des valeurs de plusieurs variables dans LocalSettings.php ; consultez la documentation de l'extension correspondante pour obtenir d'autres instructions.

Dans MediaWiki 1.16 et antérieurs il était important de ne pas placer les extensions avant la ligne require_once "includes/DefaultSettings.php"; ; ceci effaçait l'initialisation des tableaux de configuration des fonctions d'extension, n'entraînant pas l'installation des extensions, et rendant probablement votre wiki inaccessible. Depuis la 1.17 il n'est plus nécessaire pour LocalSettings.php d'inclure DefaultSettings.php.

Comme la plupart des fichiers PHP dans MediaWiki, LocalSettings.php ne se termine pas par la balise PHP de fermeture ?>. Cela empêche les administrateurs d'ajouter accidentellement de nouvelles informations après cette balise. PHP fonctionne bien sans balise de fermeture.

Si vous avez un wiki sur une ferme wiki de MediaWiki , vous n'avez peut-être pas accès en écriture (peut-être même pas d'accès en lecture) au fichier LocalSettings.php (voir par exemple [1]). La société qui gère la « ferme » peut ou non accepter de faire les changements que vous désirez. Peut-être veut-elle garder la plupart des paramètres identiques sur tous les wikis de la ferme wiki.

Avant la 1.17, ce fichier était généré automatiquement par le script d'installation et placé dans le dossier config. À partir de la 1.17, ce fichier n'est plus écrit sur votre serveur web pour des raisons de sécurité. Il est maintenant offert en tant que téléchargement, que vous devez ensuite téléverser sur votre serveur pour que votre wiki commence à travailler. Pour une explication plus complète, voir cette explication (en anglais).

Description des paramètres disponibles

Consultez l'index des paramètres de configuration et les commentaires inclus dans les fichiers de paramètres pour obtenir de l'aide sur ce que font toutes les variables. Vous trouverez ci-dessous une courte liste des variables les plus importantes, ainsi que les caractéristiques les plus demandées.

Paramètres standards

Inclure le chemin

La variable $IP (include path) contient le chemin du fichier local à l'installation de base de votre wiki. Depuis MediaWiki 1.17, MediaWiki définit $IP automatiquement - il n'est plus nécessaire de le définir manuellement dans LocalSettings.php. Il sera par défaut égal au répertoire de travail courant automatiquement et peut être utilisé sans avoir à le définir manuellement.

Le fichier DefaultSettings.php est chargé dans le répertoire désigné par la variable IP.

Nom du site

$wgSitename contient le nom de votre installation wiki. Ce nom sera inclus plusieurs fois dans tout le système, comme sur MediaWiki:Pagetitle. Par exemple, le slogan «  De Wikipédia, l'encyclopédie libre » fait usage de ce paramètre.

Déclinaison du nom du site

Certaines traductions de l'interface sont sensibles au changement du nom de site. Vous pouvez définir des formes plus appropriées du mot dans les variables $wgGrammarForms (pour un exemple, allez voir la page de documentation de $wgSitename ).

Langue du site

$wgLanguageCode contrôle la langue de l'interface de votre wiki. Alors que les utilisateurs peuvent changer la langue qu'ils voient dans leur préférences, cette variable définit la langue par défaut que voient tous les utilisateurs anonymes et la plupart des utilisateurs enregistrés.

Chemin du script

$wgScriptPath est le préfixe de l'URL d'accès au script principal de MediaWiki, qui est la pièce centrale du code de MediaWiki. Ce paramètre doit correspondre à la configuration Apache, en particulier si vous utilisez les règles Apache de réécriture.

Nom du serveur

$wgServer peut être utilisé pour remplacer éventuellement la détection automatique. Lorsque le wiki est atteint par le localhost où il s'exécute, soit à partir d'un réseau local (intranet) ou d'internet, alors les notifications par e-mail et quelques autres messages générés seront normalement transmis avec les différentes URL. L'utilisation de $wgServer remplace la détection et le nom du serveur sera constant.

Si www.example.com est l'adresse du serveur de votre wiki telle que visible depuis internet, ajoutez une ligne similaire à

$wgServer = 'http://www.example.com';

La variable magic word {{SERVER}} peut être utilisée sur les pages wiki ; cela équivaut à la valeur de $wgServer ; cependant, sur un wiki, comme ceux de la famille WikiMedia, où les urls relatives sont utilisées, elle ne sera pas entièrement développée, par exemple ici elle affiche //www.mediawiki.org, qui ne peut ni être cliqué ni copié/collé dans la barre d'adresse tel quel.

Nom du script

$wgScript est le nom du script PHP principal (index) de MediaWiki, nommé index.php par défaut. Changer le nom du script n'est probablement pas une bonne idée. Cependant, si vous en ressentez le besoin, c'est là qu'il faut faire vos modifications. Assurez-vous de bien savoir ce que vous faites.

Redirection du nom du script

$wgRedirectScript spécifie le chemin de l'URL vers le redirect script qui gère les redirections dans MediaWiki. Ce paramètre est similaire à wgScript puisque le nom exact du script peut être configuré. Comme mentionné ci-dessus, ce n'est probablement pas une bonne idée à moins que vous ne sachiez exactement ce que vous faites.

Chemin des articles

$wgArticlePath est le chemin à utiliser pour accéder à une page de MediaWiki. Le chemin doit contenir le chemin du script principal (habituellement en utilisant $wgScript) et utiliser la marque substitutive $1 désignant le nom de l'article.

Si vous utilisez les règles de réécriture Apache pour créer des URL courtes et simples, vous aurez probablement besoin de modifier $wgArticlePath pour utiliser le bon chemin. Il est à noter que wgArticlePath est utilisé pour construire des URLs au sein du MediaWiki. Si une erreur est commise ici, les liens internes seront incorrects alors qu'il sera toujours possible d'accéder à la page principale en entrant l'URL correcte manuellement. Voir Manual:Short URL pour plus d'informations sur la configuration d'URL.

La valeurs usuelles sont :

"$wgScript/$1" Passer le nom de l'article avec le séparateur "/"
"$wgScript?title=$1" Passer le nom de l'article en tant que paramètre (style ancien)
"/mypath/$1" Chemin personnalisé. Utiliser les règles de réécriture d'Apache pour convertir "mypath" en chemin d'accès approprié au script principal

Emplacement des feuilles de style

Utilisez $wgStylePath pour définir le chemin URL de l'emplacement des feuilles de style (CSS) dans l'installation MediaWiki. $wgStylePath doit pointer au même endroit, mais il s'agit du chemin dans le système de fichiers local, à utiliser dans les scripts internes accédant au système de fichiers.

Emplacement des téléversements

Le répertoire des téléversements est l'endroit où sont stockés les fichiers envoyés par les utilisateurs. $wgUploadPath spécifie le chemin de l'URL, et $wgUploadDirectory le chemin du fichier local dans le système.

$wgLogo définit le logo graphique à afficher en haut à gauche de chaque page du wiki. Ces étapes remplacent le logo par défaut du répertoire /wiki/skins/common/images/ , où /wiki est le chemin vers le répertoire où vous avez installé le logiciel Mediawiki.

D'abord, copiez le logo que vous voulez dans le répertoire /wiki/skins/common/images/ (en remplaçant /wiki par le chemin du répertoire où vous avez installé le logiciel MediaWiki).

Ensuite, essayez de trouver la ligne qui ressemble à ceci dans LocalSettings.php :

$wgLogo        = "{$wgStylePath}/common/images/wiki.png";

Si une telle ligne n'existe pas, vous pouvez copier et coller la ligne ci-dessus à la fin du fichier.

Ensuite, modifiez cette ligne pour pointer vers votre logo. Le logo doit être accessible à partir du web. La valeur de cette variable est transmise au navigateur Web, qui l'utilise pour récupérer le logo. En cas de doute, un bon moyen de choisir ce qu'il faut mettre ici est de naviguer vers le logo dans votre navigateur web (par exemple, l'url du logo de ce wiki est http://upload.wikimedia.org/wikipedia/mediawiki/b/bc/Wiki.png), et mettre l'URL complète comme la valeur de cette variable.

Certaines personnes remplacent simplement le fichier skins/common/images/wiki.png par leur logo. Ce n'est pas recommandé, car le logo personnalisé serait écrasé lors de la mise à niveau.

Informations de contact

$wgEmergencyContact correspond à l'adresse courriel de contact des utilisateurs pour les dysfonctionnements. Cette adresse courriel est utilisée pour envoyer les rapports de bogues internes. En tant qu'administrateur, vous pouvez mettre votre adresse courriel à la place.

$wgPasswordSender est l'adresse de où le courriel a été envoyé, lorsque les mots de passe sont envoyés aux utilisateurs qui les ont oubliés. Choisissez une adresse à laquelle on peut vous répondre en cas de problème ou de confusion.

Paramètres de la base de données

MediaWiki a besoin d'accéder à la base de données (actuellement MySQL ou PostgreSQL) pour stocker les pages, les modifications, les informations utilisateur et beaucoup d'autres choses.

$wgDBserver représente le nom de l'ordinateur où se trouve la base de données. Habituellement il s'agit de localhost car la base de données s'exécute sur le même système, mais pour les installations distributées, vous devez remplir le nom de domaine complètement qualifié (FQDN) de l'ordinateur sur lequel se trouve cette base.

$wgDBname est le nom de base de donnée de la base de données à utiliser par MediaWiki. Une installation unique de MySQL ou PostgreSQL peut gérer plus d'une base de données et vous pouvez même exécuter plusieurs installations de MediaWiki sur un même serveur. Assurez-vous de bien avoir déclaré le nom correct de la base de données et d'utiliser des noms différents pour les différentes installations de wikis sur le même serveur de bases de données.

$wgDBuser et $wgDBpassword contiennent le nom et le mot de passe du compte à utiliser par Mediawiki, pour la connexion et l'accès à la base de données. Assurez-vous que l'utilisateur spécifié a bien les droits d'accès correspondants pour pouvoir gérer les tables wiki du serveur de base de données.

Droits des utilisateurs

$wgGroupPermissions est un tableau associatif, contrôlant les niveaux de permission pour la création et la modification des pages, selon vos différents groupes d'utilisateurs. Dans ce tableau, les niveaux personnalisés de permission peuvent être créés, et les niveaux de permission pour les différents groupes d'utilisateurs peuvent être définis. Voir Help:User rights pour davantage d'informations concernant les différentes permissions et les groupes utilisateur disponibles.

Forcer les liens en majuscules

Par défaut, aucun nom de page ne peut commencer par une lettre minuscule lettre romaine : si c'était le cas, la première lettre serait convertie en majuscule ; si une cible de lien, une page, une image ou une catégorie incluse est spécifiée avec un nom commençant par une lettre minuscule, la cible réelle etc... est la page commençant par la lettre capitale correspondante.

Alternativement les noms de page peuvent commencer par une lettre minuscule, en plus des possibilités de commencer par une lettre capitale, un chiffre, etc. Pour cela, vous devez régler $wgCapitalLinks . Le réglage à false permet d'utiliser les caractères minuscules, et true choisit le comportement par défaut.

Activer les sous-pages

Dans LocalSettings.php, les sous-pages sont activées sur la base des espaces de noms à partir de $wgNamespacesWithSubpages . Par exemple, pour activer les sous-pages dans l'espace de noms principal :

$wgNamespacesWithSubpages[NS_MAIN] = 1;

Téléversement d'images

Pour autoriser les utilisateurs à téléverser des fichiers dans le système MediaWiki, vous devez activer cette fonctionnalité. Assurez-vous que le répertoire Upload est correctement configuré et accessible en écriture par le processus du serveur web Apache. Ensuite, initialisez $wgEnableUploads à true pour autoriser le téléversemnt depuis l'interface Web de l'utilisateur.

Voici des exemples de code pour « includes/DefaultSettings.php » à copier dans LocalSettings.php :

$wgUploadPath       = "$wgScriptPath/uploads";      ## Wiki 1.5 defaults to /images, but allows more than just images
$wgUploadDirectory  = "$IP/uploads";                ## Wiki 1.5 defaults to /images, but allows more than just images

## To enable image uploads, make sure the above '$wgUploadPath' directory is writable by Apache User or group.
## ''(i.e.  chmod og+w uploads images)''  then the following should be true:
$wgEnableUploads       = true;

$wgUseImageMagick      = true;
$wgImageMagickConvertCommand = "/usr/bin/convert";

## If you want to use image uploads under safe mode, create the directories images/archive, images/thumb and
## images/temp, and make them all writable. Then uncomment this, if it's not already uncommented:
$wgHashedUploadDirectory = false;

Pour pouvoir redimensionner les images à la volée et supporter les vignettes, MediaWiki nécessite l'installation de ImageMagick. Une fois celle-ci effectuée et après avoir testé ImageMagick, initialisez $wgUseImageMagick à true. Assurez-vous que $wgImageMagickConvertCommand pointe vers le bon répertoire de la commande convert de l'installation, que la commande est exécutable par le processus du serveur web, et que $wgMaxShellMemory est assez grand. Pour plus d'informations, reportez-vous à la section Manuel:Gestion des images pour des informations détaillées et les diagnostics de dépannage.

En outre, vous pouvez modifier la liste des extensions acceptées, stockées dans $wgFileExtensions  :

$wgFileExtensions = array('png','jpg','jpeg','ogg','doc','xls','ppt','mp3','sxc','pdf');

Dans le cas où ImageMagick génère un message d'erreur semblable à :

Fatal error: mime_magic could not be initialized, magic file is not available in includes/MimeMagic.php on line 506

essayez d'ajouter la ligne suivante à LocalSettings.php :

$wgMimeDetectorCommand = "file -bi";
Lire la section consacrée à la sécurité des téléversements dans le Manuel:Sécurité.
Davantage d'informations sur Manuel:Configuration des téléversements, Manuel:Détection des types Mime, et Manuel:Gestion des images .

Support interwiki

Le support d'InterWiki est intégré à MediaWiki mais vous devez configurer le préfixe à utiliser pour vos liens internes. Ce préfixe est généralement le même que $wgSitename, mais au cas où vous devez le changer, initialisez la variable $wgLocalInterwiki avec le nom préféré.

Langue de l'interface utilisateur

MediaWiki permet une variété de langues d'interface utilisateur locales au lieu de la langue anglaise par défaut. Si vous souhaitez exécuter votre wiki dans une autre langue que l'anglais, configurez la variable $wgLanguageCode avec le bon code de langue (par exemple, « de » pour l'allemand, « es » pour l'espagnol, « fr » pour le français, etc.).

Vous pouvez utiliser l'une quelconque des langues avec un fichier dans le répertoire languages/i18n. Par exemple, si vous trouvez fr.json, vous pouvez utiliser "fr" pour le français. N'utilisez pas "Fr" avec une majuscule. Bien que cela semble fonctionner, tous les textes ne sont pas traduits.

Remarque : Après avoir modifié le code de langue, vous devrez exécuter un script PHP pour le faire fonctionner. Dans une fenêtre de terminal, allez dans votre répertoire wiki, puis passez au dossier maintenance et entrez php rebuildMessages.php --rebuild. Sous Windows, le dossier PHP n'est peut-être pas dans votre variable d'environnement PATH et vous devrez préfixer php avec le chemin du programme.

Toutes les langues ne sont pas prises en charge. Voir ici pour les statistiques de localisation de 1.34.0-wmf.17 (6566628). Voir translatewiki.net pour les statistiques des versions précédentes.

Définir les droits d'auteur du site

  • $wgRightsPage est la page du wiki qui traite du copyright en vigueur. Habituellement, elle correspond à Project:Copyrights.
  • $wgRightsUrl est la page de description détaillée de votre licence (pour GNU FDL par exemple, cela sera http://www.gnu.org/licenses/fdl.html.)
  • $wgRightsText correspond au texte du pied de page qui suit la phrase Contenu disponible sous. Il est lié à la page indiquée dans $wgRightsPage.
  • $wgRightsIcon est l'URL de l'image placée à gauche de pied de page.
    Note: si $wgRightsPage n'est pas vide, le lien vers le texte du copyright ou de la licence sera vers cette page de votre site. Si $wgRightsPage est vide, le lien vers le texte du copyright ou de la licence sera alors vers $wgRightsUrl.

Pour modifier la mention sur le copyright du site, il suffit d'ajouter quelque chose comme ceci dans LocalSettings.php :

$wgRightsPage = "YourWiki:Copyright"; 
$wgRightsText = "copyright YourWiki";

Ensuite modifiez la page MediaWiki:Copyright pour y mettre un message approprié, en utilisant "$1" pour indiquer la cible du lien où se trouvera la page du copyright.

Exemple : définir une licence Creative Commons

Pour définir une licence Creative Commons vous devez :

 <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/3.0/">
 <img alt="Creative Commons License" border="0" src="http://creativecommons.org/images/public/somerights30.png" />
 </a>
 This work is licensed under a
 <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/3.0/">
 Creative Commons Attribution-NonCommercial-ShareAlike 3.0 License</a>.
  • Pour $wgRightsURL entrer l'info href de la première ancre :
$wgRightsUrl = "http://creativecommons.org/licenses/by-nc-sa/3.0/";
  • Pour $wgRightsText entrer le texte des liens de la seconde ancre de (ajouter le a à la variable Wiki pour une version grammaticalement correcte)
$wgRightsText = "a Creative Commons Attribution-NonCommercial-ShareAlike 3.0 License";
  • Pour $wgRightsIcon entrer l'info src du lien img dans la première ancre. Pour copier le badge de son propre site au lieu de celui de Creative Commons :
$wgRightsIcon = "http://creativecommons.org/images/public/somerights30.png";
  • Pour utiliser les métadonnées RDF concernant le copyright ajouter au moins l'une des deux lignes suivante dans votre LocalSettings.php :
$wgEnableCreativeCommonsRdf = true;
$wgEnableDublinCoreRdf = true;

Espaces de noms personnalisés

En déclarant $wgExtraNamespaces et en modifiant $wgNamespacesWithSubpages et $wgNamespacesToBeSearchedDefault , des espaces de noms supplémentaires peuvent être ajoutés à une installation de MediaWiki ; Et en déclarant le tableau des alias d'espaces de noms $wgNamespaceAliases , les alias peuvent être ajoutés. Prenez garde de ne pas avoir de pages déjà nommée dans cet espace de noms, par exemple dans la page intitulée « Technical:Support » et que vous avez créé l'espace de noms « Technical: » cette page serait non seulement perdue, mais vous ne pouvez pas la supprimer de Special:Allpages. Pour corriger cela, supprimez l'espace de noms, déplacez « Technical:Support » vers « Support » dans l'espace de noms principal, supprimez la redirection, réinsérez l'espace de noms et remettez-le dans « Technical:Support ». Voir Espaces de noms personnalisés pour plus d'informations sur la procédure à suivre.

Habillages

L'habillage (skin) par défaut du site est modifiable avec $wgDefaultSkin .

Voir aussi