blob: aeb04a88a45b824541dc7108103cd09bdd41c25b (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
|
# Installation guide (brief)
This is a brief installation and configuration guide for [Semantic MediaWiki](../README.md) (SMW)
that only contains the core steps. More verbose installation instructions with additional explanation
and upgrading instructions can be found [here](https://www.semantic-mediawiki.org/wiki/Help:Installation).
A list of supported PHP versions, MediaWiki versions and databases per SMW release can be found
in the [compatibility matrix](COMPATIBILITY.md).
## Download and installation
### Installation with Composer
The strongly recommended way to install Semantic MediaWiki is with [Composer](http://getcomposer.org) using
[MediaWiki's built-in support for Composer](https://www.mediawiki.org/wiki/Composer).
#### Step 1
Change to the base directory of your MediaWiki installation. This is where the "LocalSettings.php"
file is located. If you have not yet installed Composer do it now by running the following command
in your shell:
wget https://getcomposer.org/composer.phar
#### Step 2
If you do not have a "composer.local.json" file yet, create one and add the following content to it:
```
{
"require": {
"mediawiki/semantic-media-wiki": "~3.0"
}
}
```
If you already have a "composer.local.json" file add the following line to the end of the "require"
section in your file:
"mediawiki/semantic-media-wiki": "~3.0"
Remember to add a comma to the end of the preceding line in this section.
#### Step 3
Run the following command in your shell:
php composer.phar update --no-dev
Note if you have Git installed on your system add the `--prefer-source` flag to the above command. Also
note that it may be necessary to run this command twice. If unsure do it twice right away.
#### Step 4
Run the MediaWiki [update script](https://www.mediawiki.org/wiki/Manual:Update.php). The location of
this script is `maintenance/update.php`. It can be run as follows in your shell:
php maintenance/update.php
#### Step 5
Add the following line to the end of your "LocalSettings.php" file:
enableSemantics( 'example.org' );
Note that "example.org" should be replaced by your wiki's domain.
#### Step 6
If you are installing SMW on a freshly installed wiki continue to the next step. If the wiki already has content
pages run the Semantic MediaWiki [data rebuild script](https://www.semantic-mediawiki.org/wiki/Help:Maintenance_script_"rebuildData.php"). The location of this script
is `extensions/SemanticMediaWiki/maintenance/rebuildData.php`. It can be run as follows in your shell:
php extensions/SemanticMediaWiki/maintenance/rebuildData.php -v
#### Verify installation success
As final step, you can verify SMW got installed by looking at the "Special:Version" page on your wiki and check that
the Semantic MediaWiki section is listed.
### Installation without shell access
As an alternative to installing via Composer, you can obtain the SMW code by creating your own [individual file release](https://github.com/SemanticMediaWiki/IndividualFileRelease) most likely if command line access to the webspace is not available or if the hoster imposes restrictions on required functionality.
Note that SMW no longer provides file releases [(See #3347).](https://github.com/SemanticMediaWiki/SemanticMediaWiki/pull/1732)
#### Step 1
Create your [individual file release](https://github.com/SemanticMediaWiki/IndividualFileRelease) using the respective script. Please pay attention to the MediaWiki version used in the script and adapt to your setup if necessary.
#### Step 2
Transfer the code thus compiled to the appropriate folders on your webspace.
#### Step 3
Add the following lines to the end of your "LocalSettings.php" file:
enableSemantics( 'example.org' );
Note that "example.org" should be replaced by your wiki's domain.
#### Step 4
Log in as a user with administrator permission to your wiki and go to the "Maintenance" tab on special page "Special:SemanticMediaWiki":
Click on the "Initialise or upgrade tables" button in the "Database maintenance" section to setup the
database.
#### Step 5
If you are installing SMW on a freshly installed wiki continue to the next step. If the wiki already has content
pages also do the following on page "Special:SemanticMediaWiki":
Click on the "Start updating data" button in the "Data rebuild" subsection of "Maintenance" tab
to activate the [automatic data update](https://www.semantic-mediawiki.org/wiki/Help:Repairing_SMW's_data).
#### Verify installation success
As final step, you can now verify SMW got installed by looking at the "Special:Version" page on your wiki and check that
the Semantic MediaWiki section is listed.
### Installation of development versions and release candidates
If you would like to install a development version or release candidate then replace the lines as stated in step 3 of the
"Installation with Composer" section with the following line
* master: `"mediawiki/semantic-media-wiki": "@dev"`
* legacy branch: `"mediawiki/semantic-media-wiki": "3.0.x@dev"`
* release candidate: `"mediawiki/semantic-media-wiki": "~3.0@rc"`
## More instructions
* [Verbose installation instructions](https://www.semantic-mediawiki.org/wiki/Help:Installation)
* [Upgrading instructions](https://www.semantic-mediawiki.org/wiki/Help:Installation#Upgrading)
* [Configuration instructions](https://www.semantic-mediawiki.org/wiki/Help:Configuration)
* [Administrator manual](https://www.semantic-mediawiki.org/wiki/Help:Administrator_manual)
|
