== Introduction ==
-'''tldr''': Automated setup on gnu/linux after you set options in [[#Dependent Variables and Functions]], except email. Any code which is not ready to be run has bold text saying so immediately before it.
+'''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.
''' Goals / Why use this guide? '''
* Closely references & supplements official documentation
* Explicit automation support wherever practical
* Used to setup this site (style optional)
-* Contributions welcome. This site will be updated/tested with changes to this document!
-* Support for multiple linux distros
+* Contributions welcome and will be updated/tested on this very site!
+* Support for multiple gnu/linux distros
* Holistic scope (backups, server setup), but sections stand on their own
* Explicit support for production & local testing instance. Additions for production like https and web analytics.
* Edits to this page are closely monitored by the original author.
'''Assumptions'''
-* Self hosting, single Linux system with Bash shell
+* Self hosting, single GNU/Linux system with Bash shell
* Root shell is assumed throughout
* Code blocks are [https://en.wikipedia.org/wiki/Idempotent idempotent]
Very minor adjustments needed for other distros. Help expand this list.
* Mediawiki 1.27
* Debian 8 (tested)
+* Debian testing (tested Aug 7, 2016)
Pre 5/2016 revisions ran Mediawiki 1.23, tested on Fedora 20 and Ubuntu 14.04.
-== Production Server Prerequisites ==
+== Prerequisites ==
'''Getting a Server & a Domain'''
'''Email Setup'''
-Setting up email can be an involved process. Mediawiki is perfectly happy to disable email with 1 setting (no password reminders or notifications), but it is a nice feature to have. You could run your own mail server (on the mediawiki server, or elsewhere), or use one of many services which sends mail for very cheap, or free within limits (popular examples [http://www.mailgun.com/ mailgun], [https://mandrillapp.com/ mandrill], [http://www.mailjet.com/pricing mailjet], [https://aws.amazon.com/ses/ aws]), or connect to a full featured send/receive mail provider like [https://fastmail.com fastmail] (this server is setup that way). How we did that is for a future wiki page.
+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.
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]]
-== Stopping Spam ==
-
-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:
-
-* Find new spam quickly, revert it & ban the user.
-** 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."
-** 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].
-* Require registration to edit, and a custom captcha question on registration.
-* Install all non-user inhibiting anti-spam extensions / settings that take a reasonable amount of time to figure out.
-
-== Download all ready to use source code blocks into a single script ==
-
-Source block that are not ready to use have a bold warning just before them (and a tag on the block) and are skipped.
-''' Requires customization: outputs to stdout'''
-<source lang="bash" type="example">
-start=' *<source lang="bash"> *'
-end=' *<\/source> *'
-ruby <<'EOF' | sed -rn "/^$start$/,/^$end$/{s/^$start|$end$/# \0/;p}"
-require 'json'
-puts JSON.parse(`curl 'https://ofswiki.org/w/api.php?\
-action=query&titles=Mediawiki_Setup_Guide&prop=revisions&rvprop=content&\
-format=json'`.chomp)['query']['pages'].values[0]['revisions'][0]['*']
-EOF
-</source>
-
-== Dependent Variables and Functions ==
+== Setup Guide Configuration ==
# Set variables below
# Save the code in this section to a file (~/mw_vars is suggested)
'''Requires customization:'''
<source lang="bash" type="example">
-# Replease REPLACE_ME as appropriate
+# Replace REPLACE_ME as appropriate
-export mwdescription="Opinionated Free Software Wiki"
+export mwdescription="REPLACE_ME" # eg. Opinionated Free Software Wiki
# username/pass of the first wiki admin user
-export wikiuser="Ian Kelling"
+export wikiuser="REPLACE_ME"
export wikipass=REPLACE_ME
# root password for the mysql database
export dbpass=REPLACE_ME
-# password for piwik web analytics admin
-export piwik_pass=REPLACE_ME
-
-# git branch for mediawiki + extensions
-# branch names: https://git.wikimedia.org/branches/mediawiki%2Fcore.git
-export mw_branch=REL1_27
+export mwdomain=REPLACE_ME # domain name. for this site, it's ofswiki.org
-# customize these questions to something your contributors would know,
-# is not super common / scriptable, and doesn't have the answer in the question
+# customize these questions. Try not to have the answer be a word in the question.
captchaArray() {
if ! grep -Fx '$localSettingsQuestyQuestions = array (' $mwc; then
tee -a $mwc <<'EOF'
$localSettingsQuestyQuestions = array (
"What is the name of the wiki software this site (and wikipedia) uses?" => "Mediawiki",
- "What does f in ofswiki.org stand for?" => "Free"
+ "REPLACE_ME with a question" => "REPLACE_ME with an answer"
);
EOF
+ fi
}
-# As set by gui installer when choosing cc by sa.
-export mw_RightsUrl="https://creativecommons.org/licenses/by-sa/4.0/";
-export mw_RightsText="Creative Commons Attribution-ShareAlike";
-export mw_RightsIcon="$wgResourceBasePath/resources/assets/licenses/cc-by-sa.png";
+# The rest of this section will work fine with no changes.
+# git branch for mediawiki + extensions.
+# This guide has only been tested with 1_27.
+# branch names: https://git.wikimedia.org/branches/mediawiki%2Fcore.git
+export mw_branch=REL1_27
-# domain name and install paths. These are examples, change as needed.
-export mwfamily=ofswiki # short alphanumeric name for pywikibot
-export mwdomain=ofswiki.org
+# As set by gui installer when choosing cc by sa.
+export mw_RightsUrl='https://creativecommons.org/licenses/by-sa/4.0/'
+export mw_RightsText='Creative Commons Attribution-ShareAlike'
+export mw_RightsIcon='$wgScriptPath/resources/assets/licenses/cc-by-sa.png'
+
+# Alphanumeric site name for pywikibot.
+# Here we use the domain minus the dots, which should work fine without changing.
+export mwfamily=${mwdomain//./}
+# install path for mediawiki. This should work fine.
export mw=/var/www/$mwdomain/html/w
# wiki sender address / wiki & wiki server contact email.
# see email section for more info on email
export mw_email="admin@$mwdomain"
+
+# Leave as is:
+mwc="$mw/LocalSettings.php"
</source>
-Here we define some small useful bash functions. This can be part of the same file.
+== Download this page and run it ==
-<source lang="bash">
-# for convenience, Mediawiki config file
-mwc="$mw/LocalSettings.php"
+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.
+
+''' Requires manual step: inspect output file: /tmp/mw-setup, then run it'''
+<source lang="bash" type="example">
+start=' *<source lang="bash"> *'
+end=' *<\/source> *'
+ruby <<'EOF' | sed -rn "/^$start$/,/^$end$/{s/^$start|$end$/# \0/;p} > /tmp/mw-setup"
+require 'json'
+puts JSON.parse(`curl 'https://ofswiki.org/w/api.php?\
+action=query&titles=Mediawiki_Setup_Guide&prop=revisions&rvprop=content&\
+format=json'`.chomp)['query']['pages'].values[0]['revisions'][0]['*']
+EOF
+chmod +x /tmp/mw-setup
+</source>
+
+== Required Bash Functions ==
+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.
+
+<source lang="bash">
# identify if this is a debian based distro
isdeb() { command -v apt &>/dev/null; }
# tee unique. append each stdin line if it does not exist in the file
}
# get and reset an extension/skin repository, and enable it
-mw-ext () { mw-extra extensions $@; }
-mw-skin() { mw-extra skins $@; }
+mw-clone() {
+ local url=$1
+ local original_pwd="$PWD"
+ local name
+ local re='[^/]*/[^/]*$'
+ [[ $url =~ $re ]] ||:
+ target=$mw/${BASH_REMATCH[0]}
+ if [[ ! -e $target/.git ]]; then
+ git clone $url $target
+ fi
+ if ! cd $target; then
+ echo "mw-ext error: failed cd $target";
+ exit 1
+ fi
+ git fetch
+ git checkout -qf origin/$mw_branch || git checkout -qf origin/master
+ git clean -xffd
+ cd "$original_pwd"
-mw-extra() {
- local type=$1 # extension or skin
- shift
+}
+mw-ext () {
local ext
for ext in "$@"; do
- local original_pwd="$PWD"
- # it's ok that this fails if we already have it
- url=https://git.wikimedia.org/git/mediawiki
- target=$mw/$type/$ext
- if [[ ! -e $target/.git ]]; then
- git clone $url/$type/$ext.git $target
- fi
- if ! cd $target; then
- echo "mw-ext error: failed cd $mw/extensions/$ext";
- exit 1
- fi
- git fetch
- git checkout -qf origin/$mw_branch || git checkout -qf origin/master
- git clean -xffd
- cd "$original_pwd"
- case $type in
- extensions)
- if [[ -e $target/extension.json ]]; then
- # new style extension. remove old style declaration
- sed -i '#^require_once( "\\\$IP/extensions/\$ext/\$ext\.php" );#d' $mwc
- teeu $mwc <<EOF
+ mw-clone https://gerrit.wikimedia.org/r/p/mediawiki/extensions/$ext
+ if [[ -e $mw/ext/$ext/extension.json ]]; then
+ # new style extension. remove old style declaration
+ sed -i --follow-symlinks '#^require_once( "\\\$IP/extensions/\$ext/\$ext\.php" );#d' $mwc
+ teeu $mwc <<EOF
wfLoadExtension( '$ext' );
EOF
- else
- teeu $mwc <<EOF
+ else
+ teeu $mwc <<EOF
require_once( "\$IP/extensions/$ext/$ext.php" );
EOF
- fi
- ;;
- skins)
- sed -i '/^wfLoadSkin/d' $mwc
- sed -i '/^\$wgDefaultSkin/d' $mwc
- teeu $mwc <<EOF
-\$wgDefaultSkin = "${ext,,*}";
-wfLoadSkin( '$ext' );
-EOF
- ;;
- esac
+ fi
done
# --quick is quicker than default flags,
# but still add a sleep to make sure everything works right
sudo -u $apache_user php $mw/maintenance/update.php -q --quick; sleep 1
}
+mw-skin() {
+ local skin=$1
+ mw-clone https://gerrit.wikimedia.org/r/p/mediawiki/skins/$skin
+ sed -i --follow-symlinks '/^wfLoadSkin/d' $mwc
+ sed -i --follow-symlinks '/^\$wgDefaultSkin/d' $mwc
+ teeu $mwc <<EOF
+\$wgDefaultSkin = "${skin,,*}";
+wfLoadSkin( '$skin' );
+EOF
+ sudo -u $apache_user php $mw/maintenance/update.php -q --quick; sleep 1
+}
if command -v apt &>/dev/null; then
apache_user=www-data
# main reference:
# https://www.mediawiki.org/wiki/Manual:Running_MediaWiki_on_Ubuntu
apt-get update
- apt-get install -y ImageMagick
+ apt-get install -y imagemagick
if apt-get install -s mediawiki &>/dev/null; then
# in debian wheezy time-frame distros, mediawiki was packaged.
- apt-get -y install php-apc mediawiki
+ apt-get -y install php-apc mediawiki php-mbstring
else
# https://www.mediawiki.org/wiki/Manual:Installation_requirements
if apt-get install -s php7.0 &>/dev/null; then
# note, 7.0 is untested by the editor here, since it's not
# available in debian 8. it's listed as supported
# in the mediawiki page.
- # noninteractive to avoid mysql password prompt
+ # noninteractive to avoid mysql password prompt.
DEBIAN_FRONTEND=noninteractive apt-get install -y apache2 mysql-server \
php7.0 php7.0-mysql libapache2-mod-php7.0 php7.0-xml \
- php7.0-apcu
+ php7.0-apcu php7.0-mbstring
else
+ # note: mbstring is recommended, but it's not available for php5 in
+ # debian jessie.
DEBIAN_FRONTEND=noninteractive apt-get install -y apache2 mysql-server \
php5 php5-mysql libapache2-mod-php5 php5-apcu
fi
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.
-== Get Piwik Files ==
-
-Because it's really fun to look at your traffic stats. This is only needed for a production site. We get these files now so that we can take them into account when configuring apache in the next section.
-
-[http://piwik.org/docs/installation-maintenance/ Overall installation guide]
-
-<source lang="bash">
-tmpdir="$(mktemp -d)"
-cd $tmpdir
-wget http://builds.piwik.org/piwik.zip
-if isdeb; then apt-get -y install unzip; else yum -y install unzip; fi
-unzip -q piwik.zip
-# gui installer suggested command
-if isdeb; then
- chown -R www-data:www-data piwik
-else
- chown -R apache:apache piwik
-fi
-# remove any existing directory
-rm -rf $mw/../analytics
-mv piwik $mw/../analytics
-cd $mw
-rm -rf $tmpdir
-
-</source>
-
== Configure Apache ==
Note, non-debian based installs: modify instructions below to use /etc/httpd/conf.d/$mwdomain.conf, and don't run a2ensite.
l=$mw/../../logs
mkdir -p $l
-acme-tiny-wrapper/acme-tiny-wrapper $mwdomain
+acme-tiny-wrapper/acme-tiny-wrapper -t $mwdomain
git clone $git_site/basic-https-conf
{ cat <<EOF
# use short urls https://www.mediawiki.org/wiki/Manual:Short_URL
RewriteRule ^/*\$ %{DOCUMENT_ROOT}/w/index.php [L]
EOF
-find -L $(readlink -f $mw/..) -name .htaccess \
+find -L $(readlink -f $mw) -name .htaccess \
| while read line; do
echo -e "<Directory ${line%/.htaccess}>\n $(< $line)\n</Directory>";
done
} | basic-https-conf/apache-site -r ${mw%/*} - $mwdomain
+cd
+rm -rf $temp
</source>
Now mediawiki should load in your browser at $mwdomain .
This section assumes we are redirecting www to a url without www.
-[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 piwik 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.
+[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.
== Mediawiki Settings ==
# https://www.mediawiki.org/wiki/Manual:Configuring_file_uploads
# Increase from default of 2M to 100M.
# This will at least allow high res pics etc.
-php_ini=$(isdeb && echo /etc/php5/apache2/php.ini || echo /etc/php.ini)
-sed -i 's/^\(upload_max_filesize\|post_max_size\)\b.*/\1 = 100M/' $php_ini
+php_ini=$(php -r 'echo(php_ini_loaded_file());')
+sed -i --follow-symlinks 's/^\(upload_max_filesize\|post_max_size\)\b.*/\1 = 100M/' $php_ini
if isdeb; then
service apache2 restart
else
# Make the toolbox go into the drop down.
cd $mw/skins/Vector
if ! git remote show ian-kelling &>/dev/null; then
- git remote add ian-kelling https://iankelling.org/git/Vector
+ git remote add ian-kelling https://iankelling.org/git/forks/Vector
fi
git fetch ian-kelling
git checkout ian-kelling/REL1_27-toolbox-in-dropdown
teeu $mwc <<'EOF'
$wgExternalDiffEngine = 'wikidiff2';
EOF
- ln -sf ../../mods-available/wikidiff2.ini /etc/php5/apache2/conf.d
+ dir=$(dirname $(php -r 'echo(php_ini_loaded_file());'))/../apache2/conf.d
+ ln -sf ../../mods-available/wikidiff2.ini $dir
service apache2 restart
fi
</source>
# todo, php5-curl equivalent on fedora
yum -y install texlive-cjk ghostscript ImageMagick texlive ocaml
fi
-ln -sf ../../mods-available/curl.ini /etc/php5/apache2/conf.d
service apache2 restart
cd $mw/extensions/Math/math; make # makes texvc
Enable account creation that we initially disabled.
<source lang="bash">
-sed -i "/\\\$wgGroupPermissions\\['\\*'\\]\\['createaccount'\\] = false;/d" $mwc
+sed -i --follow-symlinks "/\\\$wgGroupPermissions\\['\\*'\\]\\['createaccount'\\] = false;/d" $mwc
</source>
== Additional Configuration with Pywikibot ==
""")
EOF
-python pwb.py ${mwfamily}_setup
+# this can spam a warning, so uniq it
+python pwb.py ${mwfamily}_setup |& uniq
</source>
last_error=0
trap 'last_error=$?' ERR
source ~/mw_vars
+# No strict because the host is likely not named the same as
+# the domain.
+ssh="ssh -oStrictHostKeyChecking=no"
logfile=/var/log/${mwdomain}_backup.log
{
echo "#### starting backup at $(date) ####"
-ssh root@$mwdomain <<ENDSSH
+$ssh root@$mwdomain <<ENDSSH
set -x
tee -a $mwc<<'EOF'
\$wgReadOnly = 'Dumping Database, Access will be restored shortly';
mysqldump -p$dbpass --default-character-set=binary my_wiki > ~/wiki_backups/wiki_db_backup
sed -i '\$ d' $mwc # delete read only setting
ENDSSH
+# add no strict option to the defaults
+
+rdiff() { rdiff-backup --remote-schema "$ssh -C %s rdiff-backup --server" "$@"; }
set -x
-rdiff-backup root@$mwdomain::/root/wiki_backups ~/backup/${mwdomain}_wiki_db_backup
-rdiff-backup root@$mwdomain::$mw ~/backup/${mwdomain}_wiki_file_backup
+rdiff root@$mwdomain::/root/wiki_backups ~/backup/${mwdomain}_wiki_db_backup
+rdiff root@$mwdomain::$mw ~/backup/${mwdomain}_wiki_file_backup
set +x
echo "=== ending backup at $(date) ===="
} &>>$logfile
'''Optional & requires additional steps'''
<source lang="bash" type="example">
-sed -i "/^root:/d" /etc/aliases
+sed -i --follow-symlinks "/^root:/d" /etc/aliases
echo "root: EXAMPLE_ONLY_REPLACE_ME@gmail.com" >> /etc/aliases
newaliases
</source>
'''Whenever you implement a backup system, you should test that restoring the backup works.'''
-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. However, we backup the entire Mediawiki directory in case you forget to record a step, or some misbehaving code stores some state in a file. Since most people don't record the steps they took to setup Mediawiki, this is also the officially recommended method. Here we restore only the database and images folder, which should help identify any of those aforementioned issues. See [[mediawikiwiki:Manual:Restoring a wiki from backup]] if you run into any problems.
+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.
To test a backup restore:
# Do a backup of your wiki with some content in it, as described in the previous section
# Change REPLACE_ME in the code below (as in the backup section so you get the right variables),
# Execute the code on the backup machine.
+'''Optional'''
<source lang="bash" type="example">
#!/bin/bash
source ~/mw_vars
-HOSTNAME=REPLACE_ME source ~/mw_vars
-rdiff-backup -r now ~/backup/${mwdomain}_wiki_file_backup /tmp/wiki_file_restore
-scp -r /tmp/wiki_file_restore/images root@$mwdomain:$mw/images
-rdiff-backup -r now ~/backup/${mwdomain}_wiki_db_backup /tmp/wiki_db_restore
-scp -r /tmp/wiki_db_restore root@$mwdomain:/tmp
-ssh root@$mwdomain <<EOF
-mysql -u root -p$dbpass my_wiki < /tmp/wiki_db_restore/wiki_db_dump
+restore="rdiff-backup --force -r now"
+$restore ~/backup/${mwdomain}_wiki_file_backup /tmp/wiki_file_restore
+$restore ~/backup/${mwdomain}_wiki_db_backup /tmp/wiki_db_restore
+o=-oStrictHostKeyChecking=no
+scp $o -r /tmp/wiki_file_restore/images/* root@$mwdomain:$mw/images
+scp $o -r /tmp/wiki_db_restore root@$mwdomain:/tmp
+ssh $o root@$mwdomain <<EOF
+set -e
+chmod -R g+w $mw/images
+chgrp -R www-data $mw/images
+mysql -u root -p$dbpass my_wiki < /tmp/wiki_db_restore/wiki_db_backup
php $mw/maintenance/update.php
EOF
-
</source>
Then browse to your wiki and see if everything appears to work.
#!/bin/bash
source ~/mw_vars
cd $mw
-git fetch --all
-git checkout origin/$mw_branch
-git rebase ian/REL1_23-toolbox-in-dropdown
-cd extensions
-for x in *; do
- if [[ -d $x ]]; then
- cd $x
- git fetch --all
- git checkout origin/$mw_branch || git checkout -qf origin/master
- cd ..
+for dir in extensions/* skins/* $mw; do
+ [[ -d $dir ]] || continue
+ cd $dir
+ branch=$(git describe --all)
+ branch=${branch#remotes/}
+ git fetch --all -q
+ new_head=$(git rev-parse $branch)
+ log=$(git log HEAD..$new_head)
+ if [[ $log ]]; then
+ pwd
+ echo "$log"
fi
+ git checkout -q $new_head
+ cd $mw
done
php $mw/maintenance/update.php -q
EOF
-chmod +x $s
+
</source>
== Upgrading Major Versions ==
# Backup the old database, restore it to the new wiki, run php maintenance/update.php.
# If everything looks good, repeat and replace the old wiki with the new one.
-== Setup Piwik ==
-
-Note,
-<source lang="bash">
-# based on recommendation from install page
-if ! dpkg -s php5-gd &>/dev/null; then
- apt-get install -y php5-gd
- service apache2 restart
-fi
-
-# docs suggests using separate database user
-mysql -u root -p$dbpass <<EOF
-GRANT ALL ON piwik.* TO 'piwik'@'localhost' IDENTIFIED BY '$piwik_pass';
-FLUSH PRIVILEGES;
-exit
-EOF
-php_ini=$(isdeb && echo /etc/php5/apache2/php.ini || echo /etc/php.ini)
-# based on the install page. however, ths option is changing with php7.0
-opt=always_populate_raw_post_data
-sed -ri "/^ *$opt\b/d;/^ *\[PHP\]/a $opt = -1" $php_ini
-service apache2 restart
-</source>
-
-
-''' Manual Steps'''
-
-Unfortunately, Piwik does not document how to do a fully automated install, and although it certainly seems possible, my first glance at the config file after doing manual steps showed a lot of noise, so we are sticking with the manual steps for now.
-
-In a browser, navigate to your_domain/analytics. Follow these steps [http://piwik.org/docs/installation/#the-5-minute-piwik-installation the-5-minute-piwik-installation]. Use the user/db/pass from the previous section.
-
-
-We are going to use an extension to handle the javaScript tracking tag part.
-
-Under settings -> user settings, click the cookie to exclude your current browser.
-
-
-''' [[mediawikiwiki:Extension:Piwik Integration|Extension:Piwik Integration]] '''
-
-<source lang="bash">
-git clone https://github.com/DaSchTour/piwik-mediawiki-extension.git $mw/extensions/Piwik
-mw-ext Piwik
-teeu $mwc <<EOF
-\$wgPiwikURL = '$mwdomain/analytics/';
-\$wgPiwikIDSite = '1';
-EOF
-</source>
-
-
-'''If this is not the first site you setup'''
-
-You will need to adjust the previous $wgPiwikIDSite variable. The correct value can be found in the Piwik javaScript tracking tag code, in the line that looks like <code>_paq.push(['setSiteId', 2]);</code>
-
-'''Updates'''
-
-Based on [http://piwik.org/docs/update/ piwik.org/docs/update]. Previously it's been seen to require manual steps, so it is not recommended to put in a cron script.
-
-<source lang="bash" type="example">
-mkdir -p ${s%/*}
-piwik_path=$mw/../analytics
-cd "$(mktemp -d)"
-wget -q http://builds.piwik.org/piwik.zip
-unzip -q piwik.zip
-rm -f piwik.zip
-cp $piwik_path/config/config.ini.php piwik/config
-cp -rf piwik/* $piwik_path
-# prevent making an email out of the standard success response
-$piwik_path/console core:update
-</source>
-
-
-''' Skippable Notes '''
-
-Piwik docs say use a subdir or a subdomain. googling finds a page which suggests using a subdomain, for more logical separation https://library.linode.com/web-applications/analytics/piwik/centos-5. However, mediawiki doesn't use the root dir of the web server, so the analytics folder can't mess things up by existing there, and it doesn't have any crazy virtualhost settings which might conflict, so there is no need. Plus we get ssl for free by sharing the same domain.
-
-The docs also say: "When you have finished configuring Piwik, you can set more restrictive permissions (ie. read only) to the “piwik/config/” folder. Piwik will always write its data inside the “piwik/tmp/” folder, so this is the only folder that requires write permissions."
+== Stopping Spam ==
-But since the files are already owned by the web server user, and already can't be written by anyone else, it seems a bit of a pointless half measure since the owner can override any permissions. Enabling the .htaccess files seems more useful, which it doesn't even mention.
+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:
-We could also set up a backup for piwik data, but traffic stat data is not that important so I haven't bothered.
+* Find new spam quickly, revert it & ban the user.
+** 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."
+** 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].
+* Require registration to edit, and a custom captcha question on registration.
+* Install all non-user inhibiting anti-spam extensions / settings that take a reasonable amount of time to figure out.
== Choosing Extensions ==
== Misc Notes ==
+''' Web Analytics Software '''
+
+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.
+
''' Mediawiki Documentation Quality '''
Overall the documentation is good, but like wikipedia, it depends.
-The closer a topic is to core functionality and commonly used features, the better the documentation is likely to be. My guess is that 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 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.
+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.
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].
'''Bash here documents, EOF vs 'EOF' '''
-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 quoted by \, which itself must then also be quoted to be used literally.
+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.
''' Mediawiki automation tools survey 7/2014 '''
== todo list for this page ==
-* Evaluate any extensions bundled in 27 which I haven't checked out before.
-* Visual editor
+* Check if there are any new default extensions 1.27 which I haven't evaluated.
+* Test for any new config values set by the 1.27 gui install method.
+* Get Visual editor extension.
* Don't require registration for edits
iankelling.org / git / mediawiki-setup / blobdiff