Manual:LocalSettings.php/fr

Le fichier permet la configuration des variables locales cf: configuration settings (basé sur le fichier " ") de l'installation du MediaWiki. Vous devriez prendre votre temps pour examiner les paramètres dans ce fichier. Le fichier est habituellement généré par le programme d'installation accessible via une page Web MediaWiki, mais vous pouvez modifier certains des paramètres, éventuellement de concert avec les paramètres d'Apache. Modifier un paramètre consiste généralement à modifier la valeur d'une variable PHP. Vous pouvez d'abord vous familiariser avec la syntaxe PHP avant d'aller de l'avant. En règle générale, gardez à l'esprit que les variables PHP sont accessibles en préfixant de caractère "$" devant le nom de la variable ; de nombreuses variables ont simplement pour valeur  ou. Vos modifications prendront effet immédiatement après l'enregistrement du fichier : il n'est pas nécessaire de faire manuellement un "restart" pour quoi que ce soit (apache ou autre). Dans certains cas, vous pourriez avoir besoin de vider le cache de votre navigateur pour voir des changements. Les valeurs "par défaut" de nombreux autres paramètres sont placées dans includes/DefaultSettings.php, et n'ont pas besoin d'être modifiées. Si la variable que vous souhaitez modifier n'est pas déjà mentionnée dans votre LocalSettings.php, copiez la ligne concernée de DefaultSettings.php et modifiez la de manière appropriée. DansLocalSettings.php vous pouvez ajouter de nouvelles lignes à la fin. Toutes ces lignes devraient certainement apparaître en dessous de la ligne : 'require_once("includes/DefaultSettings.php"); ' Dans le fichier, il peut également avoir plusieurs lignes telles que 'require_once("extensions/extension. Php ");, qui font le lien vers d'autres extensions activées sur le wiki. Ces extensions peuvent exiger la définition des valeurs de plusieurs variables dans LocalSettings.php, consultez la documentation de l'extension pour des instructions complémentaires. Une liste des extensions est disponible sur Extension Matrix.
 * Ne placez pas les extensions avant la ligne : require_once( "includes/DefaultSettings.php" );, qui comporte une fonction de configuration qui vide les tableaux des extensions, ce qui aurait pour conséquence de ne pas pouvoir installer d'extensions, et probablement de rendre votre wiki inaccessible.
 * Ne placez pas les extensions avant la ligne : require_once( "includes/DefaultSettings.php" );</tt>, qui comporte une fonction de configuration qui vide les tableaux des extensions, ce qui aurait pour conséquence de ne pas pouvoir installer d'extensions, et probablement de rendre votre wiki inaccessible.

Votre version de LocalSettings.php</tt> ne peut pas se terminer par une balise PHP de fermeture : ?&gt;</tt>. Ceci est fait volontairement, car cela empêche les utilisateurs d'ajouter de nouvelles informations après cette balise. PHP fonctionne très bien sans balise de fermeture. Voir l'index des paramètres de configuration et les commentaires inclus dans les fichiers de paramétrage ainsi que l'aide pour connaître ce que peut faire chacune des variables. Une courte liste des variables les plus importantes, ainsi que la plupart des fonctionnalités les plus courantes, est présentée ci-dessous. Si vous avez un wiki sur MediaWiki wiki farm que vous n'avez pas accès en écriture (peut-être même pas accès en lecture) sur la fichier LocalSettings.php (voir par exemple ). Wiki farm company n'est peut être pas disposés à faire les changements que vous désirez. Il veut peut-être garder la plupart des réglages identiques sur tous les wikis de Wiki farm.

Location on the server
The LocalSettings.php file is not a wiki page and you cannot access it with your web browser. Instead, it is a file in the file system of the server. Its contents are generated during the initial setup of the wiki and the resulting file must be copied on the server manually. The file must be located in the folder you installed MediaWiki into, on the same level with folders like "includes/" or "skins/" and files like "api.php". If this file is not there, the wiki will not work at all - if the wiki does work, the file is there. If you do not know, where it is, you can run this command  on the UNIX shell to make your server show you, where the file actually is.

Security
LocalSettings.php usually contains sensitive data such as database logins. This data should never be revealed to the public! Due to a security breach somewhere on the server, it might happen that other users are able to view the contents of files. In order to improve security of your data, you should set UNIX permissions for this file accordingly: The webserver user must have access to this file. If this is the same account, who is the owner of the file, then you can set permissions to 600. Sometimes, the webserver user is not the file owner, but he is in the owner's UNIX user group. In this case, permissions of 640 should be fine. For improved security you should narrow permissions down as far as possible.

Additionally, you can create a MySQL user, who is restricted to only the database used by the wiki and provide this user's credentials in LocalSettings.php. Also can you configure your database server to only accept connections from localhost - this should prevent access from outside in case of leaked credentials.

File contents
When you edit LocalSettings.php, make sure to save it in the right encoding again. You should use "ANSI as UTF-8" encoding - that is UTF-8 encoding without byte order mark (BOM).

LocalSettings.php contains PHP code; mainly the definition of variables and their values. Changing a setting usually means changing the value of a PHP variable. Your changes will take effect immediately after saving the file again on the server: There is no need to manually "restart" anything. Anyway, in some cases you may need to clear your browser's cache to actually see the changes you made.

The default values of many more settings are set in, which should not be edited; if the variable you want to change is not already mentioned in your  , copy the appropriate line from   and modify it appropriately in LocalSettings.php. Within  you can add new lines at the end.

Within the file, there can also be several lines such as ' ', which point to extensions. These lines enable the according extension in the wiki. Those extensions may require setting the values of more variables in ; check the documentation of the according extension for further instructions.

Your version of  may not end with a closing PHP tag of  . This is done on purpose, as it prevents people from accidentally adding new information after this tag. PHP will function just fine without a closing tag.

If you have a wiki on a MediaWiki wiki farm you may not have write-access (perhaps not even read-access) to the file LocalSettings.php (see e.g.). The wiki farm company may or may not be willing to make changes you desire. Perhaps it wants to keep most settings the same on all wikis of the wiki farm.

Overview of available settings
See the configuration settings index and the comments included in the settings files for help on what all the variables do. A short listing of the most important variables, as well as the most requested features, is listed below.

Include path
La variable $IP (include_path) contient le chemin du fichier local pour l'installation de base de votre wiki. Assurez-vous d'indiquer le chemin complet qualifié du fichier. Ne pas inclure une barre oblique à la fin du chemin. Le fichier DefaultSettings.php est chargé à partir du répertoire désigné par la variable IP.

The DefaultSettings.php file gets loaded from the directory designated by the IP variable.

Nom du site
La variable $wgSitename contient le nom de votre wiki. Ce nom sera inclus plusieurs fois dans tout le système. Par exemple, le Wikipedia slogan «Un article 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 sensible au changement du nom du site. Vous pouvez définir les formes appropriées du mot dans les variables $wgGrammarForms.

Langage du site
La variable $wgLanguageCode contrôle la langue de l'interface de votre wiki. Alors que les utilisateurs peuvent changer la langue qu'ils voient dans leur preferences, cette variable définit la langue par défaut que tous les utilisateurs anonymes, voir la plupart des utilisateurs enregistrés.

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

Nom du serveur
$wgServer peut être utilisé pour remplacer éventuellement la détection automatique. Lorsque le wiki est accessible à partir de différent moyens : soit en local (via  ou  ) soit à partir d'un réseau local (via par exemple  ) soit d'Internet (via URL), les notifications par e-mail et quelques autres messages calculé serait normalement transmis avec les différentes URL. L'utilisation de  remplace la détection et le nom du serveur.

Si www.example.com est l'adresse du serveur de votre wiki visible depuis internet, ajoutez cette ligne tel que

La variable magic word  peut être utilisé dans les pages du wiki; c'est de la même valeur que.

Nom du script
$wgScript est le nom du principal (index) script PHP MediaWiki, nommé index.php</tt> 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à que s'effectue vos modifications. Assurez-vous de bien savoir ce que vous faites.

Redirection du nom du script
La variable $wgRedirectScript spécifie le chemin de l'URL vers le redirect script qui gère les redirections vers 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 au MediaWiki.Le chemin doit contenir le chemin du script principal (habituellement en utilisant ) et utiliser la marque substitutive $1</tt> pour désigner le nom de l'article.

Si vous utilisez Apache, pour réécrire les règles pour créer des URL courtes et simple, vous aurez probablement besoin de modifier  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 incorrectes alors qu'il sera toujours possible d'accéder à la page principale en entrant l'URL correcte manuellement. Se reporter ici Manual:Short URL pour plus d'informations sur la configuration d'URL.

La valeurs usuelles sont :

Emplacement des feuilles de style
Utilise la variable $wgStylePath pour définir le chemin URL vers les feuilles de style (CSS) de l'installation MediaWiki. La variable $wgStyleDirectory doit pointer au même endroit, mais il s'agit du chemin du système de fichier local pour des utilisations dans des scripts internes accédant au système de fichier.

Emplacement des uploads
Le répertoire des uploads stocke les fichiers envoyés par les utilisateurs. La variable wgUploadPath spécifie le chemin URL, et $wgUploadDirectory le chemin du système de fichier local.

Logo
La variable $wgLogo variable définit l'image qui s'affiche en haut à gauche de toutes les pages du wiki. Elle se situe dans, sous le paragraphe "require" :

Elle remplace le logo par défaut de.

Next, try to find the line that looks like this in :

If there's no such line, you can copy and paste the line above at the end of the file.

Then, modify that line to point to your logo. The logo must be web accessible. The value of this variable is passed to the web browser, which uses it to fetch the logo. If in doubt, a good way to pick what to put here is navigate to the logo in your web browser (for example, this wiki the url of the logo is http://upload.wikimedia.org/wikipedia/mediawiki/b/bc/Wiki.png ), and put the full url as the value of this variable.

Some people just replace the skins/common/images/wiki.png file with their logo. This is not recommended, as the customized logo would be overwritten on upgrade.

Adresses de contacts
La variable $wgEmergencyContact correspond à l'adresse e-mail du contact pour les rapports de bugs internes. Il est recommandé d'y ajouter celle de l'administrateur système.

La variable $wgPasswordSender est l'adresse e-mail de l'expéditeur des courriels de recouvrement de mot de passe. Il convient donc que l'on puisse lui écrire en cas de confusion.

Paramètres de la base de données
MediaWiki a besoin d'une base de données (actuellement soit MySQL soit PostgreSQL) pour stocker ses pages, leurs modifications, les information utilisateur, et autres.

$wgDBserver représente le nom de l'ordinateur où se trouve la base. Habituellement localhost, mais pour les installations distributées, il faut renseigner le FQDN.

$wgDBname is the database name of the database to be used by MediaWiki. A single MySQL or PostgreSQL installation can store more than one database and you can even run many MediaWiki installations on a single server. Make sure you have stated the correct database name here and use different database names for different wiki installations on the same database server.

The $wgDBuser and $wgDBpassword variables contain the login name and password to be used by MediaWiki to access the database. Make sure the specified user has the proper access rights to be able to manipulate the wiki's table on the database server.

User rights
The $wgGroupPermissions is an associative array, controlling permissions for creating and editing pages for your different user groups. In this array, custom permission levels can be created, and permission levels for the different user groups can be set. See Help:User rights for more information about the different permissions and user groups available.

Force capital links
By default, no page name can start with a lowercase Roman letter: in an attempt to do so the first letter is converted to uppercase; if a link target, included page, image or category is specified with a name starting with a lowercase letter, the actual target etc. is the page starting with the corresponding capital.

Alternatively page names can start with a lowercase letter, in addition to the possibilities of starting with a capital, a digit, etc. For that you must adjust the $wgCapitalLinks variable. Setting it to false allows lowercase characters, true chooses the default behaviour.

Enabling subpages
On localsettings.php, subpages are enabled on a per-namespace basis using the $wgNamespacesWithSubpages variable. For example, to enable subpages in the main namespace:

Image uploads
Before users are allowed to upload files to the MediaWiki system, you have to enable that feature. Make sure the Upload Directory is properly configured and writeable by the Apache web server process. Then set the $wgEnableUploads variable to true to allow uploading in the web user interface.

i.e. Here's some example code from includes/DefaultSettings.php to put in LocalSettings.php. If you want to be able to resize images on the fly to support thumbnails, MediaWiki needs a working ImageMagick installation. Set the $wgUseImageResize and $wgUseImageMagick variables to true once you have installed and tested ImageMagick on your system. Make sure the $wgImageMagickConvertCommand variable points to the proper location of the  command of your installation, that the command is executable by the web server process, and $wgMaxShellMemory is large enough. See Manual:Image Administration for detailed information and trouble-shooting.

Also, you may want to modify the list of accepted extensions, which is stored within the $wgFileExtensions array:

In case you run into trouble with ImageMagick, and obtain the following error message:

Try adding the following line to LocalSettings.php: $wgMimeDetectorCommand = "file -bi";

LaTeX inline equations
In order to render mathematical formulae in LaTeX, you need a working LaTeX installation on your system. Set the $wgUseTeX variable to true to enable that feature. Also make sure the $wgMathPath, $wgMathDirectory and $wgTmpDirectory are set properly, but you might want to go with the default values unless you have a very good reason to change it.

Interwiki support
InterWiki support is built into MediaWiki but you need to configure the prefix to be used for your internal links. This prefix is usually the same as $wgSitename, but in case you need to change that, you set the $wgLocalInterwiki variable to the preferred name.

Language of user interface
MediaWiki allows for a variety of localized user interfaces languages instead of the english default. If you want to run your wiki in a non-English language, set the $wgLanguageCode variable to the proper language code (e.g. "de" for German, "es" for Spanish, etc.)

You may use any of the languages found in the directory language. E.g., if you find MessagesEs.php, you can use " " for Spanish. Do not use " " with a capital letter. Although it seems to work, not all texts are translated.

Note: After changing the language code, you will need to run a php script to make it work. With your command line tool, go to your wiki directory, open the "maintenance" folder, and type " ". Please note that on Windows, the PHP folder might not be included in the PATH environment variable.

Not all languages are supported. See here for a list of the localisation statistics of. See translatewiki.net for the statistics per released version.

Setting copyright for the site

 * $wgRightsPage is the page on the wiki that covers the copyrights that it falls under. Usually, this will be Project:Copyrights.
 * $wgRightsUrl is the page describing full details of your license. (For the GNU FDL, for example, this would be .)
 * $wgRightsText is the text in the footer that follows "Content is available under". It will be linked to the page specified in.
 * $wgRightsIcon is the URL of the image placed at the left of the footer.
 * Note: If  is non-empty, the link in the copyright/license notice will link to that page on your site. If   is empty then the copyright/license notice will link to   instead.

To modify the copyright statements of the site, add something like this to LocalSettings.php: Afterwards, edit MediaWiki:Copyright to provide an appropriate message, using  to indicate the position where the link to your copyright page will be.

Example: setting a Creative Commons license

To set a Creative Commons license do the following:


 * Choose your license: http://creativecommons.org/text/publish-website
 * Examine the returned HTML code, e.g.:
 * For  enter the href info from the first anchor:
 * For  enter the text the second anchor links from (add the "a" to the Wiki variable for a more grammatically correct version)
 * For  enter the src info from the img link in the first anchor. You want to copy the badge to your own site instead of using the one from the Creative Commons site.


 * For using RDF metadata about copyright add one or both of the following lines to your LocalSettings.php

Custom namespaces
By declaring the $wgExtraNamespaces array, and modifying the $wgNamespacesWithSubpages, and $wgNamespacesToBeSearchedDefault arrays, extra namespaces can be added to a MediaWiki installation; and by declaring the $wgNamespaceAliases array namespace aliases can be added. Take heed not to have any pages already titled in that namespace, for instance in you had a page called "Technical:Support" and you created the Technical: namespace, then that page would not only be lost, but you cannot remove it from Special:Allpages. To fix this delete the namespace, move "Technical:Support" to "Support" in mainspace, delete the redirect, reinsert the namespace, and move it back to "Technical:Support". See Custom namespaces for more information as to how to do so.

Skins
The default skin of the site can be modified via the $wgDefaultSkin variable.