View source for Help:Installation/Using Composer with MediaWiki 1.22 - 1.24

{{Installation
 |Description=This pages describes the installation using native Composer support for MediaWiki 1.22 - 1.24
 |Installation type=new
 |Installation method=Composer
}}

== Install ==
Use these instructions for a new SMW installation. 

# Install [[wikipedia:en:Composer (software)|Composer]] - please follow the instructions at [http://getcomposer.org/doc/00-intro.md#installation-nix installing Composer] to do this.
# Check your MediaWiki version on special page "Special:Version" to ensure compatibility. See also [[mws:Manual:Upgrading|Update to the appropriate version of MediaWiki]].
# Run the installation script<ref>Note that, if you have Git installed, it's recommended to install composer with the "--prefer-source" flag, so that Composer uses Git to download the code. In other words, instead of calling "composer install" or "php composer.phar install", as that page states, you should call "composer install --prefer-source" or "php composer.phar install --prefer-source".</ref> from the base directory<ref name="base">This is the directory which contains the "LocalSettings.php" file.</ref> of your MediaWiki installation:<ref name="comglob">In case you installed Composer "globally" on your server, you will have to drop the <code>php</code> and <code>.phar</code> particles from the command.</ref>
#: <syntaxhighlight lang="text">php composer.phar require mediawiki/semantic-media-wiki "~2.1"</syntaxhighlight>
#: {{Note}} The version stated in the line above is provided as an example. See the [https://github.com/SemanticMediaWiki/SemanticMediaWiki/releases Releases page on GitHub] for newer releases. If there is e.g. a release called "SMW 2.2.0" you will have to replace <code>"~2.1"</code> by {{LatestAvailableStableReleaseForComposer}} etc. Please always omit the bugfix release number, i.e. the third number.
# Run the setup script from the base directory<ref name="base" /> of your MediaWiki installation:
#: <syntaxhighlight lang="text">php maintenance/update.php</syntaxhighlight>
# Add a call to <code>enableSemantics()</code> to the end of the "LocalSettings.php" file. <code>enableSemantics()</code> takes in the domain name of the wiki; a wiki located at "example.org", for instance, should have the following call:
#: <syntaxhighlight lang="php">enableSemantics( 'example.org' );</syntaxhighlight>
#: The calls <code>require_once …</code> must neither be added for Semantic MediaWiki nor for Validator since Composer loads the extensions automatically.
# Add optional settings<ref name="config">See the help page on [[Help:Configuration|configuring SMW]]. Usually only a few configuration parameters have to be changed if there is a need to do so at all.</ref> apart from one exception<ref name="index">If you manually set [[Help:$smwgNamespaceIndex|<code>$smwgNamespaceIndex</code>]] to something other than the default value of <code>100</code>, you must do this ''above'' the enableSemantics() line instead. Make sure that the value set is ≥ <code>100</code> as well as an even number.</ref> to the "LocalSettings.php" file as desired ''below'' the <code>enableSemantics()</code> call.
# In case you want to use additional [[Help:SMW extensions|semantic extensions]] which are '''not''' installed via Composer like e.g. [[Semantic Drilldown]] you still have to invoke them by adding the respective line <code>require_once …</code> to you "LocalSettings.php" file ''below'' the <code>enableSemantics()</code> call.
# See the page "Special:Version" on your wiki to verify that the extension is successfully installed.
# Test your installation as described on the help page about [[Help:Testing|testing SMW]].
# Done!

== Update ==
Use these instructions to update an existing SMW installation. 

# Backup your database and installation.
# Run the update script from the base directory<ref name="base" /> of your MediaWiki installation:<ref name="comglob" />
#: <syntaxhighlight lang="bash">php composer.phar update</syntaxhighlight>
# See the page "Special:Version" on your wiki to verify that the extension was successfully updated.
# Run the setup script from the base directory<ref name="base" /> of your MediaWiki installation:
#: <syntaxhighlight lang="bash">php maintenance/update.php</syntaxhighlight>
# Run the refresh database script from the base directory<ref name="base" /> of your MediaWiki installation:<ref name="refresh">This is an optional step to take to assure that the semantic store is valid and up to date.</ref>
#: <syntaxhighlight lang="bash">php extensions/SemanticMediaWiki/maintenance/SMW_refreshData.php -d 50 -v</syntaxhighlight>
# Done!

== MW 1.25+ ==

Starting with MW 1.25+ MediaWiki itself uses Composer to facilitate components and packages. In case you see the following message ''[RuntimeException] The lock file does not contain require-dev information, run install with the --no-dev option or run update to install those packages.'' when trying to run <code>composer require ...</code>, you first have to execute <code>composer install</code> before you are able to add extensions via Composer. See also the help page on [[Help:Installation/Using Composer with MediaWiki 1.25+|installing SMW on MediaWiki 1.25.+]].

== Upgrade ==
See the help page on [[Help:Installation/Upgrade from SMW 1.9+ for MW 1.22+|upgrading from SMW 1.9+ for MW 1.22+]]

== See also ==
* [[Help:Installation/Installation commands for Composer|Installation commands for Composer]]
* [[Help:Installation/Example_"composer.json"_file|Example "composer.json" file]]

== References ==
<references/>
{{docinfo
| master page = Help:Installation/Using Composer with MediaWiki 1.22 - 1.24
| master rev  = {{REVISIONID}}
| master link = internal
| status   = effective
| progress = 100
| priority = 1
| category = Manual
| author = Kghbln
| editor = {{REVISIONUSER}}
| minversion = 2.0
| lang = en
| return =
| nowarn
}}

[[Category:Installation]]