Difference between revisions of "MediaWiki"

From ArchWiki
Jump to: navigation, search
m (Nginx: link to Nginx and php-fpm package)
(Installation: style)
 
(73 intermediate revisions by 29 users not shown)
Line 1: Line 1:
[[Category:Web Server]]
+
[[Category:Web server]]
{{Note| If you are using xampp, instead of [[LAMP]], there are different steps you need to take after installing. More info [https://www.mediawiki.org/wiki/Manual:Running_MediaWiki_on_XAMPP#381 here] }}
+
[[ja:MediaWiki]]
 +
[https://www.mediawiki.org/wiki/MediaWiki MediaWiki] is a free and open source wiki software written in PHP, originally developed for Wikipedia.
 +
 
 
== Installation ==
 
== Installation ==
  
You need to have a web server installed, configured to be able to use {{Pkg|php}}.  You can follow the [[LAMP]] guide for that purpose.
+
{{Note|To install MediaWiki on XAMPP see [[mw:Manual:Installing MediaWiki on XAMPP]].}}
 +
 
 +
To run MediaWiki you need three things:
 +
 
 +
* the {{pkg|mediawiki}} package
 +
* a web server –  [[Apache]], [[Nginx]] or [[Lighttpd]]
 +
* a database system – [[MySQL]], [[PostgreSQL]] or [[SQLite]]
 +
 
 +
Optionally install {{pkg|imagemagick}} or {{pkg|php-gd}} for thumbnail rendering and {{pkg|php-intl}} to handle Unicode normalization.
 +
 
 +
==Configuration==
 +
 
 +
The steps to achieve a working MediaWiki configuration involve editing the PHP settings and adding the MediaWiki configuration snippets.
 +
 
 +
===PHP===
 +
 
 +
First, adjust the {{ic|open_basedir}} in {{ic|/etc/php/php.ini}} to include the mediawiki data directory ({{ic|/var/lib/mediawiki}} by default):
 +
 
 +
{{hc|/etc/php/php.ini|2=
 +
open_basedir = /srv/http/:/home/:/tmp/:/usr/share/pear/:/usr/share/webapps/:/var/lib/mediawiki/
 +
}}
 +
 
 +
Then, also in {{ic|/etc/php/php.ini}}, uncomment the following lines: (in the {{ic|Dynamic Extensions}} section)
 +
extension=gd.so
 +
extension=intl.so
 +
  extension=iconv.so
  
[[Pacman|Install]] the {{pkg|php-gd}}, {{pkg|php-intl}}, {{pkg|php-xcache}} and {{pkg|mediawiki}}, all available from the [[official repositories]].
+
{{Note|
 +
* If you would like to use SQLite as database, also uncomment {{ic|1=extension=pdo_sqlite.so}}.
 +
* If you would like to use MariaDB as database, also uncomment {{ic|1=extension=mysqli.so}}.
 +
}}
  
Instead of {{pkg|mysql}} you can use sqlite (which requires {{pkg|php-sqlite}} and {{pkg|sqlite}}) or {{pkg|postgresql}}.
+
Second, tweak the session handling or you might get a fatal error ({{ic|PHP Fatal error: session_start(): Failed to initialize storage module[...]}}) by finding the {{ic|session.save_path}} path. A good choice can be {{ic|/var/lib/php/sessions}} or {{ic|/tmp/}}.
  
{{Note|Since PHP 5.1.0, SQLite depends on PDO. You should uncomment the following line in your php.ini if you wish to use SQLite with Mediawiki:
+
{{hc|/etc/php/php.ini|2=
 +
session.save_path = "/var/lib/php/sessions"
 +
}}
  
'''extension1=pdo_sqlite.so'''}}
+
You will need to create the directory if it doesn't exist and then restrict its permissions:
  
==Configuration==
+
{{bc|
First, adjust the {{ic|open_basedir}} in {{ic|/etc/php/php.ini}} to include the webapps directory (allows '''update.php''' to be run from the command line):
+
# mkdir -p /var/lib/php/sessions/
{{hc|/etc/php/php.ini|<nowiki>
+
# chown http:http /var/lib/php/sessions
open_basedir = /srv/http/:/home/:/tmp/:/usr/share/pear/:/usr/share/webapps/
+
# chmod go-rwx /var/lib/php/sessions
</nowiki>}}
+
}}
Then, still on {{ic|/etc/php/php.ini}}, look for the {{ic|Dynamic Extensions}} section  and uncomment {{ic|1=;extension=gd.so}}, uncomment {{ic|1=;extension=intl.so}} and add {{ic|1=extension=xcache.so}}.
 
  
Now do the steps corresponding to your web server.
 
 
=== Web server ===
 
=== Web server ===
 +
 
==== Apache ====
 
==== Apache ====
Create {{ic|/etc/webapps/mediawiki/httpd-mediawiki.conf}} from the provided example {{ic|apache.example.conf}} in the same directory. Edit it to remove the {{ic|php_admin_value open_basedir}} line, which is already in {{ic|php.ini}}.
 
  
*Add the following lines to {{ic|/etc/httpd/conf/httpd.conf}}
+
Copy {{ic|/etc/webapps/mediawiki/apache.example.conf}} to {{ic|/etc/httpd/conf/extra/mediawiki.conf}} and edit it as needed.
{{bc|
+
 
LoadModule php5_module modules/libphp5.so
+
Add the following line to {{ic|/etc/httpd/conf/httpd.conf}}
Include conf/extra/php5_module.conf
+
Include conf/extra/mediawiki.conf
Include /etc/webapps/mediawiki/httpd-mediawiki.conf
 
}}
 
  
* Adjust permissions in {{ic|/usr/share/webapps/mediawiki/.htaccess}}, e.g. to
+
[[Restart]] the {{ic|httpd.service}} daemon.
{{bc|allow from all}}
 
  
[[Daemons|Restart]] the {{ic|httpd.service}} daemon.
+
{{Note|The default file from {{ic|/etc/webapps/mediawiki/apache.example.conf}} will overwrite the PHP open_basedir setting, possibly conflicting with other pages. This behavior can be changed by moving line starting with {{ic|php_admin_value}} between the {{ic|<nowiki><Directory></nowiki>}} tags. Further, if you are running multiple applications that depend on the same server, this value could also be added to the open_basedir value in {{ic|/etc/php/php.ini}} instead of {{ic|/etc/httpd/conf/extra/mediawiki.conf}}}}
  
 
==== Nginx ====
 
==== Nginx ====
 +
 
To get MediaWiki working with [[Nginx]], create the following file:
 
To get MediaWiki working with [[Nginx]], create the following file:
  
Line 47: Line 75:
 
}
 
}
 
location @mediawiki {
 
location @mediawiki {
   rewrite ^/(.*)$ /index.php?title=$1&$args;
+
   rewrite ^/(.*)$ /index.php;
 
}
 
}
 
location ~ \.php5?$ {
 
location ~ \.php5?$ {
   include fastcgi.conf;
+
   include /etc/nginx/fastcgi_params;
   fastcgi_pass php;
+
   fastcgi_pass unix:/var/run/php-fpm/php-fpm.sock;
 +
  fastcgi_index index.php5;
 +
  fastcgi_param  SCRIPT_FILENAME  $document_root$fastcgi_script_name;
 +
  try_files $uri @mediawiki;
 
}
 
}
 
location ~* \.(js|css|png|jpg|jpeg|gif|ico)$ {
 
location ~* \.(js|css|png|jpg|jpeg|gif|ico)$ {
Line 74: Line 105:
 
}
 
}
 
</nowiki>}}
 
</nowiki>}}
Ensure that {{Pkg|php-fpm}} is installed, and in your {{ic|/etc/nginx/nginx.conf}} file, ensure that you have an {{ic|upstream}} directive named {{ic|php}}, similar to this one:
 
  
{{hc|/etc/nginx/nginx.conf|<nowiki>
+
Ensure that {{Pkg|php-fpm}} is installed and [[start]]ed.
upstream php {
 
  server unix:/var/run/php-fpm/php-fpm.sock;
 
}
 
</nowiki>}}
 
  
 
Include a server directive, similar to this
 
Include a server directive, similar to this
Line 98: Line 124:
 
}
 
}
 
}}
 
}}
 +
 +
Finally, [[restart]] {{ic|nginx.service}} and {{ic|php-fpm.service}} daemons.
  
 
==== Lighttpd ====
 
==== Lighttpd ====
 +
 
You should have [[Lighttpd]] installed and configured. "mod_alias" and "mod_rewrite" in server.modules array of lighttpd is required. Append to the lighttpd configuration file the following lines
 
You should have [[Lighttpd]] installed and configured. "mod_alias" and "mod_rewrite" in server.modules array of lighttpd is required. Append to the lighttpd configuration file the following lines
 +
 
{{hc|/etc/lighttpd/lighttpd.conf|<nowiki>
 
{{hc|/etc/lighttpd/lighttpd.conf|<nowiki>
 
alias.url += ("/mediawiki" => "/usr/share/webapps/mediawiki/")
 
alias.url += ("/mediawiki" => "/usr/share/webapps/mediawiki/")
Line 109: Line 139:
 
)
 
)
 
</nowiki>}}
 
</nowiki>}}
[[Daemons|Restart]] the {{ic|lighttpd.service}} daemon.
+
 
 +
[[Restart]] the {{ic|lighttpd.service}} daemon.
 +
 
 +
=== Database ===
 +
 
 +
If the database server is already set up, MediaWiki can automatically create the database (provided that the database root password is supplied) during the [[#LocalSettings.php|next step]]. Otherwise the database needs to be created manually, see [[mw:Manual:Installing_MediaWiki#Create_a_database|upstream instructions]].
  
 
=== LocalSettings.php ===
 
=== LocalSettings.php ===
Open the wiki url (is {{ic|http://''your_server''/mediawiki/}}) in a browser and do the initial setup to create {{ic|LocalSettings.php}}. Then save it to {{ic|/usr/share/webapps/mediawiki/LocalSettings.php}}.
+
 
 +
Open the wiki url (usually {{ic|http://''your_server''/mediawiki/}}) in a browser and do the initial configuration. Follow [[mw:Manual:Config_script|upstream instructions]].
 +
 
 +
The generated {{ic|LocalSettings.php}} file is offered for download, save it to {{ic|/usr/share/webapps/mediawiki/LocalSettings.php}}. This file defines the specific settings of your wiki. Whenever you upgrade the {{pkg|mediawiki}} package, it is not replaced.
  
 
== Tips and tricks ==
 
== Tips and tricks ==
 +
 
=== Mathematics (texvc) ===
 
=== Mathematics (texvc) ===
  
Usually installing {{Pkg|texvc}} and enabling it in the config are enough:
+
Usually installing {{Pkg|texvc}} and enabling it in the config is enough:
  
{{bc|1=$wgUseTeX = true;}}
+
$wgUseTeX = true;
  
 
If you get problems, try to increase limits for shell commands:
 
If you get problems, try to increase limits for shell commands:
{{bc|<nowiki>
+
 
$wgMaxShellMemory = 8000000;
+
{{bc|1=
$wgMaxShellFileSize = 1000000;
+
$wgMaxShellMemory = 8000000;
$wgMaxShellTime = 300;
+
$wgMaxShellFileSize = 1000000;
</nowiki>}}
+
$wgMaxShellTime = 300;
 +
}}
  
 
=== Unicode ===
 
=== Unicode ===
  
 
Check that php, apache and mysql uses UTF-8. Otherwise you may face strange bugs because of encoding mismatch.
 
Check that php, apache and mysql uses UTF-8. Otherwise you may face strange bugs because of encoding mismatch.
 +
 +
=== VisualEditor ===
 +
 +
The VisualEditor MediaWiki extension provides a rich-text editor for MediaWiki. Follow [[mw:Extension:VisualEditor]] to install it.
 +
 +
You will also need the [[mw:Parsoid|Parsoid]] Node.js backend, which is available from the [[AUR]] as {{AUR|parsoid-git}}.
 +
 +
Adjust the path to MediaWiki in {{ic|/usr/share/webapps/parsoid/api/localsettings.js}}:
 +
 +
parsoidConfig.setInterwiki( 'localhost', '<nowiki>http://localhost/mediawiki/api.php</nowiki>' );
 +
 +
After that [[enable]] and start {{ic|parsoid.service}}.

Latest revision as of 09:48, 16 April 2017

MediaWiki is a free and open source wiki software written in PHP, originally developed for Wikipedia.

Installation

Note: To install MediaWiki on XAMPP see mw:Manual:Installing MediaWiki on XAMPP.

To run MediaWiki you need three things:

Optionally install imagemagick or php-gd for thumbnail rendering and php-intl to handle Unicode normalization.

Configuration

The steps to achieve a working MediaWiki configuration involve editing the PHP settings and adding the MediaWiki configuration snippets.

PHP

First, adjust the open_basedir in /etc/php/php.ini to include the mediawiki data directory (/var/lib/mediawiki by default):

/etc/php/php.ini
open_basedir = /srv/http/:/home/:/tmp/:/usr/share/pear/:/usr/share/webapps/:/var/lib/mediawiki/

Then, also in /etc/php/php.ini, uncomment the following lines: (in the Dynamic Extensions section)

extension=gd.so
extension=intl.so
extension=iconv.so
Note:
  • If you would like to use SQLite as database, also uncomment extension=pdo_sqlite.so.
  • If you would like to use MariaDB as database, also uncomment extension=mysqli.so.

Second, tweak the session handling or you might get a fatal error (PHP Fatal error: session_start(): Failed to initialize storage module[...]) by finding the session.save_path path. A good choice can be /var/lib/php/sessions or /tmp/.

/etc/php/php.ini
session.save_path = "/var/lib/php/sessions"

You will need to create the directory if it doesn't exist and then restrict its permissions:

# mkdir -p /var/lib/php/sessions/
# chown http:http /var/lib/php/sessions
# chmod go-rwx /var/lib/php/sessions

Web server

Apache

Copy /etc/webapps/mediawiki/apache.example.conf to /etc/httpd/conf/extra/mediawiki.conf and edit it as needed.

Add the following line to /etc/httpd/conf/httpd.conf

Include conf/extra/mediawiki.conf

Restart the httpd.service daemon.

Note: The default file from /etc/webapps/mediawiki/apache.example.conf will overwrite the PHP open_basedir setting, possibly conflicting with other pages. This behavior can be changed by moving line starting with php_admin_value between the <Directory> tags. Further, if you are running multiple applications that depend on the same server, this value could also be added to the open_basedir value in /etc/php/php.ini instead of /etc/httpd/conf/extra/mediawiki.conf

Nginx

To get MediaWiki working with Nginx, create the following file:

/etc/nginx/mediawiki.conf

location / {
   index index.php;
   try_files $uri $uri/ @mediawiki;
}
location @mediawiki {
   rewrite ^/(.*)$ /index.php;
}
location ~ \.php5?$ {
   include /etc/nginx/fastcgi_params;
   fastcgi_pass unix:/var/run/php-fpm/php-fpm.sock;
   fastcgi_index index.php5;
   fastcgi_param  SCRIPT_FILENAME  $document_root$fastcgi_script_name;
   try_files $uri @mediawiki;
}
location ~* \.(js|css|png|jpg|jpeg|gif|ico)$ {
   try_files $uri /index.php;
   expires max;
   log_not_found off;
}
# Restrictions based on the .htaccess files
location ^~ ^/(cache|includes|maintenance|languages|serialized|tests|images/deleted)/ {
   deny all;
}
location ^~ ^/(bin|docs|extensions|includes|maintenance|mw-config|resources|serialized|tests)/ {
   internal;
}
location ^~ /images/ {
   try_files $uri /index.php;
}
location ~ /\. {
   access_log off;
   log_not_found off; 
   deny all;
}

Ensure that php-fpm is installed and started.

Include a server directive, similar to this

/etc/nginx/nginx.conf
server {
  listen 80;
  server_name mediawiki;
  root /usr/share/webapps/mediawiki;
  index index.php;
  charset utf-8;
# For correct file uploads
  client_max_body_size    100m; # Equal or more than upload_max_filesize in /etc/php/php.ini
  client_body_timeout     60;
  include mediawiki.conf;

}

Finally, restart nginx.service and php-fpm.service daemons.

Lighttpd

You should have Lighttpd installed and configured. "mod_alias" and "mod_rewrite" in server.modules array of lighttpd is required. Append to the lighttpd configuration file the following lines

/etc/lighttpd/lighttpd.conf
alias.url += ("/mediawiki" => "/usr/share/webapps/mediawiki/")
url.rewrite-once += (
                "^/mediawiki/wiki/upload/(.+)" => "/mediawiki/wiki/upload/$1",
                "^/mediawiki/wiki/$" => "/mediawiki/index.php",
                "^/mediawiki/wiki/([^?]*)(?:\?(.*))?" => "/mediawiki/index.php?title=$1&$2"
)

Restart the lighttpd.service daemon.

Database

If the database server is already set up, MediaWiki can automatically create the database (provided that the database root password is supplied) during the next step. Otherwise the database needs to be created manually, see upstream instructions.

LocalSettings.php

Open the wiki url (usually http://your_server/mediawiki/) in a browser and do the initial configuration. Follow upstream instructions.

The generated LocalSettings.php file is offered for download, save it to /usr/share/webapps/mediawiki/LocalSettings.php. This file defines the specific settings of your wiki. Whenever you upgrade the mediawiki package, it is not replaced.

Tips and tricks

Mathematics (texvc)

Usually installing texvc and enabling it in the config is enough:

$wgUseTeX = true;

If you get problems, try to increase limits for shell commands:

$wgMaxShellMemory = 8000000;
$wgMaxShellFileSize = 1000000;
$wgMaxShellTime = 300;

Unicode

Check that php, apache and mysql uses UTF-8. Otherwise you may face strange bugs because of encoding mismatch.

VisualEditor

The VisualEditor MediaWiki extension provides a rich-text editor for MediaWiki. Follow mw:Extension:VisualEditor to install it.

You will also need the Parsoid Node.js backend, which is available from the AUR as parsoid-gitAUR.

Adjust the path to MediaWiki in /usr/share/webapps/parsoid/api/localsettings.js:

parsoidConfig.setInterwiki( 'localhost', 'http://localhost/mediawiki/api.php' );

After that enable and start parsoid.service.