Defined Type: mediawiki::web::vhost

Defined in:
modules/mediawiki/manifests/web/vhost.pp

Overview

Define that sets up a virtualhost for a mediawiki wiki, according to the needs of the apache configuration used by the wikimedia foundation.

Parameters

docroot

The DocumentRoot of the virtualhost

ensure

The usual ensure parameter.

server_name

The ServerName of the vhost. Defaults to the resource title

server_aliases

Array of server aliases, or undef. Defaults to undef

wikibase_rewrites

Wether the wikibase rewrites should be added or not.

legacy_rewrites

Wether or not legacy rewrites should be added

public_rewrites

Rewrites for favicon, robots.txt necessary for public wikis

short_urls

Whether or not support for short urls should be added

https_only

Wether or not to force https everywhere.

encoded_slashes

AllowEncodedSlashes apache httpd directive.

canonical_name

Value of the UseCanonicalName httpd directive; only gets applied if server_aliases is not empty.

*$additional_rewrites*

A struct of early and late rewriterules to add before or after the main rewrites.

*$variant_aliases*

A list of language variant aliases for the current vhost.

declare_site

Wether to declare the site as enabled in the configuration of httpd or not.

domain_suffix

Suffix to use in redirects et al (prod/beta/staging use)

upload_rewrite

If non null, the struct will control how and if we rewrite requests

to /upload/; specifically:
* 'domain_catchall' (string) is the domain for which to do catchall
* 'rewrite_prefix'  (string) The prefix to use in the rewrite
php_fpm_fcgi_endpoint

Endpoint to use to reach php-fpm by default

Default: fcgi://127.0.0.1:8000
additional_fcgi_endpoints

Additional endpoints that can be reached with a specific

value of the PHP_ENGINE cookie. By default empty.
feature_flags

A general container for feature flags, that is changes to the

vhosts that we are introducing/testing and are destined to be the default for
all vhosts. The list will vary with time, and must be reflected in the
corresponding puppet type. Here is the list of currently effective feature
flags:
[]

Parameters:

  • docroot (String)
  • ensure (Wmflib::Ensure) (defaults to: present)
  • server_name (String) (defaults to: $title)
  • server_aliases (Optional[Array[String]]) (defaults to: undef)
  • wikibase_rewrites (Boolean) (defaults to: false)
  • public_rewrites (Boolean) (defaults to: true)
  • legacy_rewrites (Boolean) (defaults to: true)
  • short_urls (Boolean) (defaults to: false)
  • https_only (Boolean) (defaults to: false)
  • encoded_slashes (Enum['On', 'Off', 'NoDecode']) (defaults to: 'On')
  • canonical_name (Enum['On', 'Off']) (defaults to: 'Off')
  • additional_rewrites (Mediawiki::Rewrites) (defaults to: {'early' => [], 'late' => []})
  • variant_aliases (Array) (defaults to: [])
  • priority (Integer[0, 99]) (defaults to: 50)
  • declare_site (Boolean) (defaults to: false)
  • domain_suffix (String) (defaults to: 'org')
  • upload_rewrite (Optional[Mediawiki::Upload_rewrite]) (defaults to: undef)
  • php_fpm_fcgi_endpoint (Tuple[Wmflib::Php_version, String]) (defaults to: ['7.2', 'fcgi://127.0.0.1:8000'])
  • feature_flags (Mediawiki::Vhost_feature_flags) (defaults to: {})
  • additional_fcgi_endpoints (Array[Tuple[Wmflib::Php_version, String]]) (defaults to: []) 


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
 
# File 'modules/mediawiki/manifests/web/vhost.pp', line 56

define mediawiki::web::vhost(
    String $docroot,
    Wmflib::Ensure $ensure = present,
    String $server_name = $title,
    Optional[Array[String]] $server_aliases = undef,
    Boolean $wikibase_rewrites = false,
    Boolean $public_rewrites = true,
    Boolean $legacy_rewrites = true,
    Boolean $short_urls = false,
    Boolean $https_only = false,
    Enum['On', 'Off', 'NoDecode'] $encoded_slashes = 'On',
    Enum['On', 'Off'] $canonical_name = 'Off',
    Mediawiki::Rewrites $additional_rewrites = {'early' => [], 'late' => []},
    Array $variant_aliases = [],
    Integer[0, 99] $priority = 50,
    Boolean $declare_site = false,
    String $domain_suffix = 'org',
    Optional[Mediawiki::Upload_rewrite] $upload_rewrite = undef,
    Tuple[Wmflib::Php_version, String] $php_fpm_fcgi_endpoint = ['7.2', 'fcgi://127.0.0.1:8000'],
    Mediawiki::Vhost_feature_flags $feature_flags = {},
    Array[Tuple[Wmflib::Php_version, String]] $additional_fcgi_endpoints = [],
) {
    # The vhost content
    $content = template('mediawiki/apache/mediawiki-vhost.conf.erb')

    if $declare_site {
        httpd::site { $title:
            ensure   => $ensure,
            priority => $priority,
            content  => $content,
        }
    } else {
        # If we're not declaring a separate vhost
        file { "/etc/apache2/sites-available/${title}.conf":
            ensure  => $ensure,
            content => $content,
            owner   => 'root',
            group   => 'root',
            mode    => '0444',
            require => Package['apache2'],
            notify  => Service['apache2'],
        }
    }
}