Puppet Class: dokuwiki

Inherits:
dokuwiki::params
Defined in:
manifests/init.pp

Summary

This module manages and install dokuwiki.

Overview

dokuwiki

This module manages and install dokuwiki.

Examples:

class { 'dokuwiki':
  wiki_title => 'My awesome dokuwiki'
}

Parameters:

  • wiki_title (String) —

    The title of this wiki, will be displayed on all the pages.

  • admin_user (String) (defaults to: $dokuwiki::params::admin_user) —

    The username of the admin user, can be left empty if default_acl is open

  • admin_passwordhash (String) (defaults to: $dokuwiki::params::admin_password) —

    The password hash of the admin user. To generate the hash use the mkpasswd, which is part of the whois package. Generate the password using the following command: “‘mkpasswd -m sha-512 -s <<< YourPass“`

  • admin_real_name (String) (defaults to: $dokuwiki::params::admin_real_name) —

    The real name of the admin user

  • admin_email (String) (defaults to: $dokuwiki::params::admin_email) —

    The e-mail adres of the admin user

  • admin_groups (Array) (defaults to: $dokuwiki::params::admin_groups) —

    An array of group for the admin user.

  • manage_webserver (Boolean) (defaults to: $dokuwiki::params::manage_webserver) —

    If enabled (default), this module will also manages and installs apache

  • manage_php (Boolean) (defaults to: $dokuwiki::params::manage_php) —

    If enabled (default), this module also manages and installs php

  • enable_ssl (Boolean) (defaults to: $dokuwiki::params::enable_ssl) —

    If enabled, this module will enable ssl and also a redirect to port 443 from port 80

  • servername (String) (defaults to: $dokuwiki::params::servername) —

    Default set to the fqdn fact is used for the redirect of port 80 to port 443. Make sure this name is resolve able by the clients accessing the server.

  • ssl_cert (String) (defaults to: $dokuwiki::params::ssl_cert) —

    Defaults to the selfsigned snakeoil certificate, but can be used to change the certificate used by the apache instance

  • ssl_key (String) (defaults to: $dokuwiki::params::ssl_key) —

    Defaults to the selfsigned snakeoil private key, but can be used to change the privatekey used by the apache instance

  • ssl_ca (Optional[String]) (defaults to: $dokuwiki::params::ssl_ca) —

    Defaults to undef, but can be used to specify the cachain that apache will sent.

  • lang (String) (defaults to: $dokuwiki::params::lang) —

    The language of the dokuwiki

  • license (String) (defaults to: $dokuwiki::params::license) —

    The default license used for all the content placed on the dokuwiki

  • useacl (Integer) (defaults to: $dokuwiki::params::useacl) —

    If set to 1 the ACL module is enable and the dokuwiki will use the acl.auth.php config file

  • default_acl (Enum['public', 'open', 'closed']) (defaults to: $dokuwiki::params::default_acl) —

    Specifiy the default acl. Open means: anyone can edit, Public means: anyone can view; users can edit, Closed means: only users can view and edit

  • replace_acl (Boolean) (defaults to: $dokuwiki::params::replace_acl) —

    If set, this module will replace contents of the ACL, possibly revering changes done in the webinterface. Dokuwiki does not recommend this.

  • replace_local (Boolean) (defaults to: $dokuwiki::params::replace_local) —

    If set (default unset), this module will replace contents of the local.php file, possibly reverting changes done in the webinterface.

  • replace_users_auth (Boolean) (defaults to: $dokuwiki::params::replace_users_auth) —

    If set, this module will replace contents in the users.auth.php file, possibly reverting changes done in the webitnerface.

  • superuser (String) (defaults to: $dokuwiki::params::superuser) —

    This variable determines which user or group defines the super admins

  • disableactions (String) (defaults to: $dokuwiki::params::disableactions) —

    This variable can be used to disable specific actions: like registering. See www.dokuwiki.org/config:disableactions for more information

  • userewrite (Integer[0, 2]) (defaults to: $dokuwiki::params::userewrite) —

    The variable can be used to enable rewrites. Defaults to 0.



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
 
# File 'manifests/init.pp', line 45

class dokuwiki (
  String $wiki_title,
  String $admin_user = $dokuwiki::params::admin_user,
  String $admin_passwordhash = $dokuwiki::params::admin_password,
  String $admin_real_name = $dokuwiki::params::admin_real_name,
  String $admin_email = $dokuwiki::params::admin_email,
  Array $admin_groups = $dokuwiki::params::admin_groups,
  Boolean $manage_webserver = $dokuwiki::params::manage_webserver,
  Boolean $manage_php = $dokuwiki::params::manage_php,
  Boolean $enable_ssl = $dokuwiki::params::enable_ssl,
  String $ssl_cert = $dokuwiki::params::ssl_cert,
  String $ssl_key = $dokuwiki::params::ssl_key,
  Optional[String] $ssl_ca = $dokuwiki::params::ssl_ca,
  String $servername = $dokuwiki::params::servername,
  String $lang = $dokuwiki::params::lang,
  String $license = $dokuwiki::params::license,
  Integer $useacl = $dokuwiki::params::useacl,
  Enum['public', 'open', 'closed'] $default_acl = $dokuwiki::params::default_acl,
  Boolean $replace_acl = $dokuwiki::params::replace_acl,
  Boolean $replace_local = $dokuwiki::params::replace_local,
  Boolean $replace_users_auth = $dokuwiki::params::replace_users_auth,
  String $superuser = $dokuwiki::params::superuser,
  String $disableactions = $dokuwiki::params::disableactions,
  Integer[0, 2] $userewrite = $dokuwiki::params::userewrite,
) inherits dokuwiki::params {
  class {'dokuwiki::install':}
  -> class {'dokuwiki::config':}
  -> class {'dokuwiki::service':}
}