Manual:AdminSettings.php

From MediaWiki.org
Jump to: navigation, search

Other languages:
Deutsch • ‎English • ‎日本語 • ‎polski • ‎português do Brasil • ‎русский

Details[edit]

The requirement for AdminSettings.php (along with supporting file AdminSettings.sample) was rudimentarily removed in MediaWiki 1.16. Prior to MediaWiki 1.16, AdminSettings.php was used to store database authentication credentials for maintenance scripts and to control the availability of profileinfo.phpManual:profileinfo.php. It has finally been removed completely in MediaWiki 1.23.

Upgrading[edit]

If upgrading from a pre-1.16 version of MediaWiki to version 1.16 or later, the variables set in AdminSettings.php file can be safely removed. AdminSettings.php is no longer needed. If it still exists, it will be loaded by maintenance scripts to retain backward compatibility.

Prior to 1.16[edit]

Manually create AdminSettings.php in the root directory of the MediaWiki installation. Typically, this is done by renaming AdminSettings.sample to AdminSettings.php and then editing AdminSettings.php appropriately.

AdminSettings.php should set three variables:

Example[edit]

<?php
/* Database authentication credentials */
$wgDBadminuser      = 'wikiadmin';
$wgDBadminpassword  = 'adminpass';

/* Whether to enable the profileinfo.php script. */
$wgEnableProfileInfo = false;
?>

Security[edit]

AdminSettings.phpManual:AdminSettings.php contains sensitive information (account names and passwords) that can help an attacker compromise your database management system. Ensure that you've taken the relevant preventative measures listed in Manual:SecurityManual:Security and Manual:Securing database passwordsManual:Securing database passwords.

PostgreSQL-specific issues[edit]

If using PostgreSQL with your MediaWiki installation, the authentication credentials used for $wgDBadminuserManual:$wgDBadminuser and $wgDBadminpasswordManual:$wgDBadminpassword should be the same as the credentials used for $wgDBuserManual:$wgDBuser and $wgDBpasswordManual:$wgDBpassword. This is necessary to ensure that the owner for new tables is set correctly.