Difference between revisions of "Wikispooks:Site Backup"

From Wikispooks
Jump to navigation Jump to search
(typos and tidy)
(31 intermediate revisions by one other user not shown)
Line 1: Line 1:
 
{{HelpSection|image=SiteBackup.png}}
 
{{HelpSection|image=SiteBackup.png}}
<div style="font-size:86%; text-align:center; border:1px solid #aaaaaa; background-color:#f9f9f9; color:black; margin-left:1em; padding:0em; float:right; clear:right;">{{#widget:Iframe
+
{{IframeFolder|path=/backups/?C=N;O=D}}
|url={{server}}/backups/?C=N;O=D
+
'''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.'''<hr/>
|width=300
+
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 weekly snapshot. As the site is [[Wikispooks:Copyrights|open licenced]] you may publish the content elsewhere, either as an exact mirror or as part of another website.
|height=300
 
}}</div>
 
'''Wikispooks readers are encouraged to download the <u class="plainlinks">[{{server}}/backups/wikispooks-latest.zip wikispooks-latest]</u> backup (~3Gb) in case the site goes offline for any reason.'''<hr/>
 
Weekly backup snapshots for the last month are listed on the right in the '''<font face="Serif">Backup files list</font>'''. The <u class="plainlinks">[{{server}}/backups/wikispooks-latest.zip <code>wikispooks-latest.zip</code>]</u> file is a link to the most recent weekly snapshot. The site is [[WikiSpooks:Copyrights| open licenced]] so you are free to publish the content elsewhere, either as an exact mirror or as part of another website.
 
  
 
==Setting up and running a Copy Of The Site==
 
==Setting up and running a Copy Of The Site==
Line 15: Line 11:
 
* '''Disk space''' > 7Gb
 
* '''Disk space''' > 7Gb
 
* '''Web server''' such as [http://httpd.apache.org Apache] or [http://www.microsoft.com/iis IIS] or [http://nginx.org/en/ NginX]
 
* '''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.3.5 or later, including:
+
* '''[http://www.php.net PHP]''' version 5.6 or later, including:
 
** [http://php.net/spl Standard PHP Library]
 
** [http://php.net/spl Standard PHP Library]
 
** [http://php.net/pcre pcre] - Perl Compatible Regular Expressions
 
** [http://php.net/pcre pcre] - Perl Compatible Regular Expressions
Line 22: Line 18:
 
** [http://php.net/manual/en/book.xml.php XML]
 
** [http://php.net/manual/en/book.xml.php XML]
 
** [http://php.net/manual/en/book.mbstring.php mbstring] - Multibyte strings
 
** [http://php.net/manual/en/book.mbstring.php mbstring] - Multibyte strings
** [http://xcache.lighttpd.net/ XCache] or [http://pecl.php.net/package/APC APC] - Op-code caching
 
 
* '''Database Server'''
 
* '''Database Server'''
** [http://www.mysql.com MySQL] version 5.0.2 or later
+
** [http://www.mysql.com MySQL] version 5.5 or later, or
** or [https://mariadb.org/ MariaDB] version 5.4 or later
+
** [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 [{{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.''
Line 34: Line 29:
  
 
===Overview===
 
===Overview===
Set up your web server; create a blank MySQL database; download {{BULink|wikispooks-latest.zip}} 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.
+
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===
 
===Web server directives===
Line 40: Line 35:
 
:<code>Alias /wiki ''path-to-server-root''/w/index.php</code>.<br/>
 
:<code>Alias /wiki ''path-to-server-root''/w/index.php</code>.<br/>
 
:''Apache'' config files are usually located at <code>/etc/httpd/</code>.
 
:''Apache'' config files are usually located at <code>/etc/httpd/</code>.
*for correct display of the [[Wikispooks:Site Backup|Site backups list]] box. Add the following to your server config file:<br/>
+
*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">
 
:<poem><Code><Directory "''path-to-server-root''/backups">
 
::Options +Indexes
 
::Options +Indexes
Line 52: Line 47:
  
 
===The MySQL database===
 
===The MySQL database===
The database must be created manually (see [http://www.mediawiki.org/wiki/Manual:MySQL MySQL manual]).<br/>
+
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]].
Database name <code>wikispooks</code> and user <code>WSuser</code> are assumed in the downloaded <code>LocalSettings.php</code>.<br/>
 
You can use different names but these must be entered into <Code>LocalSettings.php</code> - see below.
 
  
 
===The backup file===
 
===The backup file===
Line 66: Line 59:
  
 
===LocalSettings.php===
 
===LocalSettings.php===
The file is located at <code>''path-to-server-root''/w/LocalSettings.php</code>. It needs editing to insert the security credentials to match your new database.
+
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:
  
====Insert correct Database credentials====
+
====Domain settings====
Locate the following code block:
+
* Modify the below two lines to suit your install (For installation on your machine, set these to "http" and "localhost" respectively):
<poem>
+
<poem><code>$WSprotocol='https'; // For a local install, should be "http"
<code>## Database settings
+
$WSdomain='wikispooks.com'; // For a local install, should be "localhost"</code></poem>
:include("../../cgi-bin/WsDbInfo.php");
 
:#$wgDBtype = "mysql";
 
:#$wgDBserver = "localhost";
 
:#$wgDBname = "wikispooks";
 
:#$wgDBuser = "";
 
:#$wgDBpassword = "";
 
:#$wgDBadminuser = "";
 
:#$wgDBadminpassword = "";</code></poem>
 
Delete the line beginning: <code>include</code>. Delete all <code>#</code> characters and enter your new database credentials in the corresponding lines.
 
  
====Host name and miscellaneous settings====
+
====Database settings====
Search and replace/edit where <code>your-host</code> can be either the host name or IP address of your web server:
+
* Enter your new database details in the below lines:
*search for: <code>$wgServer = "https://wikispooks.com";</code>. 
+
<poem><code>$wgDBtype = "mysql";
:Replace with: <code>$wgServer = "http://your-host";</code>
+
$wgDBserver = "localhost";
*search for: <code>$wgAllowExternalImagesFrom = array ('https://wikispooks.com/','https://www.wikispooks.com/','https://127.0.0.1/','https://perry.wikispooks.com');</code>.
+
$wgDBname = "wikispooks";
:Replace with: <code>$wgAllowExternalImagesFrom = array('http://your-host','http://127.0.0.1');</code>
+
$wgDBuser = "root";
*search for: <code>enableSemantics('wikispooks.com');</code>
+
$wgDBpassword = "";</code></poem>
:Replace with: <code>enableSemantics('your-host');</code>
 
*search for: <code>require_once ('extensions/piwik/Piwik.php');</code>.
 
:Put a <code>#</code> character at the beginning of this and the following 2 lines to disable the Piwik stats extension.
 
  
 
==Troubleshooting==
 
==Troubleshooting==
Line 97: Line 78:
 
::<code>#$wgShowExceptionDetails = true;</code>
 
::<code>#$wgShowExceptionDetails = true;</code>
 
::<code>#$wgShowSQLErrors = 1;</code>
 
::<code>#$wgShowSQLErrors = 1;</code>
Remove the leading <code>#</code> character to get some diagnostic output and help you debug. It's recommended to take comment lines out again once things are working OK.
+
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>===
 
===<small>{{t|Warning: include(../../cgi-bin/WsDbInfo.php)}}...</small>===
This occurs if you haven't [[#Insert correct Database credentials|fixed the database credentials]] as explained above.
+
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>===
 
===<small>{{t|CACHE_ACCEL requested but no suitable object cache is present. }}</small>===
Line 118: Line 99:
  
 
==Running A Live Site Mirror==
 
==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''']].
+
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===
 
===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>  
 
* [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>  
* Some internal wikilinks are still of the form {{t|<nowiki>[[Wikispooks:...]]</nowiki>}}, so will not work unless your project is identically named. This can be tackled with a global search and replace (to "{{t|<nowiki>[[Project:...]]</nowiki>}}"). This issue is being gradually addressed, for easier portability.
 
 
* The backups do not include the [{{server}}/anon/anon-ul.html Anon Uploads Form] or [{{server}}/piwik/index.php Piwik stats].
 
* 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)
* '''Suggestions, Queries etc? - Either Email the admin (non-WikiSpooks members) or use [[WikiSpooks talk:Site Backup|this discussion page]]''' (WikiSpooks members)
+
{{Wikispooks Footer/Technical}}
{{WikiSpooks Footer/Technical}}
+
[[Category:Wikispooks Technical]]
[[Category:WikiSpooks Technical]]
 

Revision as of 18:48, 30 December 2018

SiteBackup.png

You are encouraged to download the Compressed.gif wikispooks-latest backup (13 Gb) in case the site goes offline for any reason.


Weekly backup snapshots for the last two months are listed on the right in the Backup files list. The Compressed.gif wikispooks-latest.zip file is a link to the most recent weekly snapshot. As the site is open licenced you may publish the content elsewhere, either as an exact mirror or as part of another website.

Setting up and running a Copy Of The Site

Gnome-system-software-installer.svg System requirements

The 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 Apache running on Centos 7 Linux. These instructions assume Apache, though NginX, 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. WampServer or 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 Xcache or APC separately, then you must change $wgMainCacheType = CACHE_ACCEL; to $wgMainCacheType = CACHE_DB; in /w/LocalSettings.php.

Overview

Set up your web server; create a blank MySQL database; download Compressed.gifwikispooks-latest.zip to your server root and unpack it; import file path-to-server-root/backups/ws.sql into your blank MySQL database; edit path-to-server-root/w/LocalSettings.php 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

  • Pretty urls are required for full site functionality. Add the following to the bottom of your server or virtual server config file:
Alias /wiki path-to-server-root/w/index.php.
Apache config files are usually located at /etc/httpd/.
  • for correct display of the Site backups list box. Add the following to your server config file:

<Directory "path-to-server-root/backups">
Options +Indexes
IndexIgnore .. header.html
HeaderName header.html
IndexOptions FancyIndexing SuppressDescription SuppressLastModified NameWidth=*
</Directory>

  • Linux only: you may have to tweek a few directory permission for the site to run smoothly. In particular the following require user (Usually Apache) write permissions:
path-to-server-root/w/cache/
path-to-server-root/w/images/

The MySQL database

The database must be created manually (see MySQL manual).
This site uses database name "wikispooks" and user "WSuser", so using these is simplest. If you change them, make sure to adjust LocalSettings.php accordingly.

The backup file

Place your downloaded latest-site.zip 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 ws.sql in the path-to-server-root/backups/ directory.

Import the Wikispooks content into your database

Import path-to-server-root/backups/ws.sql 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.

$ mysql -u username --password=password --host=localhost data-base-name < ws.sql

LocalSettings.php

The file at path-to-server-root/w/LocalSettings.php 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):

$WSprotocol='https'; // For a local install, should be "http"
$WSdomain='wikispooks.com'; // For a local install, should be "localhost"

Database settings

  • Enter your new database details in the below lines:

$wgDBtype = "mysql";
$wgDBserver = "localhost";
$wgDBname = "wikispooks";
$wgDBuser = "root";
$wgDBpassword = "";

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:

#$wgShowExceptionDetails = true;
#$wgShowSQLErrors = 1;

Remove the # characters to get diagnostic output that may help you debug. It's recommended to replace them once things are working OK.

Warning: include(../../cgi-bin/WsDbInfo.php)...

This occurs if you haven't fixed the database credentials as explained above.

CACHE_ACCEL requested but no suitable object cache is present.

This means that the ACCEL cache is not available on your webserver. The first thing to try is to find the following lines:

$wgMainCacheType = CACHE_ACCEL;
#$wgMainCacheType = CACHE_DB;

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.

Sorry! This site is experiencing technical difficulties.

The active part of this message is a couple of lines lower. If it says "Cannot contact the database server:" this means that the custom Database credentials you entered into Localsettings.php are not functioning properly.

Lua error: Internal error: The interpreter exited with status 2

Lua error: Internal error: Error reading from pipe.

The above error messages indicate that Lua is hitting a memory limit problem.[1] 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.[2] Find the following two lines and comment them in:

#$wgScribuntoEngineConf['luastandalone']['memoryLimit'] = 209715200; # bytes
#$wgMaxShellMemory = 204800; # in KB

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 admin[at]wikispooks.org and encrypted with this key.

Known Issues

  • xdebug is a php debugging tool which produces output similar (but considerably more verbose) to $wgShowExceptionDetails 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 max_nesting_level from the default 100 with the following if you wish to use it: xdebug.max_nesting_level=300
  • The backups do not include the Anon Uploads Form or Piwik stats.
  • Suggestions, Queries etc? - Either Email the admin (non-Wikispooks members) or use this discussion page (Wikispooks members)
Wikispooks logo.png Policy.png Wikispooks to do.png Tools2.png
Wikispooks
Technical
SMW.png Help.png