2 # MediaWiki web-based config/installation
3 # Copyright (C) 2004 Brion Vibber <brion@pobox.com>
4 # http://www.mediawiki.org/
6 # This program is free software; you can redistribute it and/or modify
7 # it under the terms of the GNU General Public License as published by
8 # the Free Software Foundation; either version 2 of the License, or
9 # (at your option) any later version.
11 # This program is distributed in the hope that it will be useful,
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 # GNU General Public License for more details.
16 # You should have received a copy of the GNU General Public License along
17 # with this program; if not, write to the Free Software Foundation, Inc.,
18 # 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
19 # http://www.gnu.org/copyleft/gpl.html
21 error_reporting( E_ALL
);
22 header( "Content-type: text/html; charset=utf-8" );
23 @ini_set
( "display_errors", true );
25 ?
><!DOCTYPE HTML
PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
26 "http://www.w3.org/TR/html4/loose.dtd">
29 <meta http
-equiv
="Content-type" content
="text/html; charset=utf-8">
30 <meta name
="robots" content
="noindex,nofollow">
31 <title
>MediaWiki installation
</title
>
32 <style type
="text/css">
37 background
-color
: #eee;
39 border
: solid
1px
#444;
47 dl
.setup dd label
.column
{
59 /* margin-right: 200px; */
77 <a href
="http://www.mediawiki.org/">
78 <img src
="../skins/common/images/mediawiki.png" width
="135" height
="135" alt
="" border
="0" />
82 <p
><strong
><a href
="http://www.mediawiki.org/">MediaWiki
</a
></strong
> is
83 Copyright (C
) 2001-2005 by Magnus Manske
, Brion Vibber
, Lee Daniel Crocker
,
84 Tim Starling
, Erik M
ö
;ller
, Gabriel Wicke
and others
.</p
>
87 <li
><a href
="../README">Readme
</a
></li
>
88 <li
><a href
="../RELEASE-NOTES">Release notes
</a
></li
>
89 <li
><a href
="../docs/">doc
/</a
></li
>
90 <li
><a href
="http://meta.wikipedia.org/wiki/MediaWiki_User's_Guide">User
's Guide</a></li>
93 <p>This program is free software; you can redistribute it and/or modify
94 it under the terms of the GNU General Public License as published by
95 the Free Software Foundation; either version 2 of the License, or
96 (at your option) any later version.</p>
98 <p>This program is distributed in the hope that it will be useful,
99 but WITHOUT ANY WARRANTY; without even the implied warranty of
100 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
101 GNU General Public License for more details.</p>
103 <p>You should have received <a href="../COPYING">a copy of the GNU General Public License</a>
104 along with this program; if not, write to the Free Software
105 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
106 or <a href="http://www.gnu.org/copyleft/gpl.html">read it online</a></p>
111 # Relative includes seem to break if a parent directory is not readable;
112 # this is common for public_html subdirs under user home directories.
114 # As a dirty hack, we'll
try to set up the
include path first
.
116 $IP = dirname( dirname( __FILE__
) );
117 $sep = (DIRECTORY_SEPARATOR
== "\\") ?
";" : ":";
118 ini_set( "include_path", ".$sep$IP$sep$IP/includes$sep$IP/languages" );
120 define( "MEDIAWIKI", true );
121 define( "MEDIAWIKI_INSTALL", true );
122 require_once( "includes/Defines.php" );
123 require_once( "includes/DefaultSettings.php" );
124 require_once( "includes/MagicWord.php" );
125 require_once( "includes/Namespace.php" );
128 <h1
>MediaWiki
<?php
print $wgVersion ?
> installation
</h1
>
133 /* Check for existing configurations and bug out! */
135 if( file_exists( "../LocalSettings.php" ) ) {
136 dieout( "<h2>Wiki is configured.</h2>
138 <p>Already configured... <a href='../index.php'>return to the wiki</a>.</p>
140 <p>(You should probably remove this directory for added security.)</p>" );
143 if( file_exists( "./LocalSettings.php" ) ) {
144 writeSuccessMessage();
149 if( !is_writable( "." ) ) {
150 dieout( "<h2>Can't write config file, aborting</h2>
152 <p>In order to configure the wiki you have to make the <tt>config</tt> subdirectory
153 writable by the web server. Once configuration is done you'll move the created
154 <tt>LocalSettings.php</tt> to the parent directory, and for added safety you can
155 then remove the <tt>config</tt> subdirectory entirely.</p>
157 <p>To make the directory writable on a Unix/Linux system:</p>
160 cd <i>/path/to/wiki</i>
166 require_once( "install-utils.inc" );
167 require_once( "maintenance/updaters.inc" );
170 function getEncoded( $data ) {
171 # removing latin1 support, no need...
174 function getSitename() { return $this->getEncoded( $this->Sitename
); }
175 function getSysopName() { return $this->getEncoded( $this->SysopName
); }
176 function getSysopPass() { return $this->getEncoded( $this->SysopPass
); }
181 <p
><em
>Please
include all of the lines below when reporting installation problems
.</em
></p
>
183 <h2
>Checking environment
...</h2
>
188 $wgNoOutputBuffer = true;
189 $conf = new ConfigData
;
191 install_version_checks();
193 print "<li>PHP " . phpversion() . ": ok</li>\n";
195 if( ini_get( "register_globals" ) ) {
197 <li
><b
class='error'>Warning
:</b
> <strong
>PHP
's
198 <tt><a href="http://php.net/register_globals">register_globals</a></tt>
199 option is enabled.</strong> MediaWiki will work correctly, but this setting
200 increases your exposure to potential security vulnerabilities in PHP-based
201 software running on your server. <strong>You should disable it if you are able.</strong></li>
207 if( ini_get( "magic_quotes_runtime" ) ) {
209 ?><li class='error
'><strong>Fatal: <a href='http
://www.php.net/manual/en/ref.info.php#ini.magic-quotes-runtime'>magic_quotes_runtime</a> is active!</strong>
210 This option corrupts data input unpredictably
; you cannot install
or use
211 MediaWiki unless this option is disabled
.
215 if( ini_get( "magic_quotes_sybase" ) ) {
217 ?
><li
class='error'><strong
>Fatal
: <a href
='http://www.php.net/manual/en/ref.sybase.php#ini.magic-quotes-sybase'>magic_quotes_sybase
</a
> is active
!</strong
>
218 This option corrupts data input unpredictably
; you cannot install
or use
219 MediaWiki unless this option is disabled
.
224 dieout( "</ul><p>Cannot install wiki.</p>" );
227 if( ini_get( "safe_mode" ) ) {
228 $conf->safeMode
= true;
230 <li
><b
class='error'>Warning
:</b
> <strong
>PHP
's
231 <a href='http
://www.php.net/features.safe-mode'>safe mode</a> is active.</strong>
232 You may have problems caused by this
, particularly
if using image uploads
.
236 $conf->safeMode
= false;
240 $sapi = php_sapi_name();
241 $conf->prettyURLs
= true;
242 print "<li>PHP server API is $sapi; ";
245 case "apache2handler":
246 print "ok, using pretty URLs (<tt>index.php/Page_Title</tt>)";
250 case "apache2filter":
251 print "using ugly URLs (<tt>index.php?title=Page_Title</tt>)";
252 $conf->prettyURLs
= false;
255 print "unknown; using pretty URLs (<tt>index.php/Page_Title</tt>), if you have trouble change this in <tt>LocalSettings.php</tt>";
259 $conf->xml
= function_exists( "utf8_encode" );
261 print "<li>Have XML / Latin1-UTF-8 conversion support.</li>\n";
263 dieout( "PHP's XML module is missing; the wiki requires functions in
264 this module and won't work in this configuration.
265 If you're running Mandrake, install the php-xml package." );
268 $memlimit = ini_get( "memory_limit" );
269 $conf->raiseMemory
= false;
270 if( empty( $memlimit ) ||
$memlimit == -1 ) {
271 print "<li>PHP is configured with no <tt>memory_limit</tt>.</li>\n";
273 print "<li>PHP's <tt>memory_limit</tt> is " . htmlspecialchars( $memlimit ) . ". <strong>If this is too low, installation may fail!</strong> ";
274 $n = IntVal( $memlimit );
275 if( preg_match( '/^([0-9]+)[Mm]$/', trim( $memlimit ), $m ) ) {
276 $n = IntVal( $m[1] * (1024*1024) );
278 if( $n < 20*1024*1024 ) {
279 print "Attempting to raise limit to 20M... ";
280 if( false === ini_set( "memory_limit", "20M" ) ) {
283 $conf->raiseMemory
= true;
290 $conf->zlib
= function_exists( "gzencode" );
292 print "<li>Have zlib support; enabling output compression.</li>\n";
294 print "<li>No zlib support.</li>\n";
297 $conf->turck
= function_exists( 'mmcache_get' );
298 if ( $conf->turck
) {
299 print "<li><a href=\"http://turck-mmcache.sourceforge.net/\">Turck MMCache</a> installed</li>\n";
301 $conf->eaccel
= function_exists( 'eaccelerator_get' );
302 if ( $conf->eaccel
) {
303 $conf->turck
= 'eaccelerator';
304 print "<li><a href=\"http://eaccelerator.sourceforge.net/\">eAccelerator</a> installed</li>\n";
306 if (!$conf->turck
&& !$conf->eaccel
) {
307 print "<li>Neither <a href=\"http://turck-mmcache.sourceforge.net/\">Turck MMCache</a> nor <a href=\"http://eaccelerator.sourceforge.net/\">eAccelerator</a> are installed, " .
308 "can't use object caching functions</li>\n";
311 $conf->diff3
= false;
312 $diff3locations = array("/usr/bin", "/opt/csw/bin", "/usr/gnu/bin", "/usr/sfw/bin") +
explode(":", getenv("PATH"));
313 $diff3names = array("gdiff3", "diff3");
315 $diff3versioninfo = array('$1 --version 2>&1', 'diff3 (GNU diffutils)');
316 foreach ($diff3locations as $loc) {
317 $exe = locate_executable($loc, $diff3names, $diff3versioninfo);
318 if ($exe !== false) {
325 print "<li>Found GNU diff3: <tt>$conf->diff3</tt>.</li>";
327 print "<li>GNU diff3 not found.</li>";
329 $conf->ImageMagick
= false;
330 $imcheck = array( "/usr/bin", "/usr/local/bin", "/sw/bin", "/opt/local/bin" );
331 foreach( $imcheck as $dir ) {
332 $im = "$dir/convert";
333 if( file_exists( $im ) ) {
334 print "<li>Found ImageMagick: <tt>$im</tt>; image thumbnailing will be enabled if you enable uploads.</li>\n";
335 $conf->ImageMagick
= $im;
340 $conf->HaveGD
= function_exists( "imagejpeg" );
341 if( $conf->HaveGD
) {
342 print "<li>Found GD graphics library built-in";
343 if( !$conf->ImageMagick
) {
344 print ", image thumbnailing will be enabled if you enable uploads";
348 if( !$conf->ImageMagick
) {
349 print "<li>Couldn't find GD library or ImageMagick; image thumbnailing disabled.</li>\n";
353 $conf->UseImageResize
= $conf->HaveGD ||
$conf->ImageMagick
;
355 # $conf->IP = "/Users/brion/Sites/inplace";
356 $conf->IP
= dirname( dirname( __FILE__
) );
357 print "<li>Installation directory: <tt>" . htmlspecialchars( $conf->IP
) . "</tt></li>\n";
359 # $conf->ScriptPath = "/~brion/inplace";
360 $conf->ScriptPath
= preg_replace( '{^(.*)/config.*$}', '$1', $_SERVER["PHP_SELF"] ); # was SCRIPT_NAME
361 print "<li>Script URI path: <tt>" . htmlspecialchars( $conf->ScriptPath
) . "</tt></li>\n";
363 $conf->posted
= ($_SERVER["REQUEST_METHOD"] == "POST");
365 $conf->Sitename
= ucfirst( importPost( "Sitename", "" ) );
366 $defaultEmail = empty( $_SERVER["SERVER_ADMIN"] )
368 : $_SERVER["SERVER_ADMIN"];
369 $conf->EmergencyContact
= importPost( "EmergencyContact", $defaultEmail );
370 $conf->DBserver
= importPost( "DBserver", "localhost" );
371 $conf->DBname
= importPost( "DBname", "wikidb" );
372 $conf->DBuser
= importPost( "DBuser", "wikiuser" );
373 $conf->DBpassword
= importPost( "DBpassword" );
374 $conf->DBpassword2
= importPost( "DBpassword2" );
375 $conf->DBprefix
= importPost( "DBprefix" );
376 $conf->RootPW
= importPost( "RootPW" );
377 $conf->LanguageCode
= importPost( "LanguageCode", "en" );
378 $conf->SysopName
= importPost( "SysopName", "WikiSysop" );
379 $conf->SysopPass
= importPost( "SysopPass" );
380 $conf->SysopPass2
= importPost( "SysopPass2" );
382 /* Check for validity */
385 if( $conf->Sitename
== "" ||
$conf->Sitename
== "MediaWiki" ||
$conf->Sitename
== "Mediawiki" ) {
386 $errs["Sitename"] = "Must not be blank or \"MediaWiki\".";
388 if( $conf->DBuser
== "" ) {
389 $errs["DBuser"] = "Must not be blank";
391 if( $conf->DBpassword
== "" ) {
392 $errs["DBpassword"] = "Must not be blank";
394 if( $conf->DBpassword
!= $conf->DBpassword2
) {
395 $errs["DBpassword2"] = "Passwords don't match!";
397 if( !preg_match( '/^[A-Za-z_0-9]*$/', $conf->DBprefix
) ) {
398 $errs["DBprefix"] = "Invalid table prefix";
401 if( $conf->SysopPass
== "" ) {
402 $errs["SysopPass"] = "Must not be blank";
404 if( $conf->SysopPass
!= $conf->SysopPass2
) {
405 $errs["SysopPass2"] = "Passwords don't match!";
408 $conf->License
= importRequest( "License", "none" );
409 if( $conf->License
== "gfdl" ) {
410 $conf->RightsUrl
= "http://www.gnu.org/copyleft/fdl.html";
411 $conf->RightsText
= "GNU Free Documentation License 1.2";
412 $conf->RightsCode
= "gfdl";
413 $conf->RightsIcon
= '${wgStylePath}/common/images/gnu-fdl.png';
414 } elseif( $conf->License
== "none" ) {
415 $conf->RightsUrl
= $conf->RightsText
= $conf->RightsCode
= $conf->RightsIcon
= "";
417 $conf->RightsUrl
= importRequest( "RightsUrl", "" );
418 $conf->RightsText
= importRequest( "RightsText", "" );
419 $conf->RightsCode
= importRequest( "RightsCode", "" );
420 $conf->RightsIcon
= importRequest( "RightsIcon", "" );
423 $conf->Shm
= importRequest( "Shm", "none" );
424 $conf->MCServers
= importRequest( "MCServers" );
426 /* Test memcached servers */
428 if ( $conf->Shm
== 'memcached' && $conf->MCServers
) {
429 $conf->MCServerArray
= array_map( 'trim', explode( ',', $conf->MCServers
) );
430 foreach ( $conf->MCServerArray
as $server ) {
431 $error = testMemcachedServer( $server );
433 $errs["MCServers"] = $error;
437 } else if ( $conf->Shm
== 'memcached' ) {
438 $errs["MCServers"] = "Please specify at least one server if you wish to use memcached";
441 /* default values for installation */
442 $conf->Email
=importRequest("Email", "email_enabled");
443 $conf->Emailuser
=importRequest("Emailuser", "emailuser_enabled");
444 $conf->Enotif
=importRequest("Enotif", "enotif_allpages");
445 $conf->Eauthent
=importRequest("Eauthent", "eauthent_enabled");
447 if( $conf->posted
&& ( 0 == count( $errs ) ) ) {
448 do { /* So we can 'continue' to end prematurely */
449 $conf->Root
= ($conf->RootPW
!= "");
451 /* Load up the settings and get installin' */
452 $local = writeLocalSettings( $conf );
453 $wgCommandLineMode = false;
456 $wgDBadminuser = "root";
457 $wgDBadminpassword = $conf->RootPW
;
458 $wgDBprefix = $conf->DBprefix
;
459 $wgCommandLineMode = true;
460 $wgUseDatabaseMessages = false; /* FIXME: For database failure */
461 require_once( "includes/Setup.php" );
464 require_once( "maintenance/InitialiseMessages.inc" );
466 $wgTitle = Title
::newFromText( "Installation script" );
467 $mysqlOldClient = version_compare( mysql_get_client_info(), "4.1.0", "lt" );
468 if( $mysqlOldClient ) {
469 print "<li><b>PHP is linked with old MySQL client libraries. If you are
470 using a MySQL 4.1 server and have problems connecting to the database,
471 see <a href='http://dev.mysql.com/doc/mysql/en/old-client.html'
472 >http://dev.mysql.com/doc/mysql/en/old-client.html</a> for help.</b></li>\n";
474 print "<li>Trying to connect to MySQL on $wgDBserver as root...\n";
475 $wgDatabase = Database
::newFromParams( $wgDBserver, "root", $conf->RootPW
, "", 1 );
477 if( $wgDatabase->isOpen() ) {
478 $myver = mysql_get_server_info( $wgDatabase->mConn
);
479 $wgDatabase->ignoreErrors(true);
481 print "<ul><li>Connected as root (automatic)</li></ul></li>\n";
483 print "<ul><li>MySQL error " . ($err = mysql_errno() ) .
484 ": " . htmlspecialchars( mysql_error() ) . "</li></ul></li>";
490 $errs["RootPW"] = "Check password";
492 print "<li>Trying regular user...\n";
493 /* Try the regular user... */
494 $wgDBadminuser = $wgDBuser;
495 $wgDBadminpassword = $wgDBpassword;
496 /* Wait one second for connection rate limiting, present on some systems */
498 $wgDatabase = Database
::newFromParams( $wgDBserver, $wgDBuser, $wgDBpassword, "", 1 );
499 if( !$wgDatabase->isOpen() ) {
500 print "<ul><li>MySQL error " . ($err = mysql_errno() ) .
501 ": " . htmlspecialchars( mysql_error() ) . "</li></ul></li>";
502 $errs["DBuser"] = "Check name/pass";
503 $errs["DBpassword"] = "or enter root";
504 $errs["DBpassword2"] = "password below";
505 $errs["RootPW"] = "Got root?";
507 $myver = mysql_get_server_info( $wgDatabase->mConn
);
508 $wgDatabase->ignoreErrors(true);
519 $errs["DBserver"] = "Connection failed";
522 $errs["DBserver"] = "Couldn't connect to database";
528 if ( !$wgDatabase->isOpen() ) {
529 $errs["DBserver"] = "Couldn't connect to database";
533 print "<li>Connected to $myver";
534 if( version_compare( $myver, "4.0.0" ) >= 0 ) {
535 print "; enabling MySQL 4 enhancements";
536 $conf->DBmysql4
= true;
537 $local = writeLocalSettings( $conf );
539 $mysqlNewAuth = version_compare( $myver, "4.1.0", "ge" );
540 if( $mysqlNewAuth && $mysqlOldClient ) {
541 print "; <b class='error'>You are using MySQL 4.1 server, but PHP is linked
542 to old client libraries; if you have trouble with authentication, see
543 <a href='http://dev.mysql.com/doc/mysql/en/old-client.html'
544 >http://dev.mysql.com/doc/mysql/en/old-client.html</a> for help.</b>";
548 @$sel = mysql_select_db( $wgDBname, $wgDatabase->mConn
);
550 print "<li>Database <tt>" . htmlspecialchars( $wgDBname ) . "</tt> exists</li>\n";
552 $err = mysql_errno();
553 if ( $err != 1049 ) {
554 print "<ul><li>Error selecting database $wgDBname: $err " . htmlspecialchars( mysql_error() ) .
558 $res = $wgDatabase->query( "CREATE DATABASE `$wgDBname`" );
560 print "<li>Couldn't create database <tt>" .
561 htmlspecialchars( $wgDBname ) .
562 "</tt>; try with root access or check your username/pass.</li>\n";
563 $errs["RootPW"] = "<- Enter";
566 print "<li>Created database <tt>" . htmlspecialchars( $wgDBname ) . "</tt></li>\n";
569 $wgDatabase->selectDB( $wgDBname );
571 if( $wgDatabase->tableExists( "cur" ) ||
$wgDatabase->tableExists( "revision" ) ) {
572 print "<li>There are already MediaWiki tables in this database. Checking if updates are needed...</li>\n";
574 # Create user if required
576 $conn = Database
::newFromParams( $wgDBserver, $wgDBuser, $wgDBpassword, $wgDBname, 1 );
577 if ( $conn->isOpen() ) {
578 print "<li>DB user account ok</li>\n";
581 print "<li>Granting user permissions...";
582 if( $mysqlOldClient && $mysqlNewAuth ) {
583 print " <b class='error'>If the next step fails, see <a href='http://dev.mysql.com/doc/mysql/en/old-client.html'>http://dev.mysql.com/doc/mysql/en/old-client.html</a> for help.</b>";
586 dbsource( "../maintenance/users.sql", $wgDatabase );
596 print "<li>Finished update checks.</li>\n";
598 # FIXME: Check for errors
599 print "<li>Creating tables...";
600 dbsource( "../maintenance/tables.sql", $wgDatabase );
601 dbsource( "../maintenance/interwiki.sql", $wgDatabase );
602 print " done.</li>\n";
604 print "<li>Initializing data...";
605 $wgDatabase->insert( 'site_stats',
606 array( 'ss_row_id' => 1,
607 'ss_total_views' => 0,
608 'ss_total_edits' => 0,
609 'ss_good_articles' => 0 ) );
610 # setting up the db user
612 print "<li>Granting user permissions...</li>\n";
613 dbsource( "../maintenance/users.sql", $wgDatabase );
616 if( $conf->SysopName
) {
617 $u = User
::newFromName( $conf->getSysopName() );
618 if ( 0 == $u->idForName() ) {
620 $u->setPassword( $conf->getSysopPass() );
623 $u->addGroup( "sysop" );
624 $u->addGroup( "bureaucrat" );
626 print "<li>Created sysop account <tt>" .
627 htmlspecialchars( $conf->SysopName
) . "</tt>.</li>\n";
629 print "<li>Could not create user - already exists!</li>\n";
632 print "<li>Skipped sysop account creation, no name given.</li>\n";
635 $titleobj = Title
::newFromText( wfMsgNoDB( "mainpage" ) );
636 $article = new Article( $titleobj );
637 $newid = $article->insertOn( $wgDatabase );
638 $revision = new Revision( array(
640 'text' => wfMsg( 'mainpagetext' ) . "\n\n" . wfMsg( 'mainpagedocfooter' ),
643 'user_text' => 'MediaWiki default',
645 $revid = $revision->insertOn( $wgDatabase );
646 $article->updateRevisionOn( $wgDatabase, $revision );
649 initialiseMessages();
650 print "</pre></li>\n";
653 /* Write out the config file now that all is well */
654 print "<p>Creating LocalSettings.php...</p>\n\n";
655 $localSettings = "<" . "?php$endl$local$endl?" . ">";
656 // Fix up a common line-ending problem (due to CVS on Windows)
657 $localSettings = str_replace( "\r\n", "\n", $localSettings );
659 if( version_compare( phpversion(), "4.3.2" ) >= 0 ) {
660 $xt = "xt"; # Refuse to overwrite an existing file
662 $xt = "wt"; # 'x' is not available prior to PHP 4.3.2. We did check above, but race conditions blah blah
664 $f = fopen( "LocalSettings.php", $xt );
667 dieout( "<p>Couldn't write out LocalSettings.php. Check that the directory permissions are correct and that there isn't already a file of that name here...</p>\n" .
668 "<p>Here's the file that would have been written, try to paste it into place manually:</p>\n" .
669 "<pre>\n" . htmlspecialchars( $localSettings ) . "</pre>\n" );
671 if(fwrite( $f, $localSettings ) ) {
673 writeSuccessMessage();
676 die("<p class='error'>An error occured while writing the config/LocalSettings.php file. Check user rights and disk space then try again.</p>\n");
688 if( count( $errs ) ) {
689 /* Display options form */
691 if( $conf->posted
) {
692 echo "<p class='error'>Something's not quite right yet; make sure everything below is filled out correctly.</p>\n";
696 <form action
="index.php" name
="config" method
="post">
704 aField( $conf, "Sitename", "Site name:" );
708 Your site name should be a relatively short word
. It
'll appear as the namespace
709 name for 'meta
' pages as well as throughout the user interface. Good site names
710 are things like "<a href="http://www.wikipedia.org/">Wikipedia</a>" and
711 "<a href="http://openfacts.berlios.de/">OpenFacts</a>"; avoid punctuation,
712 which may cause problems.
717 aField( $conf, "EmergencyContact", "Contact e-mail" );
721 This will be used as the return address for password reminders and
722 may be displayed in some error conditions so visitors can get in
723 touch with you. It is also be used as the default sender address of e-mail
724 notifications (enotifs).
728 <label class='column
' for="LanguageCode">Language</label>
729 <select id="LanguageCode" name="LanguageCode">
732 $list = getLanguageList();
733 foreach( $list as $code => $name ) {
734 $sel = ($code == $conf->LanguageCode) ? 'selected
="selected"' : '';
735 echo "\t\t<option value=\"$code\" $sel>$name</option>\n";
741 You may select the language for the user interface of the wiki...
742 Some localizations are less complete than others. Unicode (UTF-8 encoding)
743 is used for all localizations.
747 <label class='column
'>Copyright/license metadata</label>
748 <div>Select one:</div>
751 <li><?php aField( $conf, "License", "no license metadata", "radio", "none" ); ?></li>
752 <li><?php aField( $conf, "License", "GNU Free Documentation License 1.2 (Wikipedia-compatible)", "radio", "gfdl" ); ?></li>
754 aField( $conf, "License", "a Creative Commons license...", "radio", "cc" );
755 $partner = "MediaWiki";
756 $exit = urlencode( "$wgServer{$conf->ScriptPath}/config/index.php?License=cc&RightsUrl=[license_url]&RightsText=[license_name]&RightsCode=[license_code]&RightsIcon=[license_button]" );
757 $icon = urlencode( "$wgServer$wgUploadPath/wiki.png" );
758 $ccApp = htmlspecialchars( "http://creativecommons.org/license/?partner=$partner&exit_url=$exit&partner_icon_url=$icon" );
759 print "<a href=\"$ccApp\">choose</a>";
760 ?> (link will wipe out any other data in this form!)
761 <?php if( $conf->License == "cc" ) { ?>
763 <li><?php aField( $conf, "RightsIcon", "<img src=\"" . htmlspecialchars( $conf->RightsIcon ) . "\" alt='icon
' />", "hidden" ); ?></li>
764 <li><?php aField( $conf, "RightsText", htmlspecialchars( $conf->RightsText ), "hidden" ); ?></li>
765 <li><?php aField( $conf, "RightsCode", "code: " . htmlspecialchars( $conf->RightsCode ), "hidden" ); ?></li>
766 <li><?php aField( $conf, "RightsUrl", "<a href=\"" . htmlspecialchars( $conf->RightsUrl ) . "\">" . htmlspecialchars( $conf->RightsUrl ) . "</a>", "hidden" ); ?></li>
773 MediaWiki can include a basic license notice, icon, and machine-readable
774 copyright metadata if your wiki's content is to be licensed under
775 the GNU FDL
or a Creative Commons license
. If you
're not sure, leave
781 <?php aField( $conf, "SysopName", "Sysop account name:", "" ) ?>
784 <?php aField( $conf, "SysopPass", "password:", "password" ) ?>
787 <?php aField( $conf, "SysopPass2", "again:", "password" ) ?>
790 A sysop user account can lock or delete pages, block problematic IP
791 addresses from editing, and other maintenance tasks. If creating a new
792 wiki database, a sysop account will be created with the given name
797 <label class='column
'>Shared memory caching</label>
798 <div>Select one:</div>
801 <li><?php aField( $conf, "Shm", "no caching", "radio", "none" ); ?></li>
803 if ( $conf->turck ) {
805 aField( $conf, "Shm", "Turck MMCache", "radio", "turck" );
810 if ( $conf->eaccel ) {
812 aField( $conf, "Shm", "eAccelerator", "radio", "eaccel" );
816 <li><?php aField( $conf, "Shm", "Memcached", "radio", "memcached" ); ?></li>
817 <li><?php aField( $conf, "MCServers", "Memcached servers", "" ) ?></li>
821 Using a shared memory system such as Turck MMCache, eAccelerator, or Memcached will speed
822 up MediaWiki significantly. Memcached is the best solution but needs to be
823 installed. Specify the server addresses and ports in a comma-separted list. Only
824 use Turck shared memory if the wiki will be running on a single Apache server.
827 <h2>E-mail, e-mail notification and authentification setup</h2>
831 <label class='column
'>E-mail (general)</label>
832 <div>Select one:</div>
835 <li><?php aField( $conf, "Email", "enabled", "radio", "email_enabled" ); ?></li>
836 <li><?php aField( $conf, "Email", "disabled", "radio", "email_disabled" ); ?></li>
840 Use this to disable all e-mail functions (send a password reminder, user-to-user e-mail and e-mail notification),
841 if sending e-mails on your server doesn't work
.
844 <label
class='column'>User
-to
-user e
-mail
</label
>
845 <div
>Select one
:</div
>
848 <li
><?php
aField( $conf, "Emailuser", "enabled", "radio", "emailuser_enabled" ); ?
></li
>
849 <li
><?php
aField( $conf, "Emailuser", "disabled", "radio", "emailuser_disabled" ); ?
></li
>
853 Use this to disable only the user
-to
-user e
-mail
function (EmailUser
).
856 <label
class='column'>E
-mail notification
</label
>
857 <div
>Select one
:</div
>
860 <li
><?php
aField( $conf, "Enotif", "disabled", "radio", "enotif_disabled" ); ?
></li
>
861 <li
><?php
aField( $conf, "Enotif", "enabled for changes of watch-listed and user_talk pages (recommended for small wikis; perhaps not suited for large wikis)", "radio", "enotif_allpages" ); ?
></li
>
862 <li
><?php
aField( $conf, "Enotif", "enabled for changes of user_talk pages only (suited for small and large wikis)", "radio", "enotif_usertalk" ); ?
></li
>
867 E
-mail notification sends a notification e
-mail to a user
, when the user_talk page is changed
868 and/or when watch
-listed pages are changed
, depending on the above settings
.
869 When testing this feature
, be reminded
, that obviously an e
-mail address must be present in your preferences
870 and that your own changes never trigger notifications to be sent to yourself
.</p
>
872 <p
>Users get corresponding options to select
or deselect in their users
' preferences.
873 The user options are not shown on the preference page, if e-mail notification is disabled.</p>
875 <p>There are additional options for fine tuning in /includes/DefaultSettings.php .</p>
879 <label class='column
'>E-mail address authentication</label>
880 <div>Select one:</div>
883 <li><?php aField( $conf, "Eauthent", "disabled", "radio", "eauthent_disabled" ); ?></li>
884 <li><?php aField( $conf, "Eauthent", "enabled", "radio", "eauthent_enabled" ); ?></li>
889 E-mail address authentication uses a scheme to authenticate e-mail addresses of the users. The user who initially enters or who changes his/her stored e-mail address
890 gets a one-time temporary password mailed to that address. The user can use the original password as long as wanted, however, the stored e-mail address
891 is only authenticated at the moment when the user logs in with the one-time temporary password.<p>
893 <p>The e-mail address stays authenticated as long as the user does not change it; the time of authentication is indicated
894 on the user preference page.</p>
896 <p>If the option is enabled, only authenticated e-mail addresses can receive EmailUser mails and/or
897 e-mail notification mails.</p>
902 <h2>Database config</h2>
906 aField( $conf, "DBserver", "MySQL server" );
909 If your database server isn't on your web server
, enter the name
914 aField( $conf, "DBname", "Database name" );
917 aField( $conf, "DBuser", "DB username" );
920 aField( $conf, "DBpassword", "DB password", "password" );
923 aField( $conf, "DBpassword2", "again", "password" );
926 If you only have a single user account
and database available
,
927 enter those here
. If you have database root
access (see below
)
928 you can specify
new accounts
/databases to be created
.
932 aField( $conf, "DBprefix", "Database table prefix" );
935 <p
>If you need to share one database between multiple wikis
, or
936 MediaWiki
and another web application
, you may choose to
937 add a prefix to all the table names to avoid conflicts
.</p
>
939 <p
>Avoid exotic characters
; something like
<tt
>mw_
</tt
> is good
.</p
>
944 aField( $conf, "RootPW", "DB root password", "password" );
948 You will only need this
if the database
and/or user account
949 above don
't already exist.
950 Do <em>not</em> type in your machine's root password
! MySQL
951 has its own
"root" user with a separate password
. (It might
952 even be blank
, depending on your configuration
.)
956 <label
class='column'> 
;</label
>
957 <input type
="submit" value
="Install!" />
967 /* -------------------------------------------------------------------------------------- */
968 function writeSuccessMessage() {
970 if ( ini_get( 'safe_mode' ) && !ini_get( 'open_basedir' ) ) {
972 <p>Installation successful!</p>
973 <p>To complete the installation, please do the following:
975 <li>Download config/LocalSettings.php with your FTP client or file manager</li>
976 <li>Upload it to the parent directory</li>
977 <li>Delete config/LocalSettings.php</li>
978 <li>Start using <a href='../index.php'>your wiki</a>!
980 <p>If you are in a shared hosting environment, do <strong>not</strong> just move LocalSettings.php
981 remotely. LocalSettings.php is currently owned by the user your webserver is running under,
982 which means that anyone on the same server can read your database password! Downloading
983 it and uploading it again will hopefully change the ownership to a user ID specific to you.</p>
986 echo "<p>Installation successful! Move the config/LocalSettings.php file into the parent directory, then follow
987 <a href='../index.php'>this link</a> to your wiki.</p>\n";
992 function escapePhpString( $string ) {
993 return strtr( $string,
1004 function writeLocalSettings( $conf ) {
1005 $conf->DBmysql4
= @$conf->DBmysql4 ?
'true' : 'false';
1006 $conf->UseImageResize
= $conf->UseImageResize ?
'true' : 'false';
1007 $conf->PasswordSender
= $conf->EmergencyContact
;
1008 $zlib = ($conf->zlib ?
"" : "# ");
1009 $magic = ($conf->ImageMagick ?
"" : "# ");
1010 $convert = ($conf->ImageMagick ?
$conf->ImageMagick
: "/usr/bin/convert" );
1011 $pretty = ($conf->prettyURLs ?
"" : "# ");
1012 $ugly = ($conf->prettyURLs ?
"# " : "");
1013 $rights = ($conf->RightsUrl
) ?
"" : "# ";
1014 $hashedUploads = $conf->safeMode ?
'' : '# ';
1016 switch ( $conf->Shm
) {
1018 $cacheType = 'CACHE_MEMCACHED';
1019 $mcservers = var_export( $conf->MCServerArray
, true );
1023 $cacheType = 'CACHE_ACCEL';
1024 $mcservers = 'array()';
1027 $cacheType = 'CACHE_NONE';
1028 $mcservers = 'array()';
1031 if ( $conf->Email
== 'email_enabled' ) {
1032 $enableemail = 'true';
1033 $enableuseremail = ( $conf->Emailuser
== 'emailuser_enabled' ) ?
'true' : 'false' ;
1034 $eauthent = ( $conf->Eauthent
== 'eauthent_enabled' ) ?
'true' : 'false' ;
1035 switch ( $conf->Enotif
) {
1036 case 'enotif_usertalk':
1037 $enotifusertalk = 'true';
1038 $enotifwatchlist = 'false';
1040 case 'enotif_allpages':
1041 $enotifusertalk = 'true';
1042 $enotifwatchlist = 'true';
1045 $enotifusertalk = 'false';
1046 $enotifwatchlist = 'false';
1049 $enableuseremail = 'false';
1050 $enableemail = 'false';
1051 $eauthent = 'false';
1052 $enotifusertalk = 'false';
1053 $enotifwatchlist = 'false';
1056 $file = @fopen
( "/dev/urandom", "r" );
1058 $secretKey = bin2hex( fread( $file, 32 ) );
1062 for ( $i=0; $i<8; $i++
) {
1063 $secretKey .= dechex(mt_rand(0, 0x7fffffff));
1065 print "<li>Warning: \$wgSecretKey key is insecure, generated with mt_rand(). Consider changing it manually.</li>\n";
1068 # Add slashes to strings for double quoting
1069 $slconf = array_map( "escapePhpString", get_object_vars( $conf ) );
1070 if( $conf->License
== 'gfdl' ) {
1071 # Needs literal string interpolation for the current style path
1072 $slconf['RightsIcon'] = $conf->RightsIcon
;
1075 $sep = (DIRECTORY_SEPARATOR
== "\\") ?
";" : ":";
1077 # This file was automatically generated by the MediaWiki installer.
1078 # If you make manual changes, please keep track in case you need to
1079 # recreate them later.
1081 \$IP = \"{$slconf['IP']}\";
1082 ini_set( \"include_path\", \".$sep\$IP$sep\$IP/includes$sep\$IP/languages\" );
1083 require_once( \"includes/DefaultSettings.php\" );
1085 # If PHP's memory limit is very low, some operations may fail.
1086 " . ($conf->raiseMemory ?
'' : '# ' ) . "ini_set( 'memory_limit', '20M' );" . "
1088 if ( \$wgCommandLineMode ) {
1089 if ( isset( \$_SERVER ) && array_key_exists( 'REQUEST_METHOD', \$_SERVER ) ) {
1090 die( \"This script must be run from the command line\\n\" );
1092 } elseif ( empty( \$wgNoOutputBuffer ) ) {
1093 ## Compress output if the browser supports it
1094 {$zlib}if( !ini_get( 'zlib.output_compression' ) ) @ob_start( 'ob_gzhandler' );
1097 \$wgSitename = \"{$slconf['Sitename']}\";
1099 \$wgScriptPath = \"{$slconf['ScriptPath']}\";
1100 \$wgScript = \"\$wgScriptPath/index.php\";
1101 \$wgRedirectScript = \"\$wgScriptPath/redirect.php\";
1103 ## If using PHP as a CGI module, use the ugly URLs
1104 {$pretty}\$wgArticlePath = \"\$wgScript/\$1\";
1105 {$ugly}\$wgArticlePath = \"\$wgScript?title=\$1\";
1107 \$wgStylePath = \"\$wgScriptPath/skins\";
1108 \$wgStyleDirectory = \"\$IP/skins\";
1109 \$wgLogo = \"\$wgStylePath/common/images/wiki.png\";
1111 \$wgUploadPath = \"\$wgScriptPath/images\";
1112 \$wgUploadDirectory = \"\$IP/images\";
1114 \$wgEnableEmail = $enableemail;
1115 \$wgEnableUserEmail = $enableuseremail;
1117 \$wgEmergencyContact = \"{$slconf['EmergencyContact']}\";
1118 \$wgPasswordSender = \"{$slconf['PasswordSender']}\";
1120 ## For a detailed description of the following switches see
1121 ## http://meta.wikimedia.org/Enotif and http://meta.wikimedia.org/Eauthent
1122 ## There are many more options for fine tuning available see
1123 ## /includes/DefaultSettings.php
1124 ## UPO means: this is also a user preference option
1125 \$wgEnotifUserTalk = $enotifusertalk; # UPO
1126 \$wgEnotifWatchlist = $enotifwatchlist; # UPO
1127 \$wgEmailAuthentication = $eauthent;
1129 \$wgDBserver = \"{$slconf['DBserver']}\";
1130 \$wgDBname = \"{$slconf['DBname']}\";
1131 \$wgDBuser = \"{$slconf['DBuser']}\";
1132 \$wgDBpassword = \"{$slconf['DBpassword']}\";
1133 \$wgDBprefix = \"{$slconf['DBprefix']}\";
1135 # If you're on MySQL 3.x, this next line must be FALSE:
1136 \$wgDBmysql4 = {$conf->DBmysql4};
1138 ## Shared memory settings
1139 \$wgMainCacheType = $cacheType;
1140 \$wgMemCachedServers = $mcservers;
1142 ## To enable image uploads, make sure the 'images' directory
1143 ## is writable, then uncomment this:
1144 # \$wgEnableUploads = true;
1145 \$wgUseImageResize = {$conf->UseImageResize};
1146 {$magic}\$wgUseImageMagick = true;
1147 {$magic}\$wgImageMagickConvertCommand = \"{$convert}\";
1149 ## If you want to use image uploads under safe mode,
1150 ## create the directories images/archive, images/thumb and
1151 ## images/temp, and make them all writable. Then uncomment
1152 ## this, if it's not already uncommented:
1153 {$hashedUploads}\$wgHashedUploadDirectory = false;
1155 ## If you have the appropriate support software installed
1156 ## you can enable inline LaTeX equations:
1157 # \$wgUseTeX = true;
1158 \$wgMathPath = \"{\$wgUploadPath}/math\";
1159 \$wgMathDirectory = \"{\$wgUploadDirectory}/math\";
1160 \$wgTmpDirectory = \"{\$wgUploadDirectory}/tmp\";
1162 \$wgLocalInterwiki = \$wgSitename;
1164 \$wgLanguageCode = \"{$slconf['LanguageCode']}\";
1166 \$wgProxyKey = \"$secretKey\";
1168 ## Default skin: you can change the default skin. Use the internal symbolic
1169 ## names, ie 'standard', 'nostalgia', 'cologneblue', 'monobook':
1170 # \$wgDefaultSkin = 'monobook';
1172 ## For attaching licensing metadata to pages, and displaying an
1173 ## appropriate copyright notice / icon. GNU Free Documentation
1174 ## License and Creative Commons licenses are supported so far.
1175 {$rights}\$wgEnableCreativeCommonsRdf = true;
1176 \$wgRightsPage = \"\"; # Set to the title of a wiki page that describes your license/copyright
1177 \$wgRightsUrl = \"{$slconf['RightsUrl']}\";
1178 \$wgRightsText = \"{$slconf['RightsText']}\";
1179 \$wgRightsIcon = \"{$slconf['RightsIcon']}\";
1180 # \$wgRightsCode = \"{$slconf['RightsCode']}\"; # Not yet used
1182 \$wgDiff3 = \"{$slconf['diff3']}\";
1184 // Keep things in Unix line endings internally;
1185 // the system will write out as local text type.
1186 return str_replace( "\r\n", "\n", $localsettings );
1189 function dieout( $text ) {
1190 die( $text . "\n\n</body>\n</html>" );
1193 function importVar( &$var, $name, $default = "" ) {
1194 if( isset( $var[$name] ) ) {
1195 $retval = $var[$name];
1196 if ( get_magic_quotes_gpc() ) {
1197 $retval = stripslashes( $retval );
1205 function importPost( $name, $default = "" ) {
1206 return importVar( $_POST, $name, $default );
1209 function importRequest( $name, $default = "" ) {
1210 return importVar( $_REQUEST, $name, $default );
1213 function aField( &$conf, $field, $text, $type = "", $value = "" ) {
1215 $xtype = "type=\"$type\"";
1220 if(!(isset($id)) or ($id == "") ) $id = $field;
1221 $nolabel = ($type == "radio") ||
($type == "hidden");
1225 echo "\t\t<label class='column' for=\"$id\">$text</label>\n";
1228 if( $type == "radio" && $value == $conf->$field ) {
1229 $checked = "checked='checked'";
1233 echo "\t\t<input $xtype name=\"$field\" id=\"$id\" $checked value=\"";
1234 if( $type == "radio" ) {
1235 echo htmlspecialchars( $value );
1237 echo htmlspecialchars( $conf->$field );
1241 echo " $text</label>\n";
1245 if(isset($errs[$field])) echo "<span class='error'>" . $errs[$field] . "</span>\n";
1248 function getLanguageList() {
1249 global $wgLanguageNames;
1250 if( !isset( $wgLanguageNames ) ) {
1251 $wgContLanguageCode = "xxx";
1252 function wfLocalUrl( $x ) { return $x; }
1253 function wfLocalUrlE( $x ) { return $x; }
1254 require_once( "languages/Names.php" );
1259 $d = opendir( "../languages" );
1260 while( false !== ($f = readdir( $d ) ) ) {
1261 if( preg_match( '/Language([A-Z][a-z_]+)\.php$/', $f, $m ) ) {
1262 $code = str_replace( '_', '-', strtolower( $m[1] ) );
1263 if( isset( $wgLanguageNames[$code] ) ) {
1264 $name = $code . ' - ' . $wgLanguageNames[$code];
1268 $codes[$code] = $name;
1276 #Check for location of an executable
1277 # @param string $loc single location to check
1278 # @param array $names filenames to check for.
1279 # @param mixed $versioninfo array of details to use when checking version, use false for no version checking
1280 function locate_executable($loc, $names, $versioninfo = false) {
1281 if (!is_array($names))
1282 $names = array($names);
1284 foreach ($names as $name) {
1285 if (file_exists("$loc/$name")) {
1287 return "$loc/$name";
1289 $file = str_replace('$1', "$loc/$name", $versioninfo[0]);
1290 if (strstr(`
$file`
, $versioninfo[1]) !== false)
1291 return "$loc/$name";
1297 # Test a memcached server
1298 function testMemcachedServer( $server ) {
1299 $hostport = explode(":", $server);
1302 if ( !function_exists( 'fsockopen' ) ) {
1303 $errstr = "Can't connect to memcached, fsockopen() not present";
1305 if ( !$errstr && count( $hostport ) != 2 ) {
1306 $errstr = 'Please specify host and port';
1307 var_dump( $hostport );
1310 list( $host, $port ) = $hostport;
1314 $fp = @fsockopen
( $host, $port, $errno, $fsockerr, 1.0 );
1315 if ( $fp === false ) {
1316 $errstr = "Cannot connect to memcached on $host:$port : $fsockerr";
1320 $command = "version\r\n";
1321 $bytes = fwrite( $fp, $command );
1322 if ( $bytes != strlen( $command ) ) {
1323 $errstr = "Cannot write to memcached socket on $host:$port";
1327 $expected = "VERSION ";
1328 $response = fread( $fp, strlen( $expected ) );
1329 if ( $response != $expected ) {
1330 $errstr = "Didn't get correct memcached response from $host:$port";
1337 echo "<li>Connected to memcached on $host:$port successfully";