View source for Wikispooks:Site Backup

{{HelpSection|image=SiteBackup.png}}
{{IframeFolder|path=/backups/?C=N;O=D}}
<big>'''You are encouraged to download the <u class="plainlinks">[[image:compressed.gif|link={{server}}/backups/wikispooks-latest.zip]][{{server}}/backups/wikispooks-latest.zip &nbsp;wikispooks-latest]</u> backup ({{BackupSize}}) in case the site goes offline for any reason.'''<big/><hr/>
Weekly backup snapshots for the last two months are listed on the right in the '''<font face="Serif">Backup files list</font>'''. The <u class="plainlinks">[[image:compressed.gif|link={{server}}/backups/wikispooks-latest.zip]][{{server}}/backups/wikispooks-latest.zip <code>&nbsp;wikispooks-latest.zip</code>]</u> file is a link to the most recent snapshot ({{t|{{BackupSize}}}}). As the site is [[Wikispooks:Copyrights|open licenced]] you are free to publish some or all of the content elsewhere, either as a mirror or as part of another website.

==Setting up and running a Copy Of The Site==
{| class="wikitable" style="margin:.4em; float:right"
| style="max-width:375px; text-align:left; padding:.4em .4em .4em 1em; font-size:105%; background-color:#EEE" | [[File:Gnome-system-software-installer.svg|40px]] <span style="font-size:118%; margin-left:10px;">System requirements</span>
|-
| style="padding:0 .4em .24em; font-size:95%; max-width:375px" |
* '''Disk space''' > 16Gb 
* '''Web server''' such as [http://httpd.apache.org Apache] or [http://www.microsoft.com/iis IIS] or [http://nginx.org/en/ NginX]
* '''[http://www.php.net PHP]''' version 5.6 or later, including:
** [http://php.net/spl Standard PHP Library]
** [http://php.net/pcre pcre] - Perl Compatible Regular Expressions
** [http://www.php.net//manual/en/book.json.php JSON]
** [http://php.net/manual/en/book.image.php GD] - Thumbnailing graphics
** [http://php.net/manual/en/book.xml.php XML]
** [http://php.net/manual/en/book.mbstring.php mbstring] - Multibyte strings
* '''Database Server'''
** [http://www.mysql.com MySQL] version 5.5 or later, or
** [https://mariadb.org/MariaDB MariaDB] version 10.0 or later
|}
''The [{{server}}/backups/wikispooks-latest.zip backup file] contains everything you need to run a mirror of this site on a suitably configured web server; Separate installation of Mediawiki is NOT required.''

The web server currently used by Wikispooks is '''[http://httpd.apache.org/ Apache]''' running on [https://www.centos.org/about/ Centos 7] Linux. These instructions assume Apache, though [http://nginx.org/en/ NginX], [http://www.microsoft.com/web/platform/server.aspx IIS] and other web servers may work just as well. The instructions have been slightly modified to try to suit other Linux distos as well.

'''N.B.''' ''[http://www.wampserver.com/en/ WampServer] or [http://www.apachefriends.org/en/xampp.html‎ Xampp] provide all the Apache web-server software required (except for Xcache) to run the Wikispooks site locally on either a Linux or Windows machine.''. If you do not install either [http://xcache.lighttpd.net/ Xcache] or [http://pecl.php.net/package/APC APC] separately, then you must change <code>$wgMainCacheType = CACHE_ACCEL;</code> to <code>$wgMainCacheType = CACHE_DB;</code> in <Code>/w/LocalSettings.php</code>.

===Overview===
Set up your web server; create a blank MySQL database; download <u class="plainlinks">[[image:compressed.gif|link={{server}}/backups/wikispooks-latest.zip]][{{server}}/backups/wikispooks-latest.zip <code>wikispooks-latest.zip</code>]</u>  to your server root and unpack it; import file <code>''path-to-server-root''/backups/ws.sql</code> into your blank MySQL database; edit <code>''path-to-server-root''/w/LocalSettings.php</code> and enter your database name and user credentials; navigate to your web-server root from your web browser to browse your local copy of Wikispooks.

===Web server directives===
*[http://www.mediawiki.org/wiki/Manual:Short_URL Pretty urls] are required for full site functionality. Add the following to the bottom of your server or virtual server config file:<br/> 
:<code>Alias /wiki ''path-to-server-root''/w/index.php</code>.<br/>
:''Apache'' config files are usually located at <code>/etc/httpd/</code>.
*for correct display of the [[Project:Site Backup|Site backups list]] box. Add the following to your server config file:<br/>
:<poem><Code><Directory "''path-to-server-root''/backups">
::Options +Indexes
::IndexIgnore  .. header.html
::HeaderName header.html
::IndexOptions FancyIndexing SuppressDescription SuppressLastModified NameWidth=*
</Directory></code></poem> 
*'''Linux only''': you may have to tweek a few directory permission for the site to run smoothly. In particular the following require user (Usually <code>Apache</code>) write permissions:<br/>
:<code>''path-to-server-root''/w/cache/</code>
:<code>''path-to-server-root''/w/images/</code>

===The MySQL database===
The database must be created manually (see [http://www.mediawiki.org/wiki/Manual:MySQL MySQL manual]).<br/> This site uses database name "<code>wikispooks</code>" and user "<code>WSuser</code>", so using these is simplest. If you change them, make sure to [[#Database settings|adjust '''{{t|LocalSettings.php}}''' accordingly]].

===The backup file===
Place your downloaded <code>latest-site.zip</code> file in the server root directory and and unzip it. This will create a directory structure containing all application and associated site files. It will also place the database content file <code>ws.sql</code> in the <code>''path-to-server-root''/backups/</code> directory.

===Import the Wikispooks content into your database===
Import <code>''path-to-server-root/backups/''ws.sql</code> into the new database. 

'''N.B.''' The file is too large for a default configuration of phpMyAdmin to handle. Try a MySQL command for this, e.g.
::<code>$ mysql -u username --password=''password'' --host=''localhost'' data-base-name < ws.sql </code>

===LocalSettings.php===
The file  at <code>''path-to-server-root''/w/LocalSettings.php</code> contains the local customisations of the default Mediawiki install. It needs editing as follows to match your install:

====Domain settings====
* Modify the below two lines to suit your install (For installation on your machine, set these to "http" and "localhost" respectively):
<poem><code>$WSprotocol='https';		// For a local install, should be "http"
$WSdomain='wikispooks.com'; // For a local install, should be "localhost"</code></poem>

====Database settings====
* Enter your new database details in the below lines:
<poem><code>$wgDBtype = "mysql";
$wgDBserver = "localhost";
$wgDBname = "wikispooks";
$wgDBuser = "root";
$wgDBpassword = "";</code></poem>

==Troubleshooting==
If things don't go smoothly, the first thing you should do is go to the end of the file where you will see the following lines: 
::<code>#$wgShowExceptionDetails = true;</code>
::<code>#$wgShowSQLErrors = 1;</code>
Remove the <code>#</code> characters to get diagnostic output that may help you debug. It's recommended to replace them once things are working OK.

===<small>{{t|Warning: include(../../cgi-bin/WsDbInfo.php)}}...</small>===
This occurs if you haven't [[#Database settings|fixed the database credentials]] as explained above.

===<small>{{t|CACHE_ACCEL requested but no suitable object cache is present. }}</small>===
This means that the ACCEL cache is not available on your webserver. The first thing to try is to find the following lines:
::<code>$wgMainCacheType = CACHE_ACCEL;</code>
::<code>#$wgMainCacheType = CACHE_DB;</code>
Try commenting the first of these out, and uncommenting the second. If this doesn't work, the easiest way to get it running is to comment them both out. This disables the cache, which will impact performance, but that problem can be tackled later if need arises.

===<small>{{t|Sorry! This site is experiencing technical difficulties. }}</small>===
The active part of this message is a couple of lines lower. If it says "Cannot contact the database server:" this means that [[#Insert correct Database credentials|the custom Database credentials]] you entered into Localsettings.php are not functioning properly.

===<small>{{t|Lua error: Internal error: The interpreter exited with status 2}}</small>===
===<small>{{t|Lua error: Internal error: Error reading from pipe.}}</small>===
The above error messages indicate that Lua is hitting a memory limit problem.<ref>https://www.mediawiki.org/wiki/Topic:Sftr334fvttqt3qm</ref> In this case, the pages will appear mostly OK, but will lack infoboxes. In this case, you should raise the amount of memory available for Lua.<ref>https://www.mediawiki.org/wiki/Extension:Scribunto#Lua_error:_Internal_error:_The_interpreter_exited_with_status_2</ref> Find the following two lines and comment them in:
::<code>#$wgScribuntoEngineConf['luastandalone']['memoryLimit'] = 209715200; # bytes</code>
::<code>#$wgMaxShellMemory = 204800; # in KB</code>

==Running A Live Site Mirror==
If you have interest and resources to set up a realtime site mirror on your server, you are encouraged to do so. We may also be able to provide you with some technical assistance if needed. Requests for help setting up realtime mirrors should be addressed to <code>admin[at]wikispooks.org</code> and encrypted with [[Wikispooks:PGP Public Key|'''this key''']].

===Known Issues===
* [http://xdebug.org/ xdebug] is a php debugging tool which produces output similar (but considerably more verbose) to <code>$wgShowExceptionDetails</code> above. It is installed and enabled by default in both ''Wamp server'' and ''Xampp''. Wikispooks admins have found it useful in tracking down common installation problems but that a default setting results in ungraceful ''out of memory'' failures on some of the more common installation issues, rendering it useless in tracking them down. Either disable it by commenting out the ''[xdebug]'' block in ''php.ini'' or increase <code>max_nesting_level</code> from the default 100 with the following if you wish to use it: <code>xdebug.max_nesting_level=300</code> 
* The backups do not include the [{{server}}/anon/anon-ul.html Anon Uploads Form] or [{{server}}/piwik/index.php Piwik stats].
* '''Suggestions, Queries etc? - Either Email the admin (non-Wikispooks members) or use [[Wikispooks talk:Site Backup|this discussion page]]''' (Wikispooks members)
{{Wikispooks Footer/Technical}}
[[Category:Wikispooks Technical]]