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 For debian jessie with backports:
42 apt-get install --install-suggests jessie-backports certbot
44 For other distros, follow instructions at [https://certbot.eff.org/ certbot.eff.org].
48 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.
50 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]]
52 == Setup Guide Configuration ==
55 # Save the code in this section to a file (~/mw_vars is suggested)
56 # Source it at the beginning of scripts containing later commands
57 # Source it from your .bashrc file while you are setting up Mediawiki
59 '''Requires customization:'''
60 <source lang="bash" type="example">
61 # Replace REPLACE_ME as appropriate
63 export mwdescription="REPLACE_ME" # eg. Opinionated Free Software Wiki
65 # username/pass of the first wiki admin user
66 export wikiuser="REPLACE_ME"
67 export wikipass=REPLACE_ME
69 # root & user password for the mysql database
70 export dbpass=REPLACE_ME
72 export mwdomain=REPLACE_ME # domain name. for this site, it's ofswiki.org
74 # customize these questions. Try not to have the answer be a word in the question.
76 if ! grep -Fx '$localSettingsQuestyQuestions = array (' $mwc; then
78 $localSettingsQuestyQuestions = array (
79 "What is the name of the wiki software this site (and wikipedia) uses?" => "Mediawiki",
80 "REPLACE_ME with a question" => "REPLACE_ME with an answer"
86 # The rest of this section will work fine with no changes.
88 # git branch for mediawiki + extensions. See intro for supported versions.
89 # branch names: https://git.wikimedia.org/branches/mediawiki%2Fcore.git
90 export mw_branch=REL1_28
92 # As set by gui installer when choosing cc by sa.
93 export mw_RightsUrl='https://creativecommons.org/licenses/by-sa/4.0/'
94 export mw_RightsText='Creative Commons Attribution-ShareAlike'
95 export mw_RightsIcon='$wgScriptPath/resources/assets/licenses/cc-by-sa.png'
97 # Alphanumeric site name for pywikibot.
98 # Here we use the domain minus the dots, which should work fine without changing.
99 export mwfamily=${mwdomain//./}
100 # install path for mediawiki. This should work fine.
101 export mw=/var/www/$mwdomain/html/w
104 # wiki sender address / wiki & wiki server contact email.
105 # see email section for more info on email
106 export mw_email="admin@$mwdomain"
109 mwc="$mw/LocalSettings.php"
112 == Download this page and run it ==
114 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.
116 ''' Requires manual step: inspect output file: /tmp/mw-setup, then run it'''
117 <source lang="bash" type="example">
118 start=' *<source lang="bash"> *'
120 ruby <<'EOF' | sed -rn "/^$start$/,/^$end$/{s/^$start|$end$/# \0/;p} > /tmp/mw-setup"
122 puts JSON.parse(`curl 'https://ofswiki.org/w/api.php?\
123 action=query&titles=Mediawiki_Setup_Guide&prop=revisions&rvprop=content&\
124 format=json'`.chomp)['query']['pages'].values[0]['revisions'][0]['*']
126 chmod +x /tmp/mw-setup
129 == Required Bash Functions ==
131 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.
134 # identify if this is a debian based distro
135 isdeb() { command -v apt &>/dev/null; }
136 # tee unique. append each stdin line if it does not exist in the file
140 for line in "${MAPFILE[@]}"; do
141 grep -xFq "$line" "$1" &>/dev/null || tee -a "$1" <<<"$line"
145 # get and reset an extension/skin repository, and enable it
148 local original_pwd="$PWD"
150 local re='[^/]*/[^/]*$' # last 2 parts of path
151 [[ $url =~ $re ]] ||:
152 target=$mw/${BASH_REMATCH[0]}
153 if [[ ! -e $target/.git ]]; then
154 git clone $url $target
156 if ! cd $target; then
157 echo "mw-ext error: failed cd $target";
161 git checkout -qf origin/$mw_branch || git checkout -qf origin/master
169 mw-clone https://gerrit.wikimedia.org/r/p/mediawiki/extensions/$ext
170 if [[ -e $mw/extensions/$ext/extension.json ]]; then
171 # new style extension
173 wfLoadExtension( '$ext' );
177 require_once( "\$IP/extensions/$ext/$ext.php" );
181 # --quick is quicker than default flags,
182 # but still add a sleep to make sure everything works right
183 sudo -u $apache_user php $mw/maintenance/update.php -q --quick; sleep 1
187 mw-clone https://gerrit.wikimedia.org/r/p/mediawiki/skins/$skin
188 sed -i --follow-symlinks '/^wfLoadSkin/d' $mwc
189 sed -i --follow-symlinks '/^\$wgDefaultSkin/d' $mwc
191 \$wgDefaultSkin = "${skin,,*}";
192 wfLoadSkin( '$skin' );
194 sudo -u $apache_user php $mw/maintenance/update.php -q --quick; sleep 1
197 if command -v apt &>/dev/null; then
205 == Install Mediawiki Dependencies ==
207 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.
209 [[mediawikiwiki:Main Page|Mediawiki Main Page]]: the beginning of the official docs.
211 [[mediawikiwiki:Manual:Installation_requirements|Manual:Installation_requirements]]: Overview of installation requirements.
213 Note, this guide needs a little adjustment before it will work with php7.0: make sure settings are still valid, update ini path.
218 # From here on out, exit if a command fails.
219 # This will prevent us from not noticing an important failure.
220 # We recommend setting this for the entire installation session.
221 # If you are running commands interactively, it might be best to
222 # put it in your ~/.bashrc temporarily.
224 trap 'echo "$0:$LINENO:error: \"$BASH_COMMAND\" returned $?" >&2' ERR
229 # https://www.mediawiki.org/wiki/Manual:Running_MediaWiki_on_Ubuntu
231 DEBIAN_FRONTEND=noninteractive apt-get install -y imagemagick curl
232 if apt-get install -s mediawiki &>/dev/null; then
233 # mediawiki is packaged in jessie backports.
234 DEBIAN_FRONTEND=noninteractive apt-get -y install php5-apcu mediawiki
236 # https://www.mediawiki.org/wiki/Manual:Installation_requirements
237 if apt-get install -s php7.0 &>/dev/null; then
238 # note, 7.0 is untested by the editor here, since it's not
239 # available in debian 8. it's listed as supported
240 # in the mediawiki page.
241 # noninteractive to avoid mysql password prompt.
242 DEBIAN_FRONTEND=noninteractive apt-get install -y apache2 \
243 default-mysql-server \
244 php7.0 php7.0-mysql libapache2-mod-php7.0 php7.0-xml \
245 php7.0-apcu php7.0-mbstring
247 # note: mbstring is recommended, but it's not available for php5 in
249 DEBIAN_FRONTEND=noninteractive apt-get install -y apache2 \
250 default-mysql-server \
251 php5 php5-mysql libapache2-mod-php5 php5-apcu
254 service apache2 restart
257 # fedora deps are missing a database, so some is translated from debian packages
258 yum -y install mediawiki ImageMagick php-mysqlnd php-pecl-apcu mariadb-server
260 systemctl restart mariadb.service
261 systemctl enable mariadb.service
262 systemctl enable httpd.service
263 systemctl restart httpd.service
267 # skip if we already set the root pass
268 if ! echo exit|mysql -uroot "-p$dbpass"; then
269 # Note: we set a root password here, but in debian 9+, it is ignored;
270 # only the local user root can login, and a password is silently ignored.
271 # We answer these interactive prompts:
272 # Enter current password for root (enter for none):
273 # Set root password? [Y/n]
275 # Re-enter new password:
276 # Remove anonymous users? [Y/n]
277 # Disallow root login remotely? [Y/n]
278 # Remove test database and access to it? [Y/n]
279 # Reload privilege tables now? [Y/n]
280 # Note, I had 1 less newline at the start when doing ubuntu 14.04,
281 # compared to debian 8, so can't say this is especially portable.
282 echo -e "\n\n$dbpass\n$dbpass\n\n\n\n\n" | mysql_secure_installation
284 mysql -uroot "-p$dbpass" <<EOF
285 GRANT ALL PRIVILEGES ON my_wiki.* TO 'wikiuser'@'localhost' IDENTIFIED BY '$dbpass';
290 '''Skippable notes'''
293 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.
296 Additional packages rational
297 * ImageMagick is [https://www.mediawiki.org/wiki/Manual:Image_administration#Image_thumbnailing recommended].
298 * Gui install and [[mediawikiwiki:Manual:Cache]] recomend the apc package.
299 * 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.
301 == Install Mediawiki ==
304 Here, we [[mediawikiwiki:Download_from_Git]], or reset our installation if it is already there, and create the wiki database. [[mediawikiwiki:Manual:Installing_MediaWiki]]
309 # this will just fail if it already exists which is fine
310 if [[ ! -e .git ]]; then
311 git clone https://gerrit.wikimedia.org/r/p/mediawiki/core.git .
313 # to see available branches: https://www.mediawiki.org/wiki/Version_lifecycle
316 git checkout -f origin/$mw_branch
318 # apply librejs patch
319 curl "https://iankelling.org/git/?p=mediawiki-librejs-patch;a=blob_plain;f=mediawiki-1.28-librejs.patch;hb=HEAD" | patch -r - -N -p1
320 # Get the php libraries wmf uses. Based on:
321 # https://www.mediawiki.org/wiki/Download_from_Git#Fetch_external_libraries
322 if [[ ! -e vendor/.git ]]; then
323 git clone https://gerrit.wikimedia.org/r/p/mediawiki/vendor.git
326 git checkout -f origin/$mw_branch
329 # Drop any previous database which may have been installed while testing.
330 # If upgrading, we should have a db backup which will get restored.
331 # https://www.mediawiki.org/wiki/Manual:Upgrading
332 mysql -uroot "-p$dbpass" <<'EOF' ||:
333 drop database my_wiki;
336 php $mw/maintenance/install.php --pass $wikipass --scriptpath /w \
337 --dbuser wikiuser --dbpass $dbpass "$mwdescription" "$wikiuser"
339 # lock down the wiki to only the initial owner until anti-spam measures are put in place
340 # limit edits to registered users
341 $wgGroupPermissions['*']['edit'] = false;
342 # don't allow any account creation
343 $wgGroupPermissions['*']['createaccount'] = false;
348 Note: When testing, you may need to clear the apc cache to see changes take effect in the browser. Simplest solution is
349 just restart apache. http://stackoverflow.com/questions/911158/how-to-clear-apc-cache-entries
351 ''' Skippable Notes'''
353 If we wanted to reset our installation, but leave the extension repositories alone, alter the command above to be <code>git clean -fxd</code>
355 '''Rational for choosing git sources'''
357 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.
359 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.
361 == Configure Apache ==
363 Note, non-debian based installs: modify instructions below to use /etc/httpd/conf.d/$mwdomain.conf, and don't run a2ensite.
365 I use scripts I maintains separately to setup Let's Encrypt certificates and apache config: (url pending).
367 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.
369 '''Not for production:'''
370 <source lang="bash" type="example">
371 teeu /etc/hosts<<<"127.0.0.1 $mwdomain"
374 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:
376 '''Optional & requires additional steps:'''
377 <source lang="bash" type="example">
378 git clone https://github.com/certbot/certbot
380 ./certbot-auto apache
381 cd /etc/apache/sites-available
382 mv 000-default-le-ssl.conf $mwdomain.conf
383 rm ../sites-enabled/000-default-le-ssl.conf
384 # edit $mwdomain.conf, so documentroot is /var/www/$mwdomain/html
385 # and ServerName is $mwdomain
386 a2ensite $mwdomain.conf
388 Then, copy the input to apache-site below and insert it into the apache config.
390 Here, we use some scripts automate setting up the Let 's Encrypt cert and
396 git_site=https://iankelling.org/git
400 git clone $git_site/basic-https-conf
401 basic-https-conf/web-conf -r ${mw%/*} - apache2 $mwdomain <<EOF
402 ServerAdmin $mw_email
404 # make the site's root url go to our main page
405 RewriteRule ^/?wiki(/.*)?\$ %{DOCUMENT_ROOT}/w/index.php [L]
406 # use short urls https://www.mediawiki.org/wiki/Manual:Short_URL
407 RewriteRule ^/*\$ %{DOCUMENT_ROOT}/w/index.php [L]
409 find -L $(readlink -f $mw) -name .htaccess \
410 | while read line; do
411 echo -e "<Directory ${line%/.htaccess}>\n $(< $line)\n</Directory>";
417 Now mediawiki should load in your browser at $mwdomain .
419 Allow proper search bots and internet archiver bots, via [[Mediawiki:Robots.txt]],
420 and install the default skin.
423 dd of=$mw/../robots.txt <<'EOF'
426 User-agent: ia_archiver
432 '''Skippable Notes'''
434 This section assumes we are redirecting www to a url without www.
436 [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.
438 == Mediawiki Settings ==
440 Overall reference: [[mediawikiwiki:Manual:Configuration_settings]].
442 Settings which the gui setup prompts for but aren't set by the automated install script.
445 \$wgServer = "https://$mwdomain";
446 \$wgDBserver = "localhost";
447 \$wgRightsUrl = "$mw_RightsUrl";
448 \$wgRightsText = "$mw_RightsText";
449 \$wgRightsIcon = "$mw_RightsIcon";
452 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.
455 \$wgPasswordSender = "$mw_email";
456 \$wgEmergencyContact = "$mw_email";
457 \$wgEnotifUserTalk = true; # UPO
458 \$wgEnotifWatchlist = true; # UPO
459 \$wgMainCacheType = CACHE_ACCEL;
460 \$wgEnableUploads = true;
461 \$wgUseInstantCommons = true;
469 # from https://www.mediawiki.org/wiki/Manual:Short_URL
470 $wgArticlePath = "/wiki/$1";
472 # https://www.mediawiki.org/wiki/Manual:Combating_spam
473 # check that url if our precautions don't work
474 # not using nofollow is good practice, as long as we avoid spam.
475 $wgNoFollowLinks = false;
476 # Allow user customization.
477 $wgAllowUserCss = true;
478 # use imagemagick over GD
479 $wgUseImageMagick = true;
480 # manual says this is not production ready, I think that is mostly
481 # because they are using MobileFrontend extension instead, which gives
482 # an even cleaner more minimal view, I plan to try setting it up
483 # sometime but this seems like a very nice improvement for now.
484 $wgVectorResponsive = true;
488 # https://www.mediawiki.org/wiki/Manual:Configuring_file_uploads
489 # Increase from default of 2M to 100M.
490 # This will at least allow high res pics etc.
491 php_ini=$(php -r 'echo(php_ini_loaded_file());')
492 sed -i --follow-symlinks 's/^\(upload_max_filesize\|post_max_size\)\b.*/\1 = 100M/' $php_ini
494 service apache2 restart
496 systemctl restart httpd.service
499 # if you were to install as a normal user, you would need this for images
500 # sudo usermod -aG $apache_user $USER
502 # this doesn't propogate right away
503 chgrp -R $apache_user $mw/images
504 chmod -R g+w $mw/images
507 Style settings. Omit to use a different style.
511 #$wgFooterIcons = null;
513 # Make the toolbox go into the drop down.
515 if ! git remote show ian-kelling &>/dev/null; then
516 git remote add ian-kelling https://iankelling.org/git/forks/Vector
518 git fetch ian-kelling
519 git checkout ian-kelling/${mw_branch}-toolbox-in-dropdown
522 == Install and Configure Mediawiki Extensions ==
524 When installing extensions on a wiki with important content, backup first as a precaution.
526 ''' Extensions with no configuration needed '''
532 | [[mediawikiwiki:Extension:Cite|Extension:Cite]]
533 | Have references in footnotes*
535 | [[mediawikiwiki:Extension:CiteThisPage|Extension:CiteThisPage]]
536 | Ability to generate citations to pages in a variety of styles*
538 | [[mediawikiwiki:CheckUser|Extension:CheckUser]]
539 | Get ip addresses from inside mediawiki so you can ban users''
541 | [[mediawikiwiki:Extension:CSS|Extension:CSS]]
542 | Allows CSS stylesheets to be included in specific articles
544 | [[mediawikiwiki:Extension:Echo|Extension:Echo]]
545 | Notification subsystem for usage by other extensions
547 | [[mediawikiwiki:Extension:Gadgets|Extension:Gadgets]]
548 | UI extension system for users*
550 | [[mediawikiwiki:Extension:ImageMap|Extension:ImageMap]]
551 | Links for a region of an image*
553 | [[mediawikiwiki:Extension:Interwiki|Extension:Interwiki]]
554 | Tool for nice links to other wikis*
556 | [[mediawikiwiki:Extension:News|Extension:News]]
557 | Embed or rss recent changes
559 | [[mediawikiwiki:Extension:Nuke|Extension:Nuke]]
560 | Mass delete of pages, in the case of spam*
562 | [[mediawikiwiki:Extension:ParserFunctions|Extension:ParserFunctions]]
563 | Useful for templates*
565 | [[mediawikiwiki:Extension:Poem|Extension:Poem]]
566 | Useful for formatting things various ways*
568 | [[mediawikiwiki:Extension:Renameuser|Extension:Renameuser]]
569 | Allows bureaucrats to rename user accounts*
571 | [[mediawikiwiki:Extension:SyntaxHighlight_GeSHi|Extension:SyntaxHighlight_GeSHi]]
572 | Source code highlighting*
574 | [[mediawikiwiki:Extension:Variables|Extension:Variables]]
575 | Define per-page variables
578 <nowiki>*</nowiki> = Comes with the MediaWiki default download.
581 mw-ext Cite CiteThisPage CheckUser CSS Echo Gadgets ImageMap Interwiki News \
582 Nuke ParserFunctions Poem Renameuser SyntaxHighlight_GeSHi Variables
586 ''' [[mediawikiwiki:Extension:AntiSpoof|Extension:AntiSpoof]]: Disallow usernames with unicode trickery to look like existing names'''
590 # recommended setup script to account for existing users
591 sudo -u $apache_user php $mw/extensions/AntiSpoof/maintenance/batchAntiSpoof.php
595 '''[[mediawikiwiki:Extension:Wikidiff2|Extension:Wikidiff2]]: Faster and international character supported page diffs'''
597 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.
600 apt-get -y install php-wikidiff2
602 $wgExternalDiffEngine = 'wikidiff2';
604 dir=$(dirname $(php -r 'echo(php_ini_loaded_file());'))/../apache2/conf.d
605 ln -sf ../../mods-available/wikidiff2.ini $dir
606 service apache2 restart
611 ''' [[mediawikiwiki:Extension:Math|Extension:Math]] Display equations'''
615 # php5-curl according to Math readme
618 if ! apt-get -s install $curl_pkg &>/dev/null; then
621 apt-get -y install latex-cjk-all texlive-latex-extra texlive-latex-base \
622 ghostscript imagemagick ocaml $curl_pkg make
624 # todo, php5-curl equivalent on fedora
625 yum -y install texlive-cjk ghostscript ImageMagick texlive ocaml
627 service apache2 restart
629 cd $mw/extensions/Math/math; make # makes texvc
630 cd $mw/extensions/Math/texvccheck; make
633 # Enable MathJax as rendering option
634 $wgUseMathJax = true;
635 # Enable LaTeXML as rendering option
636 $wgMathValidModes[] = 'latexml';
637 # Set LaTeXML as default rendering option, because it is nicest
638 $wgDefaultUserOptions['math'] = 'latexml';
642 '''Skippable notes'''
644 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.
647 ''' [[mediawikiwiki:Extension:SpamBlacklist|Extension:SpamBlacklist]]: Import/create IP blacklists, mainly for spam'''
649 Comes with MediaWiki.
653 if ! grep -F '$wgSpamBlacklistFiles = array(' $mwc &>/dev/null; then
655 $wgEnableDnsBlacklist = true;
656 $wgDnsBlacklistUrls = array( 'xbl.spamhaus.org', 'dnsbl.tornevall.org' );
658 ini_set( 'pcre.backtrack_limit', '10M' );
659 $wgSpamBlacklistFiles = array(
660 "[[m:Spam blacklist]]",
661 "http://en.wikipedia.org/wiki/MediaWiki:Spam-blacklist"
667 ''' [[mediawikiwiki:Extension:TitleBlacklist|Extension:TitleBlacklist]]: Anti-spam '''
669 Comes with Mediawiki.
672 mw-ext TitleBlacklist
673 if ! grep -F '$wgTitleBlacklistSources = array(' $mwc &>/dev/null; then
675 $wgTitleBlacklistSources = array(
678 'src' => 'MediaWiki:Titleblacklist',
682 'src' => 'http://meta.wikimedia.org/w/index.php?title=Title_blacklist&action=raw',
689 ''' [[mediawikiwiki:Extension:WikiEditor|Extension:WikiEditor]]: Editing box extras and a fast preview tab '''
691 Comes with MediaWiki.
696 # Enable Wikieditor by default
697 $wgDefaultUserOptions['usebetatoolbar'] = 1;
698 $wgDefaultUserOptions['usebetatoolbar-cgd'] = 1;
700 # Display the Preview and Changes tabs
701 $wgDefaultUserOptions['wikieditor-preview'] = 1;
705 ''' [[mediawikiwiki:CategoryTree|Extension:CategoryTree]]: Enables making nice outlines of pages in a category'''
709 # Mediawiki setting dependency for CategoryTree
714 ''' [[mediawikiwiki:Extension:AbuseFilter|Extension:AbuseFilter]]: Complex abilities to stop abuse '''
716 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:
720 $wgGroupPermissions['sysop']['abusefilter-modify'] = true;
721 $wgGroupPermissions['*']['abusefilter-log-detail'] = true;
722 $wgGroupPermissions['*']['abusefilter-view'] = true;
723 $wgGroupPermissions['*']['abusefilter-log'] = true;
724 $wgGroupPermissions['sysop']['abusefilter-private'] = true;
725 $wgGroupPermissions['sysop']['abusefilter-modify-restricted'] = true;
726 $wgGroupPermissions['sysop']['abusefilter-revert'] = true;
730 '''[[mediawikiwiki:Extension:ConfirmEdit|Extension:ConfirmEdit]]: Custom Captcha.'''
732 Uses captchaArray defined in mw_vars. Comes with MediaWiki.
738 wfLoadExtension( 'ConfirmEdit/QuestyCaptcha' );
739 $wgCaptchaClass = 'QuestyCaptcha';
740 # only captcha on registration
741 $wgGroupPermissions['user' ]['skipcaptcha'] = true;
742 $wgGroupPermissions['autoconfirmed']['skipcaptcha'] = true;
744 if ! grep -Fx 'foreach ( $localSettingsQuestyQuestions as $key => $value ) {' $mwc; then
746 foreach ( $localSettingsQuestyQuestions as $key => $value ) {
747 $wgCaptchaQuestions[] = array( 'question' => $key, 'answer' => $value );
753 Enable account creation that we initially disabled.
755 sed -i --follow-symlinks "/\\\$wgGroupPermissions\\['\\*'\\]\\['createaccount'\\] = false;/d" $mwc
758 == Additional Configuration with Pywikibot ==
760 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.
763 '''Pywikibot Install'''
765 [[mediawikiwiki:Manual:Pywikibot/Installation|Manual:Pywikibot/Installation]]
769 if [[ ! -e ~/pywikibot/.git ]]; then
770 git clone --recursive \
771 https://gerrit.wikimedia.org/r/pywikibot/core.git ~/pywikibot
780 '''Pywikibot Configuration'''
782 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]]
787 dd of=user-config.py <<EOF
789 usernames["$mwfamily"]['en'] = u'$wikiuser'
791 console_encoding = 'utf-8'
792 password_file = "secretsfile"
795 dd of=secretsfile <<EOF
796 ("$wikiuser", "$wikipass")
799 # it won't overrwrite an existing file. Remove if if one exists
800 rm -f pywikibot/families/${mwfamily}_family.py
802 apt-get install -y python-requests
804 yum -y install python-requests
807 python generate_family_file.py https://$mwdomain/wiki/Main_Page "$mwfamily"
809 # Note, this needed only for ssl site
810 tee -a pywikibot/families/${mwfamily}_family.py<<'EOF'
811 def protocol(self, code):
817 '''Pywikibot Script'''
819 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]].
824 dd of=scripts/${mwfamily}_setup.py<<EOF
828 site = pywikibot.Site()
830 page = pywikibot.Page(site, p)
832 #force is for some anti-bot thing, not necessary in my testing, but might as well include it
833 page.save(force=True)
835 # Small/medium noncommercial wiki should be fine with no privacy policy
836 # based on https://www.mediawiki.org/wiki/Manual:Footer
837 x("MediaWiki:Privacy")
839 # licenses for uploads. Modified from the mediawiki's wiki
840 x("MediaWiki:Licenses", u"""* Same as this wiki's text (preferred)
841 ** CC BY-SA or GFDL| Creative Commons Attribution ShareAlike or GNU Free Documentation License
843 ** Unknown_copyright|I don't know exactly
844 ** PD|PD: public domain
845 ** CC BY|Creative Commons Attribution
846 ** CC BY-SA|Creative Commons Attribution ShareAlike
847 ** GFDL|GFDL: GNU Free Documentation License
848 ** GPL|GPL: GNU General Public License
849 ** LGPL|LGPL: GNU Lesser General Public License""")
850 x("MediaWiki:Copyright", '$mw_license')
851 x("MediaWiki:Mainpage-description", "$mwdescription")
855 # The rest of the settings are for the site style
857 # Remove various clutter
858 x("MediaWiki:Lastmodifiedat")
859 x("MediaWiki:Disclaimers")
860 x("MediaWiki:Viewcount")
861 x("MediaWiki:Aboutsite")
862 # remove these lines from sidebar
863 # ** recentchanges-url|recentchanges
864 # ** randompage-url|randompage
866 x("MediaWiki:Sidebar", """* navigation
867 ** mainpage|mainpage-description
873 # helpfull doc: https://www.mediawiki.org/wiki/Manual:Interface/Sidebar
874 x("mediawiki:Common.css", """/* adjust sidebar to just be home link and up top */
875 /* adjust sidebar to just be home link and up top */
876 /* panel width increased to fit full wiki name. */
877 /* selectors other than final id are for increasing priority of rule */
878 div#mw-panel { top: 10px; padding-top: 0em; width: 20em }
879 div#footer, #mw-head-base, div#content { margin-left: 1em; }
880 #left-navigation { margin-left: 1em; }
883 /* logo, and toolbar hidden */
884 #p-logo, div#mw-navigation div#mw-panel #p-tb {
888 div#mw-content-text {
894 # this can spam a warning, so uniq it
895 python pwb.py ${mwfamily}_setup |& uniq
899 ''' Skippable Notes '''
901 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.
903 Family name, and all its duplicattions documented as supposed to be $wgSitename, but it works fine using any name.
905 == Automatic Backups ==
907 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.
909 <source lang="bash" type="backup">
910 backup_script=/etc/cron.daily/mediawiki_backup
911 sudo dd of=$backup_script <<'EOFOUTER'
913 # if we get an error, keep going but return it at the end
915 trap 'last_error=$?' ERR
917 # No strict because the host is likely not named the same as
919 ssh="ssh -oStrictHostKeyChecking=no"
920 logfile=/var/log/${mwdomain}_backup.log
922 echo "#### starting backup at $(date) ####"
923 $ssh root@$mwdomain <<ENDSSH
926 \$wgReadOnly = 'Dumping Database, Access will be restored shortly';
928 mkdir -p ~/wiki_backups
929 mysqldump -p$dbpass --default-character-set=binary my_wiki > ~/wiki_backups/wiki_db_backup
930 sed -i '\$ d' $mwc # delete read only setting
932 # add no strict option to the defaults
934 rdiff() { rdiff-backup --remote-schema "$ssh -C %s rdiff-backup --server" "$@"; }
936 rdiff root@$mwdomain::/root/wiki_backups ~/backup/${mwdomain}_wiki_db_backup
937 rdiff root@$mwdomain::$mw ~/backup/${mwdomain}_wiki_file_backup
939 echo "=== ending backup at $(date) ===="
941 if [[ $last_error != 0 ]]; then
942 echo "backup for $mwdomain failed. See $logfile"
947 sudo chmod +x $backup_script
950 '''Optional & requires additional steps'''
952 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].
954 == Restoring Backups ==
956 '''Whenever you implement a backup system, you should test that restoring the backup works.'''
958 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.
960 To test a backup restore:
961 # Do a backup of your wiki with some content in it, as described in the previous section
962 # Move your mediawiki install directory, or setup Mediawiki on a new machine
963 # Re-execute the mediawiki install steps
964 # Change REPLACE_ME in the code below (as in the backup section so you get the right variables),
965 # Execute the code on the backup machine.
968 <source lang="bash" type="example">
971 restore="rdiff-backup --force -r now"
972 $restore ~/backup/${mwdomain}_wiki_file_backup /tmp/wiki_file_restore
973 $restore ~/backup/${mwdomain}_wiki_db_backup /tmp/wiki_db_restore
974 o=-oStrictHostKeyChecking=no
975 scp $o -r /tmp/wiki_file_restore/images/* root@$mwdomain:$mw/images
976 scp $o -r /tmp/wiki_db_restore root@$mwdomain:/tmp
977 ssh $o root@$mwdomain <<EOF
979 chmod -R g+w $mw/images
980 chgrp -R www-data $mw/images
981 mysql -uroot "-p$dbpass" my_wiki < /tmp/wiki_db_restore/wiki_db_backup
982 php $mw/maintenance/update.php
986 Then browse to your wiki and see if everything appears to work.
990 Subscribe to get release and security announcements [https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce MediaWiki-announce].
992 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).
994 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]]
996 Minor updates script:
998 s=/etc/cron.daily/mediawiki_update
1005 [[ -d $dir ]] || return 1
1007 branch=$(git describe --all)
1008 branch=${branch#remotes/}
1010 new_head=$(git rev-parse $branch)
1011 log=$(git log HEAD..$new_head)
1012 if [[ ! $log ]]; then
1017 git checkout -qf $new_head
1021 for dir in extensions/* skins/* vendor; do
1025 curl "https://iankelling.org/git/?p=mediawiki-librejs-patch;a=blob_plain;f=mediawiki-1.28-librejs.patch;hb=HEAD" | patch -r - -N -p1
1027 php $mw/maintenance/update.php -q --quick
1032 == Upgrading Major Versions ==
1034 Reference documentation is at [[mediawikiwiki:Manual:Upgrading]]
1038 # Read the "Upgrade notices for MediaWiki administrators" on the upgrade version and any skipped versions at [[mediawikiwiki:Version_lifecycle]].
1039 # Setup a blank test wiki with the new version.
1040 # Backup the old database, restore it to the new wiki, run php maintenance/update.php.
1041 # If everything looks good, repeat and replace the old wiki with the new one.
1045 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:
1047 * Find new spam quickly, revert it & ban the user.
1048 ** 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."
1049 ** 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].
1050 * Require registration to edit, and a custom captcha question on registration.
1051 * Install all non-user inhibiting anti-spam extensions / settings that take a reasonable amount of time to figure out.
1053 == Choosing Extensions ==
1055 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.
1057 Here are brief descriptions of extensions that are part of distributions and why they were rejected for this wiki.
1059 {| class="wikitable"
1061 | '''Footnote''' || deprecated in newer versions
1063 | '''InputBox''' || Add html forms to pages. Can't imagine using it. Would install if I did.
1065 | '''LocalisationUpdate'''|| update localization only. I'm fine updating all of mediawiki, there aren't many updates.
1067 | '''NewestPages''' || A page creation history that doesn't expire like recent-changes. Meh
1069 | '''NewUserNotif''' || Send me a notification when a user registers. Seems like an excessive notification.
1071 | '''Openid''' || Poor UI. 2 pages & 2 links <login> <login with openid> which is confusing & ugly.
1073 | '''Pdfhandler''' || Gallery of pages from a pdf file. Can't imagine using it. Would install if I did.
1075 | '''RSSReader''' || Embed an rss feed. Can't imagine using it. Would install if I did.
1077 | '''Semantic''' || Seems like a lot of trouble around analyzing kinds of data which my wiki will not have.
1079 | '''Validator''' || dependency of of semantic
1085 ''' Web Analytics Software '''
1087 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.
1089 ''' Mediawiki Documentation Quality '''
1091 Overall the documentation is good, but like wikipedia, it depends.
1093 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.
1095 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].
1098 '''Bash here documents, EOF vs 'EOF' '''
1100 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.
1103 ''' Mediawiki automation tools survey 7/2014 '''
1106 * https://github.com/ianweller/mw
1107 * http://search.cpan.org/~markj/WWW-Mediawiki-Client/bin/mvs
1108 * https://github.com/alexz-enwp/wikitools 3000 lines of code, no response to a bug reports in 2/2014
1110 Getting basic maintenance
1111 * https://github.com/mwclient/mwclient 2000 lines of code
1113 Actively developed, used by wikimedia foundation a lot.
1114 * [[mediawikiwiki:Manual:Pywikibot]]
1117 ''' Troubleshooting Errors '''
1119 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]]
1123 This page and this wiki is licensed under cc-by-sa 4.0.
1124 This means the code is compatible with gplv3.
1126 == todo list for this page ==
1128 * Get Visual editor extension.
1129 * Don't require registration for edits