Manual:install.php

MediaWiki file: install.php
Location:	maintenance/
Source code:	master • 1.34.2 • 1.33.4 • 1.31.8
Classes:	CommandLineInstaller

Details

install.php file is a CLI-based maintenance script for the MediaWiki installation and configuration.

Usage

Default options are indicated in parentheses:

php install.php [--conf|--confpath|--dbname|--dbpass|--dbpassfile|--dbpath|--dbport|--dbprefix|--dbschema|--dbserver|--dbtype|--dbuser|--env-checks|--globals|--help|--installdbpass|--installdbuser|--lang|--memory-limit|--pass|--passfile|--profiler|--quiet|--scriptpath|--server|--wiki] [name] <admin>

Generic maintenance parameters:

--help (-h)

Display this help message

--quiet (-q)

Whether to suppress non-error output

--conf

Location of LocalSettings.php, if not default

--wiki

For specifying the wiki ID

--globals

Output globals at the end of processing for debugging

--memory-limit

Set a specific memory limit for the script, "max" for no limit or "default" to avoid changing it

--server

The protocol and server name to use in URLs, e.g. https://en.wikipedia.org. This is sometimes necessary because server name detection may fail in command line scripts.

--profiler

Profiler output format (usually "text")

Script dependent parameters

--dbuser

The DB user to use for this script. This value appears in LocalSettings.php for $wgDBuser. If --installdbuser and --installdbpass are given, this value will be used to create a new account

--dbpass

The password to use for this script. This value appears in LocalSettings.php for $wgDBpassword. If --installdbuser and --installdbpass are given, this value will be used to create a new account

Script specific parameters

--confpath

Path to write LocalSettings.php to (/var/www/)

--dbname

The database name (my_wiki)

--dbpassfile

An alternative way to provide dbpass option, as the contents of this file

--dbpath

The path for the SQLite DB ($IP/data)

--dbport

The database port; only for PostgreSQL (5432)

--dbprefix

Optional database table name prefix

--dbschema

The schema for the MediaWiki DB in PostgreSQL/Microsoft SQL Server (mediawiki)

--dbserver

The database host (localhost)

--dbtype

The type of database (mysql)

--env-checks

Run environment checks only, don't change anything

--installdbpass

The password for the DB user to install as

--installdbuser

The user to use for installing (root)

--lang

The language to use (en)

--pass

The password for the wiki administrator

--passfile

An alternative way to provide pass option, as the contents of this file

--scriptpath

The relative path of the wiki in the web server (/wiki)

Arguments

[name]

The name of the wiki (MediaWiki)

<admin>

The username of the wiki administrator

Examples

Set up wiki using a user with required permissions in database to create a new database for the wiki and a user to operate the wiki:

php maintenance/install.php --dbname=wikidb --dbserver="localhost" --installdbuser=root --installdbpass=rootpassword --dbuser=grabber --dbpass=grabber --server="http://wiki.domain.name/" --scriptpath=/ --lang=en --pass=aaaaa "Wiki Name" "Admin"