Using Tarball (Installation without shell access)

From semantic-mediawiki.org
Jump to: navigation, search
InstallationUsing Tarball (Installation without shell access)Tarball download
Installation
This page describes how to install SMW where no shell access is available by using a Tarball source.
Further Information
Installation type: new
Installation method: Tarball
mediawikiMinVersion: N/A
Table of Contents

There is also a help page on how to install on a Linux based server and install on a Windows based server (requires shell access). Please always check the exact requirements and follow the instructions carefully. Make sure you understand the legal disclaimer in the file COPYING before proceeding.

To upgrade a wiki running an older version of SMW, be sure to read the relevant section before starting the upgrade.

General notes

  • Semantic MediaWiki has dependencies that will be made available during the installation.
  • Individual extensions to Semantic MediaWiki, e.g. Semantic Result Formats may have different requirements.
  • Individual extensions to Semantic MediaWiki may not be compatible with the "~2.4" release (yet). Please see those extensions' documentation pages, or contact the respective developers, for further information.
  • ConfirmEdit 1 extension(s) are known to cause limitations in the functioning of Semantic MediaWiki

Environment

  • It is expected that the PHP mbstring extension is enabled (provides PHP mb_*() multibyte functions such as mb_strpos in the php_mbstring.dll). This is standard but not enabled by default on some distributions of PHP.
  • When using a SPARQL backend, SMW and onoi/http-request requires access to the cURL functions of PHP. These functions may have to be enabled/installed to be available.
  • While not required (yet), it is suggested to have the PHP intl (ICU) extension enabled especially when Semantic MediaWiki is used in a UTF-8 (non-Latin) environment.
  • For users that require symbolic links, some information can be found here.

Settings

  • For installation and upgrade, SMW needs the rights to create new tables (CREATE) and to alter tables (ALTER TABLE). You can remove both rights after SMW is set up. The script "setupStore.php" can use the DB credentials from "LocalSettings.php" for this purpose, avoiding the need of extra rights for the wiki DB user.
  • When using the SQL backend (the default data store for SMW), SMW creates and alters temporary tables for certain semantic queries. To do this, the wiki's database user account must have privileges for CREATE TEMPORARY TABLES and DROP. If you don't wish to allow such privileges, please read how to disable the use of temporary tables in "LocalSettings.php".
  • It is highly recommended to have the parser cache and Semantic MediaWiki specific cache enabled and set to appropriate values.
  • Information about regular maintenance tasks and the job queue can be found here.

Requirements

Compatibility information and minimum requirements for Semantic MediaWiki are listed in the document on compatibility. Please make sure that you meet them prior to installing Semantic MediaWiki.

Download

Download a Semantic MediaWiki tarball and extract it into your extension directory.2

NoteNote:  Please choose one of the release files we prepared and uploaded for you that contain contain the dependencies for your deployment.

NoteNote:  Tarball releases can only run by themselves, i.e. if you would like to also use other extensions like e.g. Semantic Result Formats or Semantic Maps you cannot use the tarball release. See the information on individual file releases for a possible way out.

Installation

Extract and copy

Extract the downloaded file.

Copy the extracted folder and files to the …/extensions/ directory of your MediaWiki installation.

Add the required settings to the end of the "LocalSettings.php" file:

Enable Semantic MediaWiki

require_once "$IP/extensions/SemanticMediaWiki/SemanticMediaWiki.php";
enableSemantics( 'example.org' );

Add optional settings3 to the "LocalSettings.php" file as desired below the required settings.

Run maintenance script

Run the setup script from the base directory4 of your MediaWiki installation:
php maintenance/update.php

or

Screenshot of "Special:SMWAdmin"
Screenshot of "Special:SMWAdmin"

Log in as a user with administrator permission to your wiki and go to the page "Special:SMWAdmin":

  1. Click on the "Initialise or upgrade tables" button in the "Database installation and upgrade" section to setup the database. Note that this requires permissions to alter/create database tables, as explained at the top of this help page.
  2. Click on the "Start updating data" button in the "Data repair and upgrade" section to activate the automatic data update. Note that this takes some time; go to Special:SMWAdmin to follow its progress. SMW can be used before this completes, but will not have access to all data yet (e.g. page categories).

Check and verify

Navigate to "Special:Version" on your wiki to verify that the extension is successfully installed.

Test your installation as described on the help page about testing SMW.

Done!

Upgrading

Use these instructions to update an existing ≤ SMW 1.8.x installation from e.g. 1.8.0.5 to 1.9.0 etc.

Upgrading from SMW 1.8.x

  1. Backup your database and installation.
  2. Remove the formerly required invocation of "Validator" from the "LocalSettings.php" file, i.e. the following line:
    require_once "$IP/extensions/Validator/Validator.php";
    
  3. Re-install Semantic MediaWiki as described in the section on installing SMW though skipping step four and optionally step five.
  4. Log in as a user with administrator permission to your wiki and go to the page "Special:SMWAdmin".
    1. Click on the "Initialise or upgrade tables" button in the "Database installation and upgrade" section to setup the database. Note that this requires permissions to alter/create database tables, as explained at the top of this help page.
    2. Click on the "Start updating data" button in the "Data repair and upgrade" section to activate the automatic data update. Note that this takes some time; go to Special:SMWAdmin to follow its progress. SMW can be used before this completes, but will not have access to all data yet (e.g. page categories).
  5. Done!

Upgrading from ≤ SMW 1.7.x

Please upgrade to SMW 1.8.0.5 first as described on the help page on upgrading to SWM 1.8.x.

Updating SMW 1.9.x

Use these instructions to update an existing SMW 1.9 installation from e.g. 1.9.0 to 1.9.1 etc.

  1. Download the file release of Semantic MediaWiki.
  2. Extract the downloaded file.
  3. Copy the extracted folder and files to the …/extensions/ directory of your MediaWiki installation5
  4. Navigate to "Special:Version" on your wiki to verify that the extension is successfully installed.
  5. Log in as a user with administrator permission to your wiki and go to the page "Special:SMWAdmin":
    1. Click on the "Initialise or upgrade tables" button in the "Database installation and upgrade" section to setup the database. Note that this requires permissions to alter/create database tables, as explained at the top of this help page.
    2. Click on the "Start updating data" button in the "Data repair and upgrade" section to activate the automatic data update. Note that this takes some time; go to "Special:SMWAdmin" to follow its progress. SMW can be used before this completes, but will not have access to all data yet (e.g. page categories).
  6. Done!