Defined Type: mediawiki::skin

Defined in:
puppet/modules/mediawiki/manifests/skin.pp

Overview

Define: mediawiki::skin

This resource type represents a MediaWiki skin. Declaring a skin to Puppet will cause Puppet to retrieve the skin code from Gerrit and configure MediaWiki to load it.

Parameters

ensure

If 'present' (the default), Puppet will install the skin. If 'absent', Puppet will delete its configuration file, but it will not delete the cloned Git repository which contains the extension's files.

wiki

Wiki to add settings for. The default will install the settings for all wikis. The wiki name can also be specified in the resource's title as 'wiki:rest_of_title'.

skin

The canonical (CamelCase) name for the skin. This value is used to generate sensible defaults for the installation path and Gerrit repository name. Defaults to the resource title.

default

When set to true, the skin will be used as the default for anonymous users and logged-in users who did not change their defaults. When more then one skin resource sets this flag, the behavior is undefined.

branch

Specifies which branch of the skin's Git repository should be cloned. Defaults to 'master'.

settings

This parameter contains configuration settings for the skin. Settings may be specified as a hash, array, or string. See examples below. Empty by default.

composer

Whether this skin has dependencies that need to be installed via Composer. Default: false.

Examples

The following example configures the Vector skin and illustrates the use of hashes to specify settings:

mediawiki::skin { 'Vector':
  settings => {
    wgVectorUseSimpleSearch => false,
  },
}

Parameters:

  • ensure (Any) (defaults to: present)
  • wiki (Any) (defaults to: undef)
  • skin (Any) (defaults to: $title)
  • default (Any) (defaults to: false)
  • branch (Any) (defaults to: undef)
  • settings (Any) (defaults to: {})
  • composer (Any) (defaults to: false) 


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
 
# File 'puppet/modules/mediawiki/manifests/skin.pp', line 54

define mediawiki::skin(
    $ensure         = present,
    $wiki           = undef,
    $skin           = $title,
    $default        = false,
    $branch         = undef,
    $settings       = {},
    $composer       = false,
) {
    include ::mediawiki

    $mwbranch = $branch ? {
      undef   => $::mediawiki::branch,
      default => $branch,
    }
    $skin_dir = "${mediawiki::dir}/skins/${skin}"
    $skin_repo = "mediawiki/skins/${skin}"

    if ! defined(Git::Clone[$skin_repo]) {
        git::clone { $skin_repo:
            directory => $skin_dir,
            branch    => $mwbranch,
            require   => Git::Clone['mediawiki/core'],
        }
    }

    mediawiki::settings { $title:
        ensure  => $ensure,
        wiki    => $wiki,
        header  => template('mediawiki/skin.php.erb'),
        values  => $settings,
        require => Git::Clone[$skin_repo],
    }

    if $composer {
        php::composer::install{ $skin_dir:
            require => Git::Clone[$skin_repo],
        }

        Php::Composer::Install[$skin_dir] ~> Mediawiki::Settings[$title]
    }
}