summaryrefslogtreecommitdiff
path: root/www/wiki/skins/chameleon/docs/installation.md
blob: 03f5e86de7352797df4dda4f4da68d3562114f8d (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
## Installation, Update, De-Installation

### Requirements

- PHP 5.3.2 or later (*)
- MediaWiki 1.22 or later
- [Composer][composer]

Further required software packages will be installed automatically. It is *not*
necessary to install any dependencies anymore. Composer will take care of that.

(*) To use the *[Html](components.md#component-html)* component in [custom
layouts](customization.md#creating-a-custom-layout) you need at least PHP 5.3.6.

### Installation

If unsure try the detailed installation instructions for
[Windows](installation-windows.md) or [Linux](installation-linux.md).

Here is the short version:

1. On a command line go to your MediaWiki installation directory
4. Open the `composer.local.json` file in an editor and add the Chameleon skin
   to the `require` section:
   ```
   "require": {
       "mediawiki/chameleon-skin": "~1.0"
   }
   ```
   * Remark 1: If you do not have a `composer.local.json` file (MediaWiki <1.25),
     use `composer.json` instead.
   
   * Remark 2: If you do not have a `composer.json` file (MediaWiki <1.23.5),
     copy `composer.json.example` to `composer.json` first.
3. With Composer installed, run
   `composer update "mediawiki/chameleon-skin"`
4. To set Chameleon as the default skin, open `LocalSettings.php` in an editor,
   find `$wgDefaultSkin` and amend it: `$wgDefaultSkin='chameleon';`
5. __Done:__ Navigate to _Special:Version_ on your wiki to verify that the skin
   is successfully installed.

If you run into problems, try the
[troubleshooting](installation-troubleshooting.md).

### Update

From your MediaWiki installation directory run `composer update
"mediawiki/chameleon-skin"`

### De-installation

Before de-installation make sure you secure (move, backup) any custom files you
might want to retain.

Remove the Chameleon skin from the `composer.local.json` file. Then run
`composer update "mediawiki/chameleon-skin"` from the MediaWiki installation
directory.

[composer]: https://getcomposer.org/