Installation

From semantic-mediawiki.org
Jump to: navigation, search
Installation
This page describes how to how install Semantic MediaWiki.
Image / Video collection
Further Information
Installation type: N/A
Installation method: N/A
MediaWiki version: N/A
Table of Contents

The recommended way for installing Semantic MediaWiki is by using Composer, but if you cannot use Composer for installation and upgrading, you have the option to install the file release as described on this help page.

NoteNote:The instructions on this page to install, upgrade and update Semantic MediaWiki do not apply to the Semantic Bundle which also uses Semantic MediaWiki. See the help page on the Semantic Bundle for how to do this.
  • Please always check the exact requirements and follow the instructions carefully. Make sure you understand the legal disclaimer in the file [1] before proceeding.
  • To upgrade a wiki running an older version of SMW, be sure to read the relevant section before starting the upgrade.
  • Important noteImportant Note:
    If you are using MediaWiki 1.23 and higher and/or PHP 5.4 and higher you are strongly encouraged to install or to update to Semantic MediaWiki 2.0 or higher. Semantic MediaWiki 1.9 and lower is discouraged for production use with these versions.

General notes

  • Semantic MediaWiki has dependencies that will be made available during the installation.
  • Individual extensions to Semantic MediaWiki, e.g. extension "Semantic Result Formats"Provides additional formats for semantic queries may have different requirements.
  • Individual extensions to Semantic MediaWiki may not be compatible with the "~2.5" release (yet). Please see those extensions' documentation pages, or contact the respective developers, for further information.
  • The ConfirmEdit 1 extension is known to cause limitations in the functioning of Semantic MediaWiki when used on MediaWiki 1.26.x. You are advised to upgrade MediaWiki to version 1.27.0 or later.

Environment

  • It is required 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, Semantic MediaWiki 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, Semantic MediaWiki needs the rights to create new tables (CREATE) and to alter tables (ALTER TABLE). You can remove both rights after Semantic MediaWiki is set up. The maintenance script "setupStore.php"Allows to set up the data backend/store 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 configuration parameter $smwgDefaultStoreSets the storage backend to be used for the semantic data set to a SQL data backend (default), Semantic MediaWiki 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".
  • Some notes and related settings for a multi-database environment
  • Webserver notes lists settings or limitations that are imposed by a specific webserver environment

Recommendations

  • Extended list of recommendations and settings
  • 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 on the information page on compatibility. Please make sure that you meet them prior to installing Semantic MediaWiki.

Instructions

Installing

Please select the most appropriate installation instruction for your environment and for the latest available "~2.5" release. There is also a help page on how to install on a Windows-based server.

Help pageShort descriptionInstallation typeInstallation method
Installation without shell access using tarballs (MediaWiki 1.19+)This pages describes the installation where no shell access is available by using a tarball source.newTarball download
Installation with shell access using Composer (MediaWiki 1.25+)This pages describes the installation using native Composer supportnewUsing Composer
Important noteImportant Note: Please also consult our page on Troubleshooting in case you encounter issues during the process.

Upgrading

Help pageShort descriptionInstallation typeInstallation method
Installation/Upgrade from ≤ SMW 1.7.xThis pages describes the upgrade proposal for ≤ SMW 1.7.x.upgradeTarball download
Installation/Upgrade from SMW 1.8.xThis pages describes the upgrade procedure for SMW 1.8.x.upgradeUsing Composer
Installation/Upgrade from SMW 1.9+ for MW 1.22+This page describes the upgrade procedure from SMW 1.9+ (MW 1.22+ / native Composer support).upgradeUsing Composer
Installation/Upgrade from SMW 1.9+ for MW 1.19 - 1.21Upgrading from SMW 1.9.x or 2.0 (MW 1.19+ / non-native Composer support).upgradeUsing Composer
Important noteImportant Note: Please also consult our page on Troubleshooting in case you encounter issues during the process.

Testing

It is good practice that after a successful installation (together with all necessary maintenance tasks) it is tested by running automated tests in order to verify that a system works as intended but it is recommended that tests are not run on a production server.

The instruction on how to run automated tests can be found here.

Troubleshooting

If during or after the installation some unfamiliar messages occur, please have a look at the troubleshooting page otherwise don't hesitate to reach out via Help:Getting support or create an inquiry using the issue tracker.

References

  1. ^  Semantic MediaWiki: GitHub issue gh:smw:1406