Help:Installation

From semantic-mediawiki.org
(Redirected from Help:Installation 1.9.x)
Jump to: navigation, search
Has name::Installation
Has description::This page describes how to how install Semantic MediaWiki.
Image / Video collection
{{#subobject:|Has video url=https://vimeo.com/82255034%7CHas description=Installation of Semantic MediaWiki using Composer|Has video type=informational|Has video provider=Vimeo|Has video id=82255034 }}
Further Information
Installation type: Has installation type::N/A
Installation method: Has installation method::N/A
mediawikiMinVersion: MediaWiki minimum version::N/A
Table of Contents
{{#set: Has installation document status=valid }}

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 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.

  • There is also a help page on how to install on a Windows-based server.
  • 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.
  • NoteNote: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 productive 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. 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 CiteRef::gh:smw:1406 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.

Instructions

Please select the most appropriate installation instruction for your environment and for the latest available "~2.4" release.

{{#ask:

Has installation document status::valid
Has installation type::new
Has interlanguage link.Page content language::en
|?Has description=Short description
|?Has installation type=Installation type
|?Has installation method=Installation method
|mainlabel=Help page
|sort=Has installation document status,Has installation type,Has installation method
|order=desc,asc,asc

}}

Other instructions

{{#ask:


Has installation type::new
OR
Has installation type::upgrade

|?Has description=Short description
|?Has installation type=Installation type
|?Has installation method=Installation method
|?Has installation document status=Document status
|?Docinfo language=Language
|mainlabel=Help page
|sort=Has installation document status,Has installation type,Has installation method
|order=desc,asc,asc

}}

Tests

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. Template:Interlanguagelink:en
{{#set: |docinfo status=effective }}{{#set: |worn by =Template:Docinfo |warning =Master page updated }}{{#set:

|worn by =Template:Docinfo
|warning =No description
}}{{#set:

|revision id=47793 |namespace=Help |docinfo progress =100 |docinfo priority =1 }}{{#set:docinfo master page=Help:Installation }}{{#set:docinfo master rev =47793 }}{{#set:docinfo category=Category:Manual}}{{#set:docinfo author=User:Kghbln}}{{#set:docinfo editor=User:MWJames}}{{#set:docinfo support=-}}{{#set:docinfo language=en}}

This documentation page applies to all SMW versions from 2.0 to the most current version.
Other versions: {{#ask: Docinfo master page::Help:Installation Docinfo language::en from version::!2.0|
   ?from version = |
   ?to version = |
   sort = from version|
   order = desc|
   link=none|
   format=list|
   sep=, |
   template=versionlink|
   limit = 3|
   searchlabel = […]
  }}       Other languages: {{#ask: Docinfo master page::Help:Installation from version::2.0 Docinfo language::!en|
  ?Docinfo language =|
  link=none|
  format=list|
  sep=, |
  template=languagelink|
  sort = Docinfo language|
  order = asc|
  limit = 10|
  searchlabel = […]
}}

Docinfo master page::Help:Installation Docinfo language::en from version::2.0

{{#set:Release status=current}}

{{#set:Is master page=true}}