3 '''tldr''': For GNU/Linux (with a bit of Debian bias), a more concise, holistic and automated install than the official Mediawiki docs. Do some initial configuration then download this page and run it, or execute it as you read.
5 ''' Goals / Why use this guide? '''
7 * Good recommendations. Official docs mostly avoid recommendations among a myriad of possibilities
8 * Closely references & supplements official documentation
9 * Automatic security updates
10 * Explicit automation support wherever practical
11 * Used to setup this site (style is optional)
12 * Support for multiple gnu/linux distros
13 * Holistic scope (backups, server setup), but sections are independent
14 * Code blocks are [https://en.wikipedia.org/wiki/Idempotent idempotent]
15 * Edits to this page are tested on this site and reviewed by the main author.
19 * Self hosting, single GNU/Linux system with root Bash shell
24 Very minor adjustments needed for other distros. Help expand this list.
25 * Mediawiki 1.28, updated as new versions are released
26 * Debian 8 + backports
28 * Debian testing (last tested Aug 7, 2016)
30 Pre 5/2016 revisions ran Mediawiki 1.23, tested on Fedora 20 and Ubuntu 14.04.
34 '''Getting a Server & a Domain'''
36 The most common route and the one taken by this site is buying a domain name from a site like namecheap, and a cheap vps from companies like linode or digital ocean. They have good getting started guides which mostly apply beyond their own sites.
40 Setting up email can be an involved process, and this guide assumes that a some program (usually postfix or exim) is implementing a functional sendmail interface. Mediawiki uses email with to send password reminders or notifications, and this guide includes cronjobs for updating mediawiki and doing backups which will send mail in the case of an error. Email is also the recommended way to get notifications of package updates which require manual steps such as restarting of services.
42 If you are not setting up your server to send mail with a program that uses the default sendmail interface, see these pages when you are configuring mediawiki: [[mediawikiwiki:Manual:$wgEnableEmail|Manual:$wgEnableEmail]], [https://www.mediawiki.org/wiki/Configuration_settings#Email_settings Manual:Email_settings], [[mediawikiwiki:Manual:$wgSMTP|Manual:$wgSMTP]]
44 == Setup Guide Configuration ==
47 # Save the code in this section to a file (~/mw_vars is suggested)
48 # Source it at the beginning of scripts containing later commands
49 # Source it from your .bashrc file while you are setting up Mediawiki
51 '''Requires customization:'''
52 <source lang="bash" type="example">
53 # Replace REPLACE_ME as appropriate
55 export mwdescription="REPLACE_ME" # eg. Opinionated Free Software Wiki
57 # username/pass of the first wiki admin user
58 export wikiuser="REPLACE_ME"
59 export wikipass=REPLACE_ME
61 # root password for the mysql database
62 export dbpass=REPLACE_ME
64 export mwdomain=REPLACE_ME # domain name. for this site, it's ofswiki.org
66 # customize these questions. Try not to have the answer be a word in the question.
68 if ! grep -Fx '$localSettingsQuestyQuestions = array (' $mwc; then
70 $localSettingsQuestyQuestions = array (
71 "What is the name of the wiki software this site (and wikipedia) uses?" => "Mediawiki",
72 "REPLACE_ME with a question" => "REPLACE_ME with an answer"
78 # The rest of this section will work fine with no changes.
80 # git branch for mediawiki + extensions. See intro for supported versions.
81 # branch names: https://git.wikimedia.org/branches/mediawiki%2Fcore.git
82 export mw_branch=REL1_28
84 # As set by gui installer when choosing cc by sa.
85 export mw_RightsUrl='https://creativecommons.org/licenses/by-sa/4.0/'
86 export mw_RightsText='Creative Commons Attribution-ShareAlike'
87 export mw_RightsIcon='$wgScriptPath/resources/assets/licenses/cc-by-sa.png'
89 # Alphanumeric site name for pywikibot.
90 # Here we use the domain minus the dots, which should work fine without changing.
91 export mwfamily=${mwdomain//./}
92 # install path for mediawiki. This should work fine.
93 export mw=/var/www/$mwdomain/html/w
96 # wiki sender address / wiki & wiki server contact email.
97 # see email section for more info on email
98 export mw_email="admin@$mwdomain"
101 mwc="$mw/LocalSettings.php"
104 == Download this page and run it ==
106 This is an option to do automated setup. Optional code blocks are skipped (they have a bold warning just before them and a tag on the source block). The only important things left after running this are running the automated backup setup code on another machine.
108 ''' Requires manual step: inspect output file: /tmp/mw-setup, then run it'''
109 <source lang="bash" type="example">
110 start=' *<source lang="bash"> *'
112 ruby <<'EOF' | sed -rn "/^$start$/,/^$end$/{s/^$start|$end$/# \0/;p} > /tmp/mw-setup"
114 puts JSON.parse(`curl 'https://ofswiki.org/w/api.php?\
115 action=query&titles=Mediawiki_Setup_Guide&prop=revisions&rvprop=content&\
116 format=json'`.chomp)['query']['pages'].values[0]['revisions'][0]['*']
118 chmod +x /tmp/mw-setup
121 == Required Bash Functions ==
123 Here we define some small useful bash functions. This should be part of the same ~/mw_vars file if you are running the code step by step.
126 # identify if this is a debian based distro
127 isdeb() { command -v apt &>/dev/null; }
128 # tee unique. append each stdin line if it does not exist in the file
132 for line in "${MAPFILE[@]}"; do
133 grep -xFq "$line" "$1" &>/dev/null || tee -a "$1" <<<"$line"
137 # get and reset an extension/skin repository, and enable it
140 local original_pwd="$PWD"
142 local re='[^/]*/[^/]*$'
143 [[ $url =~ $re ]] ||:
144 target=$mw/${BASH_REMATCH[0]}
145 if [[ ! -e $target/.git ]]; then
146 git clone $url $target
148 if ! cd $target; then
149 echo "mw-ext error: failed cd $target";
153 git checkout -qf origin/$mw_branch || git checkout -qf origin/master
161 mw-clone https://gerrit.wikimedia.org/r/p/mediawiki/extensions/$ext
162 if [[ -e $mw/ext/$ext/extension.json ]]; then
163 # new style extension. remove old style declaration
164 sed -i --follow-symlinks '#^require_once( "\\\$IP/extensions/\$ext/\$ext\.php" );#d' $mwc
166 wfLoadExtension( '$ext' );
170 require_once( "\$IP/extensions/$ext/$ext.php" );
174 # --quick is quicker than default flags,
175 # but still add a sleep to make sure everything works right
176 sudo -u $apache_user php $mw/maintenance/update.php -q --quick; sleep 1
180 mw-clone https://gerrit.wikimedia.org/r/p/mediawiki/skins/$skin
181 sed -i --follow-symlinks '/^wfLoadSkin/d' $mwc
182 sed -i --follow-symlinks '/^\$wgDefaultSkin/d' $mwc
184 \$wgDefaultSkin = "${skin,,*}";
185 wfLoadSkin( '$skin' );
187 sudo -u $apache_user php $mw/maintenance/update.php -q --quick; sleep 1
190 if command -v apt &>/dev/null; then
198 == Install Mediawiki Dependencies ==
200 The best way to get core dependencies is to install the mediawiki package itself. Nothing about it will get in the way of using a version from upstream.
202 [[mediawikiwiki:Main Page|Mediawiki Main Page]]: the beginning of the official docs.
204 [[mediawikiwiki:Manual:Installation_requirements|Manual:Installation_requirements]]: Overview of installation requirements.
206 Note, this guide needs a little adjustment before it will work with php7.0: make sure settings are still valid, update ini path.
211 # From here on out, exit if a command fails.
212 # This will prevent us from not noticing an important failure.
213 # We recommend setting this for the entire installation session.
214 # If you are running commands interactively, it might be best to
215 # put it in your ~/.bashrc temporarily.
217 trap 'echo "$0:$LINENO:error: \"$BASH_COMMAND\" returned $?" >&2' ERR
222 # https://www.mediawiki.org/wiki/Manual:Running_MediaWiki_on_Ubuntu
224 DEBIAN_FRONTEND=noninteractive apt-get install -y imagemagick curl
225 if apt-get install -s mediawiki &>/dev/null; then
226 # mediawiki is packaged in jessie backports.
227 DEBIAN_FRONTEND=noninteractive apt-get -y install php5-apcu mediawiki
229 # https://www.mediawiki.org/wiki/Manual:Installation_requirements
230 if apt-get install -s php7.0 &>/dev/null; then
231 # note, 7.0 is untested by the editor here, since it's not
232 # available in debian 8. it's listed as supported
233 # in the mediawiki page.
234 # noninteractive to avoid mysql password prompt.
235 DEBIAN_FRONTEND=noninteractive apt-get install -y apache2 \
236 default-mysql-server \
237 php7.0 php7.0-mysql libapache2-mod-php7.0 php7.0-xml \
238 php7.0-apcu php7.0-mbstring
240 # note: mbstring is recommended, but it's not available for php5 in
242 DEBIAN_FRONTEND=noninteractive apt-get install -y apache2 \
243 default-mysql-server \
244 php5 php5-mysql libapache2-mod-php5 php5-apcu
247 service apache2 restart
250 # fedora deps are missing a database, so some is translated from debian packages
251 yum -y install mediawiki ImageMagick php-mysqlnd php-pecl-apcu mariadb-server
253 systemctl restart mariadb.service
254 systemctl enable mariadb.service
255 systemctl enable httpd.service
256 systemctl restart httpd.service
260 # slightly different depending on if we already set the root pass
261 if echo exit|mysql -u root -p"$dbpass"; then
262 # answer interactive prompts:
263 # mysql root pass, change pass? no, remove anon users? (default, yes)
264 # disallow remote root (default, yes), reload? (default, yes)
265 echo -e "$dbpass\nn\n\n\n\n" | mysql_secure_installation
267 # I had 1 less newline at the start when doing ubuntu 14.04,
268 # compared to debian 8, so can't say this is especially portable.
269 # It won't hurt if it fails.
270 echo -e "\n\n$dbpass\n$dbpass\n\n\n\n\n" | mysql_secure_installation
275 '''Skippable notes'''
278 php[5]-mysqlnd is a faster mysql driver package, but the default in debian php-mysql, appparently because some non-mediawiki packages are not compatible with it. If you run into this issue, simply use the php-mysql package.
281 Additional packages rational
282 * ImageMagick is [https://www.mediawiki.org/wiki/Manual:Image_administration#Image_thumbnailing recommended].
283 * Gui install and [[mediawikiwiki:Manual:Cache]] recomend the apc package.
284 * Clamav for virus scanning of uploads is mentioned in the mediawiki manual. However, wikipedia doesn't seem to do it, so it doesn't seem like it's worth bothering. It also makes uploading a set of images take twice as long on broadband.
286 == Install Mediawiki ==
289 Here, we [[mediawikiwiki:Download_from_Git]], or reset our installation if it is already there, and create the wiki database. [[mediawikiwiki:Manual:Installing_MediaWiki]]
294 # this will just fail if it already exists which is fine
295 if [[ ! -e .git ]]; then
296 git clone https://gerrit.wikimedia.org/r/p/mediawiki/core.git .
298 # to see available branches: https://www.mediawiki.org/wiki/Version_lifecycle
301 git checkout -f origin/$mw_branch
303 # add some librejs support:
304 curl "https://iankelling.org/git/?p=mediawiki-librejs-patch;a=blob_plain;f=mediawiki-librejs-patch;hb=HEAD" | bash
305 # Get the php libraries wmf uses. Based on:
306 # https://www.mediawiki.org/wiki/Download_from_Git#Fetch_external_libraries
307 if [[ ! -e vendor/.git ]]; then
308 git clone https://gerrit.wikimedia.org/r/p/mediawiki/vendor.git
311 git checkout -f origin/$mw_branch
314 # Drop any previous database which may have been installed while testing.
315 # If upgrading, we should have a db backup which will get restored.
316 # https://www.mediawiki.org/wiki/Manual:Upgrading
317 mysql -u root -p$dbpass <<'EOF' ||:
318 drop database my_wiki;
321 php $mw/maintenance/install.php --pass $wikipass --scriptpath /w \
322 --dbuser root --dbpass $dbpass "$mwdescription" "$wikiuser"
324 # lock down the wiki to only the initial owner until anti-spam measures are put in place
325 # limit edits to registered users
326 $wgGroupPermissions['*']['edit'] = false;
327 # don't allow any account creation
328 $wgGroupPermissions['*']['createaccount'] = false;
333 Note: When testing, you may need to clear the apc cache to see changes take effect in the browser. Simplest solution is
334 just restart apache. http://stackoverflow.com/questions/911158/how-to-clear-apc-cache-entries
336 ''' Skippable Notes'''
338 If we wanted to reset our installation, but leave the extension repositories alone, alter the command above to be <code>git clean -fxd</code>
340 '''Rational for choosing git sources'''
342 Upstream vs distro packages. Upstream is responsive, and it's distributed within a single directory, so packaging does not integrate with the distro's filesystem. The only potential value would be less bugs by using stable versions, but we choose not to make that tradeoff.
344 Why use git over zip file releases? Mediawiki supports git usage through release branches which get post-release fixes. This means we can auto-update, get more granular fixes, easier to manage updates, and rollbacks.
346 == Configure Apache ==
348 Note, non-debian based installs: modify instructions below to use /etc/httpd/conf.d/$mwdomain.conf, and don't run a2ensite.
350 I use scripts I maintains separately to setup Let's Encrypt certificates and apache config: (url pending).
352 If you are doing a test setup on your local machine, you can make your domain resolve to your local test installation, then remove it later when you are done. Note, you will need non-local site to get Let's Encrypt certificates, and then transfer them locally, or disable ssl from the apache config (neither is covered here) and replace all instances of https in these instructions with http. Another option is to get a cheap 2 dollar domain for your test site.
354 '''Not for production:'''
355 <source lang="bash" type="example">
356 teeu /etc/hosts<<<"127.0.0.1 $mwdomain"
359 To not use my scripts, and still use Let's Encrypt: follow this doc page: https://letsencrypt.org/getting-started/. It's a little long winded, so I would boil it down to this:
361 '''Optional & requires additional steps:'''
362 <source lang="bash" type="example">
363 git clone https://github.com/certbot/certbot
365 ./certbot-auto apache
366 cd /etc/apache/sites-available
367 mv 000-default-le-ssl.conf $mwdomain.conf
368 rm ../sites-enabled/000-default-le-ssl.conf
369 # edit $mwdomain.conf, so documentroot is /var/www/$mwdomain/html
370 # and ServerName is $mwdomain
371 a2ensite $mwdomain.conf
373 Then, copy the input to apache-site below and insert it into the apache config.
375 Here, we use some scripts automate setting up the Let 's Encrypt cert and
381 git_site=https://iankelling.org/git
382 git clone $git_site/acme-tiny-wrapper
386 acme-tiny-wrapper/acme-tiny-wrapper -t $mwdomain
388 git clone $git_site/basic-https-conf
390 ServerAdmin $mw_email
392 # make the site's root url go to our main page
393 RewriteRule ^/?wiki(/.*)?\$ %{DOCUMENT_ROOT}/w/index.php [L]
394 # use short urls https://www.mediawiki.org/wiki/Manual:Short_URL
395 RewriteRule ^/*\$ %{DOCUMENT_ROOT}/w/index.php [L]
397 find -L $(readlink -f $mw) -name .htaccess \
398 | while read line; do
399 echo -e "<Directory ${line%/.htaccess}>\n $(< $line)\n</Directory>";
401 } | basic-https-conf/apache-site -r ${mw%/*} - $mwdomain
406 Now mediawiki should load in your browser at $mwdomain .
408 Allow proper search bots and internet archiver bots, via [[Mediawiki:Robots.txt]],
409 and install the default skin.
412 dd of=$mw/../robots.txt <<'EOF'
415 User-agent: ia_archiver
421 '''Skippable Notes'''
423 This section assumes we are redirecting www to a url without www.
425 [http://httpd.apache.org/docs/current/howto/htaccess.html Apache recommends] moving .htaccess rules into it's config for performance. So we look for .htaccess files from mediawiki and copy their contents into this config. In modern apache versions, we would have to explicitly set options like AllowOverride to allow .htaccess files to take effect.
427 == Mediawiki Settings ==
429 Overall reference: [[mediawikiwiki:Manual:Configuration_settings]].
431 Settings which the gui setup prompts for but aren't set by the automated install script.
434 \$wgServer = "https://$mwdomain";
435 \$wgDBserver = "localhost";
436 \$wgRightsUrl = "$mw_RightsUrl";
437 \$wgRightsText = "$mw_RightsText";
438 \$wgRightsIcon = "$mw_RightsIcon";
441 Settings asked by the gui setup which are different than the install script defaults. They different because the defaults are the most compatible and unobtrusive.
444 \$wgPasswordSender = "$mw_email";
445 \$wgEmergencyContact = "$mw_email";
446 \$wgEnotifUserTalk = true; # UPO
447 \$wgEnotifWatchlist = true; # UPO
448 \$wgMainCacheType = CACHE_ACCEL;
449 \$wgEnableUploads = true;
450 \$wgUseInstantCommons = true;
458 # from https://www.mediawiki.org/wiki/Manual:Short_URL
459 $wgArticlePath = "/wiki/$1";
461 # https://www.mediawiki.org/wiki/Manual:Combating_spam
462 # check that url if our precautions don't work
463 # not using nofollow is good practice, as long as we avoid spam.
464 $wgNoFollowLinks = false;
465 # Allow user customization.
466 $wgAllowUserCss = true;
467 # use imagemagick over GD
468 $wgUseImageMagick = true;
469 # manual says this is not production ready, I think that is mostly
470 # because they are using MobileFrontend extension instead, which gives
471 # an even cleaner more minimal view, I plan to try setting it up
472 # sometime but this seems like a very nice improvement for now.
473 $wgVectorResponsive = true;
477 # https://www.mediawiki.org/wiki/Manual:Configuring_file_uploads
478 # Increase from default of 2M to 100M.
479 # This will at least allow high res pics etc.
480 php_ini=$(php -r 'echo(php_ini_loaded_file());')
481 sed -i --follow-symlinks 's/^\(upload_max_filesize\|post_max_size\)\b.*/\1 = 100M/' $php_ini
483 service apache2 restart
485 systemctl restart httpd.service
488 # if you were to install as a normal user, you would need this for images
489 # sudo usermod -aG $apache_user $USER
491 # this doesn't propogate right away
492 chgrp -R $apache_user $mw/images
493 chmod -R g+w $mw/images
496 Style settings. Omit to use a different style.
500 #$wgFooterIcons = null;
502 # Make the toolbox go into the drop down.
504 if ! git remote show ian-kelling &>/dev/null; then
505 git remote add ian-kelling https://iankelling.org/git/forks/Vector
507 git fetch ian-kelling
508 git checkout ian-kelling/${mw_branch}-toolbox-in-dropdown
511 == Install and Configure Mediawiki Extensions ==
513 When installing extensions on a wiki with important content, backup first as a precaution.
515 ''' Extensions with no configuration needed '''
521 | [[mediawikiwiki:Extension:Cite|Extension:Cite]]
522 | Have references in footnotes*
524 | [[mediawikiwiki:Extension:CiteThisPage|Extension:CiteThisPage]]
525 | Ability to generate citations to pages in a variety of styles*
527 | [[mediawikiwiki:CheckUser|Extension:CheckUser]]
528 | Get ip addresses from inside mediawiki so you can ban users''
530 | [[mediawikiwiki:Extension:CSS|Extension:CSS]]
531 | Allows CSS stylesheets to be included in specific articles
533 | [[mediawikiwiki:Extension:Echo|Extension:Echo]]
534 | Notification subsystem for usage by other extensions
536 | [[mediawikiwiki:Extension:Gadgets|Extension:Gadgets]]
537 | UI extension system for users*
539 | [[mediawikiwiki:Extension:ImageMap|Extension:ImageMap]]
540 | Links for a region of an image*
542 | [[mediawikiwiki:Extension:Interwiki|Extension:Interwiki]]
543 | Tool for nice links to other wikis*
545 | [[mediawikiwiki:Extension:News|Extension:News]]
546 | Embed or rss recent changes
548 | [[mediawikiwiki:Extension:Nuke|Extension:Nuke]]
549 | Mass delete of pages, in the case of spam*
551 | [[mediawikiwiki:Extension:ParserFunctions|Extension:ParserFunctions]]
552 | Useful for templates*
554 | [[mediawikiwiki:Extension:Poem|Extension:Poem]]
555 | Useful for formatting things various ways*
557 | [[mediawikiwiki:Extension:Renameuser|Extension:Renameuser]]
558 | Allows bureaucrats to rename user accounts*
560 | [[mediawikiwiki:Extension:SyntaxHighlight_GeSHi|Extension:SyntaxHighlight_GeSHi]]
561 | Source code highlighting*
563 | [[mediawikiwiki:Extension:Variables|Extension:Variables]]
564 | Define per-page variables
567 <nowiki>*</nowiki> = Comes with the MediaWiki default download.
570 mw-ext Cite CiteThisPage CheckUser CSS Echo Gadgets ImageMap Interwiki News \
571 Nuke ParserFunctions Poem Renameuser SyntaxHighlight_GeSHi Variables
575 ''' [[mediawikiwiki:Extension:AntiSpoof|Extension:AntiSpoof]]: Disallow usernames with unicode trickery to look like existing names'''
579 # recommended setup script to account for existing users
580 sudo -u $apache_user php $mw/extensions/AntiSpoof/maintenance/batchAntiSpoof.php
584 '''[[mediawikiwiki:Extension:Wikidiff2|Extension:Wikidiff2]]: Faster and international character supported page diffs'''
586 I used packaged version since this is a c++ and probably not very tied to the Mediawiki version. This isn't packaged in fedora, haven't gotten around to testing and adding the code to compile it for fedora.
589 apt-get -y install php-wikidiff2
591 $wgExternalDiffEngine = 'wikidiff2';
593 dir=$(dirname $(php -r 'echo(php_ini_loaded_file());'))/../apache2/conf.d
594 ln -sf ../../mods-available/wikidiff2.ini $dir
595 service apache2 restart
600 ''' [[mediawikiwiki:Extension:Math|Extension:Math]] Display equations'''
604 # php5-curl according to Math readme
607 if ! apt-get -s install $curl_pkg &>/dev/null; then
610 apt-get -y install latex-cjk-all texlive-latex-extra texlive-latex-base \
611 ghostscript imagemagick ocaml $curl_pkg make
613 # todo, php5-curl equivalent on fedora
614 yum -y install texlive-cjk ghostscript ImageMagick texlive ocaml
616 service apache2 restart
618 cd $mw/extensions/Math/math; make # makes texvc
619 cd $mw/extensions/Math/texvccheck; make
622 # Enable MathJax as rendering option
623 $wgUseMathJax = true;
624 # Enable LaTeXML as rendering option
625 $wgMathValidModes[] = 'latexml';
626 # Set LaTeXML as default rendering option, because it is nicest
627 $wgDefaultUserOptions['math'] = 'latexml';
631 '''Skippable notes'''
633 There is no current list of package depencies so I took dependencies from mediawiki-math package in Debian 7. Fedora didn't have a mediawik math package, so I just translated from debian. Ocaml is for math png rendering, as backup option to the nicer looking LatexML and MathJax. Debian has texvc package, but it didn't work right for me, plus it required additional configuration in mediawiki settings.
636 ''' [[mediawikiwiki:Extension:SpamBlacklist|Extension:SpamBlacklist]]: Import/create IP blacklists, mainly for spam'''
638 Comes with MediaWiki.
642 if ! grep -F '$wgSpamBlacklistFiles = array(' $mwc &>/dev/null; then
644 $wgEnableDnsBlacklist = true;
645 $wgDnsBlacklistUrls = array( 'xbl.spamhaus.org', 'dnsbl.tornevall.org' );
647 ini_set( 'pcre.backtrack_limit', '10M' );
648 $wgSpamBlacklistFiles = array(
649 "[[m:Spam blacklist]]",
650 "http://en.wikipedia.org/wiki/MediaWiki:Spam-blacklist"
656 ''' [[mediawikiwiki:Extension:TitleBlacklist|Extension:TitleBlacklist]]: Anti-spam '''
658 Comes with Mediawiki.
661 mw-ext TitleBlacklist
662 if ! grep -F '$wgTitleBlacklistSources = array(' $mwc &>/dev/null; then
664 $wgTitleBlacklistSources = array(
667 'src' => 'MediaWiki:Titleblacklist',
671 'src' => 'http://meta.wikimedia.org/w/index.php?title=Title_blacklist&action=raw',
678 ''' [[mediawikiwiki:Extension:WikiEditor|Extension:WikiEditor]]: Editing box extras and a fast preview tab '''
680 Comes with MediaWiki.
685 # Enable Wikieditor by default
686 $wgDefaultUserOptions['usebetatoolbar'] = 1;
687 $wgDefaultUserOptions['usebetatoolbar-cgd'] = 1;
689 # Display the Preview and Changes tabs
690 $wgDefaultUserOptions['wikieditor-preview'] = 1;
694 ''' [[mediawikiwiki:CategoryTree|Extension:CategoryTree]]: Enables making nice outlines of pages in a category'''
698 # Mediawiki setting dependency for CategoryTree
703 ''' [[mediawikiwiki:Extension:AbuseFilter|Extension:AbuseFilter]]: Complex abilities to stop abuse '''
705 Used by big wiki sites. As a smaller site, we won't use it much, but it's good to have. It's page suggests a few defaults:
709 $wgGroupPermissions['sysop']['abusefilter-modify'] = true;
710 $wgGroupPermissions['*']['abusefilter-log-detail'] = true;
711 $wgGroupPermissions['*']['abusefilter-view'] = true;
712 $wgGroupPermissions['*']['abusefilter-log'] = true;
713 $wgGroupPermissions['sysop']['abusefilter-private'] = true;
714 $wgGroupPermissions['sysop']['abusefilter-modify-restricted'] = true;
715 $wgGroupPermissions['sysop']['abusefilter-revert'] = true;
719 '''[[mediawikiwiki:Extension:ConfirmEdit|Extension:ConfirmEdit]]: Custom Captcha.'''
721 Uses captchaArray defined in mw_vars. Comes with MediaWiki.
727 wfLoadExtension( 'ConfirmEdit/QuestyCaptcha' );
728 $wgCaptchaClass = 'QuestyCaptcha';
729 # only captcha on registration
730 $wgGroupPermissions['user' ]['skipcaptcha'] = true;
731 $wgGroupPermissions['autoconfirmed']['skipcaptcha'] = true;
733 if ! grep -Fx 'foreach ( $localSettingsQuestyQuestions as $key => $value ) {' $mwc; then
735 foreach ( $localSettingsQuestyQuestions as $key => $value ) {
736 $wgCaptchaQuestions[] = array( 'question' => $key, 'answer' => $value );
742 Enable account creation that we initially disabled.
744 sed -i --follow-symlinks "/\\\$wgGroupPermissions\\['\\*'\\]\\['createaccount'\\] = false;/d" $mwc
747 == Additional Configuration with Pywikibot ==
749 There are quite a few [[mediawikiwiki:Help:Namespaces|special pages]] which act like variables to configure special wiki content and style. A big part of this wiki's style is configured in this section. We use Pywikibot to automate editing those pages.
752 '''Pywikibot Install'''
754 [[mediawikiwiki:Manual:Pywikibot/Installation|Manual:Pywikibot/Installation]]
758 if [[ ! -e ~/pywikibot/.git ]]; then
759 git clone --recursive \
760 https://gerrit.wikimedia.org/r/pywikibot/core.git ~/pywikibot
769 '''Pywikibot Configuration'''
771 Relevent docs: [[mediawikiwiki:Manual:Pywikibot/Use_on_non-WMF_wikis|Manual:Pywikibot/Use_on_non-WMF_wikis]], [[mediawikiwiki:Manual:Pywikibot/Quick_Start_Guide|Manual:Pywikibot/Quick_Start_Guide]]
776 dd of=user-config.py <<EOF
778 usernames["$mwfamily"]['en'] = u'$wikiuser'
780 console_encoding = 'utf-8'
781 password_file = "secretsfile"
784 dd of=secretsfile <<EOF
785 ("$wikiuser", "$wikipass")
788 # it won't overrwrite an existing file. Remove if if one exists
789 rm -f pywikibot/families/${mwfamily}_family.py
791 apt-get install -y python-requests
793 yum -y install python-requests
796 python generate_family_file.py https://$mwdomain/wiki/Main_Page "$mwfamily"
798 # Note, this needed only for ssl site
799 tee -a pywikibot/families/${mwfamily}_family.py<<'EOF'
800 def protocol(self, code):
806 '''Pywikibot Script'''
808 This will take a full minute or so because the bot waits a few seconds between edits. Useful doc: [[mediawikiwiki:Pywikipediabot/Create_your_own_script]].
813 dd of=scripts/${mwfamily}_setup.py<<EOF
817 site = pywikibot.Site()
819 page = pywikibot.Page(site, p)
821 #force is for some anti-bot thing, not necessary in my testing, but might as well include it
822 page.save(force=True)
824 # Small/medium noncommercial wiki should be fine with no privacy policy
825 # based on https://www.mediawiki.org/wiki/Manual:Footer
826 x("MediaWiki:Privacy")
828 # licenses for uploads. Modified from the mediawiki's wiki
829 x("MediaWiki:Licenses", u"""* Same as this wiki's text (preferred)
830 ** CC BY-SA or GFDL| Creative Commons Attribution ShareAlike or GNU Free Documentation License
832 ** Unknown_copyright|I don't know exactly
833 ** PD|PD: public domain
834 ** CC BY|Creative Commons Attribution
835 ** CC BY-SA|Creative Commons Attribution ShareAlike
836 ** GFDL|GFDL: GNU Free Documentation License
837 ** GPL|GPL: GNU General Public License
838 ** LGPL|LGPL: GNU Lesser General Public License""")
839 x("MediaWiki:Copyright", '$mw_license')
840 x("MediaWiki:Mainpage-description", "$mwdescription")
844 # The rest of the settings are for the site style
846 # Remove various clutter
847 x("MediaWiki:Lastmodifiedat")
848 x("MediaWiki:Disclaimers")
849 x("MediaWiki:Viewcount")
850 x("MediaWiki:Aboutsite")
851 # remove these lines from sidebar
852 # ** recentchanges-url|recentchanges
853 # ** randompage-url|randompage
855 x("MediaWiki:Sidebar", """* navigation
856 ** mainpage|mainpage-description
862 # helpfull doc: https://www.mediawiki.org/wiki/Manual:Interface/Sidebar
863 x("mediawiki:Common.css", """/* adjust sidebar to just be home link and up top */
864 /* panel width increased to fit full wiki name. */
865 div#mw-panel { top: 10px; padding-top: 0em; width: 20em }
866 div#footer, #mw-head-base, div#content { margin-left: 1em; }
867 #left-navigation { margin-left: 1em; }
870 /* logo, and toolbar hidden */
871 #p-logo, #p-tb.portal {
875 /* make the font size smaller for the misc stuff */
883 div#mw-content-text {
889 # this can spam a warning, so uniq it
890 python pwb.py ${mwfamily}_setup |& uniq
894 ''' Skippable Notes '''
896 The docs suggest manually entering the pass with python pwb.py login.py, then it should stay logged in. That didn't work for me, and anyways, we automation, so we use secrets file method.
898 Family name, and all its duplicattions documented as supposed to be $wgSitename, but it works fine using any name.
900 == Automatic Backups ==
902 Here we will have a daily cronjob where a backup host sshs to the mediawiki host, makes a backup then copies it back. Copy ~/mw_vars to the backup host at /root/mw_vars. Setup passwordless ssh from the backup host to the mediawiki host. Then run this code on the backup host. This will make a versioned backup of the wiki to ~/backup.
904 <source lang="bash" type="backup">
905 backup_script=/etc/cron.daily/mediawiki_backup
906 sudo dd of=$backup_script <<'EOFOUTER'
908 # if we get an error, keep going but return it at the end
910 trap 'last_error=$?' ERR
912 # No strict because the host is likely not named the same as
914 ssh="ssh -oStrictHostKeyChecking=no"
915 logfile=/var/log/${mwdomain}_backup.log
917 echo "#### starting backup at $(date) ####"
918 $ssh root@$mwdomain <<ENDSSH
921 \$wgReadOnly = 'Dumping Database, Access will be restored shortly';
923 mkdir -p ~/wiki_backups
924 mysqldump -p$dbpass --default-character-set=binary my_wiki > ~/wiki_backups/wiki_db_backup
925 sed -i '\$ d' $mwc # delete read only setting
927 # add no strict option to the defaults
929 rdiff() { rdiff-backup --remote-schema "$ssh -C %s rdiff-backup --server" "$@"; }
931 rdiff root@$mwdomain::/root/wiki_backups ~/backup/${mwdomain}_wiki_db_backup
932 rdiff root@$mwdomain::$mw ~/backup/${mwdomain}_wiki_file_backup
934 echo "=== ending backup at $(date) ===="
936 if [[ $last_error != 0 ]]; then
937 echo "backup for $mwdomain failed. See $logfile"
942 sudo chmod +x $backup_script
945 '''Optional & requires additional steps'''
947 If you are like most people and don't use the old-school mail spool, setup the backup system to send mail externally so you are notified if it fails. For examples of how to do this, [http://unix.stackexchange.com/questions/36982/can-i-set-up-system-mail-to-use-an-external-smtp-server stackoverflow], [https://iankelling.org/git/?p=ian-specific/distro-setup;a=blob;f=mail-setup;hb=HEAD script I use].
949 == Restoring Backups ==
951 '''Whenever you implement a backup system, you should test that restoring the backup works.'''
953 You ''should'' be able to restore your wiki to a new machine by repeating all install steps, then restoring the database and the images directory. I've done this many times. However, we backup the entire Mediawiki directory in case you forget to record a step or some corner case happens. Since most people don't record the steps they took to setup Mediawiki, this is also the officially recommended method. In the code below we restore only the database and images folder from the full backup. You can try this after setting up a wiki from scratch. If it doesn't work, you know your fresh setup is not replicating your backed up wiki correctly. In that case, you can fall back to doing a full restore by copying the full directory instead of just the images. See [[mediawikiwiki:Manual:Restoring a wiki from backup]] if you run into any problems.
955 To test a backup restore:
956 # Do a backup of your wiki with some content in it, as described in the previous section
957 # Move your mediawiki install directory, or setup Mediawiki on a new machine
958 # Re-execute the mediawiki install steps
959 # Change REPLACE_ME in the code below (as in the backup section so you get the right variables),
960 # Execute the code on the backup machine.
963 <source lang="bash" type="example">
966 restore="rdiff-backup --force -r now"
967 $restore ~/backup/${mwdomain}_wiki_file_backup /tmp/wiki_file_restore
968 $restore ~/backup/${mwdomain}_wiki_db_backup /tmp/wiki_db_restore
969 o=-oStrictHostKeyChecking=no
970 scp $o -r /tmp/wiki_file_restore/images/* root@$mwdomain:$mw/images
971 scp $o -r /tmp/wiki_db_restore root@$mwdomain:/tmp
972 ssh $o root@$mwdomain <<EOF
974 chmod -R g+w $mw/images
975 chgrp -R www-data $mw/images
976 mysql -u root -p$dbpass my_wiki < /tmp/wiki_db_restore/wiki_db_backup
977 php $mw/maintenance/update.php
981 Then browse to your wiki and see if everything appears to work.
985 Subscribe to get release and security announcements [https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce MediaWiki-announce].
987 For updates, we simply git pull all the repos, then run the maintenance script. This should be done after a backup. We recommend automatic updates to get security fixes and since not much is changing on the release branch. In this example, we update at 5 am daily (1 hour after the automatic backup example).
989 Major version upgrades should be done manually, and it is recommended to use a new installation directory and the same procedure as for backup & restore. Official reference: [[mediawikiwiki:Manual:Upgrading|Manual:Upgrading]]
991 Minor updates script:
993 s=/etc/cron.daily/mediawiki_update
1000 [[ -d $dir ]] || return 1
1002 branch=$(git describe --all)
1003 branch=${branch#remotes/}
1005 new_head=$(git rev-parse $branch)
1006 log=$(git log HEAD..$new_head)
1007 if [[ ! $log ]]; then
1012 git checkout -qf $new_head
1016 for dir in extensions/* skins/* vendor; do
1020 curl "https://iankelling.org/git/?p=mediawiki-librejs-patch;a=blob_plain;f=mediawiki-librejs-patch;hb=HEAD" | bash
1022 php $mw/maintenance/update.php -q --quick
1027 == Upgrading Major Versions ==
1029 Reference documentation is at [[mediawikiwiki:Manual:Upgrading]]
1033 # Read the "Upgrade notices for MediaWiki administrators" on the upgrade version and any skipped versions at [[mediawikiwiki:Version_lifecycle]].
1034 # Setup a blank test wiki with the new version.
1035 # Backup the old database, restore it to the new wiki, run php maintenance/update.php.
1036 # If everything looks good, repeat and replace the old wiki with the new one.
1040 There is a balance between effective anti-spam measures and blocking/annoying contributors. Mediawiki documentation on how to combat spam, is not very good, but it has improved over time: [https://www.mediawiki.org/wiki/Manual:Combating_spam manual: Combating Spam]. It's possible for a spammer to quickly make thousands of edits, and there is no good documentation on purging lots of spam, so you should have a good strategy up front. My current strategy is 3 fold, and is limited to small/medium wiki's:
1042 * Find new spam quickly, revert it & ban the user.
1043 ** Watch, and get notified of changes on all primary content pages: Special:Preferences, Bottom of the page, set an email address, then turn on "Email me also for minor edits of pages and files."
1044 ** Use a rss/atom feed reader, and subscribe to recent changes across the wiki. Newer browsers have an rss feed subscribe button, you can click after going to Special:RecentChanges. If that is not available, you can construct the proper url based on [https://meta.wikimedia.org/wiki/Help:Recent_changes#Web_feed these instructions].
1045 * Require registration to edit, and a custom captcha question on registration.
1046 * Install all non-user inhibiting anti-spam extensions / settings that take a reasonable amount of time to figure out.
1048 == Choosing Extensions ==
1050 Mediawiki.org has pages for ~5200 extensions. Mediawiki maintains ~700 extensions [http://git.wikimedia.org/tree/mediawiki%2Fextensions.git in it's git repo]. Wikipedia uses [https://en.wikipedia.org/wiki/Special:Version over 100 extensions]. Major distributors package [[mediawikiwiki:Comparison_of_extensions_in_distributions| ~36 extensions]]. We looked closely at the distributor's and briefly at the Mediawiki repo extensions. We haven't found any other useful list or recommendations.
1052 Here are brief descriptions of extensions that are part of distributions and why they were rejected for this wiki.
1054 {| class="wikitable"
1056 | '''Footnote''' || deprecated in newer versions
1058 | '''InputBox''' || Add html forms to pages. Can't imagine using it. Would install if I did.
1060 | '''LocalisationUpdate'''|| update localization only. I'm fine updating all of mediawiki, there aren't many updates.
1062 | '''NewestPages''' || A page creation history that doesn't expire like recent-changes. Meh
1064 | '''NewUserNotif''' || Send me a notification when a user registers. Seems like an excessive notification.
1066 | '''Openid''' || Poor UI. 2 pages & 2 links <login> <login with openid> which is confusing & ugly.
1068 | '''Pdfhandler''' || Gallery of pages from a pdf file. Can't imagine using it. Would install if I did.
1070 | '''RSSReader''' || Embed an rss feed. Can't imagine using it. Would install if I did.
1072 | '''Semantic''' || Seems like a lot of trouble around analyzing kinds of data which my wiki will not have.
1074 | '''Validator''' || dependency of of semantic
1080 ''' Web Analytics Software '''
1082 I do not recommend using google analytics: it's proprietary software and gives private information of your website visitors to google for them to make money. Piwik has the best features and I recommend it, but I use goaccess because it is simpler to manage and good enough.
1084 ''' Mediawiki Documentation Quality '''
1086 Overall the documentation is good, but like wikipedia, it depends.
1088 The closer a topic is to core functionality and commonly used features, the better the documentation is likely to be. Wikimedia Foundation (WMF) has a competing priority of being a good upstream to mediawiki users and being good for their own sites. That, plus the multitude of unconnected extension developers, and official documentation is sometimes neglected in favor of bug reports, readme files, comments, code, and unpublished knowledge. User's documentation edits vary in quality, and often aren't reviewed by anyone. If you run into an issue, try viewing/diffing the most recent version of a page by the last few editors.
1090 One issue is that mediawiki.org needs a lot of organizing, deleting, and verifying of material, and that is relatively unpopular, tedious, and sometimes difficult work. The discussion pages of mediawiki.org are a wasteland of unanswered questions and outdated conversations, which is [https://www.mediawiki.org/wiki/Help:Talk_pages poor form] for a wiki. However, if you communicate well, you can get great help from their [https://www.mediawiki.org/wiki/Communication support forum, irc, and mailing list].
1093 '''Bash here documents, EOF vs 'EOF' '''
1095 Here documents are used throughout this page, some people may not be aware of a small but important syntax. When the delimiter is quoted, as in <<'EOF', then the contents of the here document are exactly verbatim. Otherwise $ and ` are expanded as in bash, and must be escaped by prefixing them with \, which itself must then also be escaped to be used literally.
1098 ''' Mediawiki automation tools survey 7/2014 '''
1101 * https://github.com/ianweller/mw
1102 * http://search.cpan.org/~markj/WWW-Mediawiki-Client/bin/mvs
1103 * https://github.com/alexz-enwp/wikitools 3000 lines of code, no response to a bug reports in 2/2014
1105 Getting basic maintenance
1106 * https://github.com/mwclient/mwclient 2000 lines of code
1108 Actively developed, used by wikimedia foundation a lot.
1109 * [[mediawikiwiki:Manual:Pywikibot]]
1112 ''' Troubleshooting Errors '''
1114 If mediawiki fails to load, or shows an error in the browser, enable some settings and it will print much more useful information. [[mediawikiwiki:Manual:How to debug]]
1118 This page and this wiki is licensed under cc-by-sa 4.0.
1119 This means the code is compatible with gplv3.
1121 == todo list for this page ==
1123 * Get Visual editor extension.
1124 * Don't require registration for edits