REFERENCE.md

Reference

Table of Contents

Classes

• roundcube: the main roundcube class
• roundcube::config: roundcube configuration
• roundcube::db: configure database
• roundcube::db::mysql: crate a mysql db for roundcube
• roundcube::install: install roundcube packages
• roundcube::vhost: creates a vhost for roundcube
• roundcube::vhost::apache: internal class that installs an apache vhost Parameters are inherited from roundcube::vhost

Defined types

• roundcube::plugin: configures plugins

Classes

roundcube

the main roundcube class

Parameters

The following parameters are available in the roundcube class:

• ensure_database
• ensure_vhost

ensure_database

Data type: Boolean

if true a database is created Defaults to false

Default value: false

ensure_vhost

Data type: Boolean

if true a virtualhost is created Defaults to false

Default value: false

roundcube::config

roundcube configuration

Parameters

The following parameters are available in the roundcube::config class:

• config_file
• configs
• owner
• group
• mode
• include_db_config
• plugins
• plugin_config_dir

config_file

Data type: String

configuration file to use

Default value: '/etc/roundcube/config.inc.php'

configs

Data type: Hash

Hash of configuration variables to set. Defaults to {}

Default value: {}

owner

Data type: String

owner of the config file

Default value: 'root'

group

Data type: String

group of the config file

Default value: 'www-data'

mode

Data type: String

mode of the config file

Default value: '0640'

include_db_config

Data type: String

Default value: '/etc/roundcube/debian-db-roundcube.php'

plugins

Data type: Hash

plugings with configuration to generate (uses create_resources for roundcube::plugin define, simplifies hiera usage !)

Default value: {}

plugin_config_dir

Data type: String

the default config directory to use for plugins only used if roundcube::config::plugins parameter is used

Default value: '/etc/roundcube/plugins'

roundcube::db

configure database

Parameters

The following parameters are available in the roundcube::db class:

• dbpass
• dbtype
• dbname
• dbuser
• basepath
• dbport
• host
• dbconfig_inc

dbpass

Data type: String

password to connect to the database.

Default value: 'CHANGEME'

dbtype

Data type: String

database type to use currently only mysql is supported. defaults to 'mysql'

Default value: 'mysql'

dbname

Data type: String

name of the database defaults to: 'roundcube'

Default value: 'roundcube'

dbuser

Data type: String

username to connect to the database. defaults to: 'roundcube'

Default value: 'roundcube'

basepath

Data type: Optional[String]

basepath for database, defaults to undef

Default value: undef

dbport

Data type: String

port to connect to db defaults to '3306' (mysql)

Default value: '3306'

host

Data type: String

host that is allowed to connect defaults to 'localhost'

Default value: 'localhost'

dbconfig_inc

Data type: String

where to write the db config. defaults to '/etc/roundcube/debian-db.php' if you do not want to write, set it to ''

Default value: '/etc/roundcube/debian-db.php'

roundcube::db::mysql

crate a mysql db for roundcube

Parameters

The following parameters are available in the roundcube::db::mysql class:

• dbname
• dbuser
• dbpass
• host
• collate
• charset

dbname

Data type: String

the name of the database

Default value: $roundcube::db::dbname

dbuser

Data type: String

db user

Default value: $roundcube::db::dbuser

dbpass

Data type: String

password for the user

Default value: $roundcube::db::dbpass

host

Data type: String

database host

Default value: $roundcube::db::host

collate

Data type: Optional[String[1]]

set collate

Default value: undef

charset

Data type: Optional[String[1]]

set charset

Default value: undef

roundcube::install

install roundcube packages

Parameters

The following parameters are available in the roundcube::install class:

• packages
• package_ensure

packages

Data type: Array

the packages to install

Default value: ['roundcube']

package_ensure

Data type: String

what to ensure for packages

Default value: 'installed'

roundcube::vhost

This class chooses the type of vhost to run webserver

Parameters

The following parameters are available in the roundcube::vhost class:

• vhosttype
• servername
• serveraliases
• docroot
• ssl
• ssl_cert
• ssl_key
• ssl_chain
• redirect_to_ssl
• create_resources

vhosttype

Data type: String

type of vhost to run. currently only apache supported (default)

Default value: 'apache'

servername

Data type: String

Servername (defaults to $::fqdn)

Default value: $facts['networking']['fqdn']

serveraliases

Data type: Array

Array of Serveraliasess to listen to (default [])

Default value: []

docroot

Data type: Stdlib::Absolutepath

Document root

Default value: '/var/lib/roundcube'

ssl

Data type: Boolean

If true, use ssl (defaults to false) If true, you also need to set cert, key and chain.

Default value: false

ssl_cert

Data type: Optional[Stdlib::Absolutepath]

ssl cert to use

Default value: undef

ssl_key

Data type: Optional[Stdlib::Absolutepath]

ssl key to use

Default value: undef

ssl_chain

Data type: Optional[Stdlib::Absolutepath]

ssl chain to use

Default value: undef

redirect_to_ssl

Data type: Boolean

if true, redirects all non https requests to https defaults to true.

Default value: true

create_resources

Data type: Hash

a Hash of Hashes to create additional resources eg. to retrieve a certificate. Defaults to {} (do not create any additional resources) Example (hiera):

roundcube::vhost::create_resources: sslcert::get_cert: get_my_roundcube_cert: private_key_path: '/etc/roundcube/ssl/key.pem' cert_path: '/etc/roundcube/ssl/cert.pem'

Will result in executing:

sslcert::get_cert{'get_my_roundcube_cert': private_key_path => '/etc/roundcube/ssl/key.pem' cert_path => '/etc/roundcube/ssl/cert.pem' }

Default value: {}

roundcube::vhost::apache

internal class that installs an apache vhost Parameters are inherited from roundcube::vhost

Parameters

The following parameters are available in the roundcube::vhost::apache class:

• servername
• serveraliases
• docroot
• apache_vhost
• ssl
• ssl_cert
• ssl_key
• ssl_chain
• redirect_to_ssl

servername

Data type: String

Default value: $roundcube::vhost::servername

serveraliases

Data type: Array

Default value: $roundcube::vhost::serveraliases

docroot

Data type: Stdlib::Absolutepath

Default value: $roundcube::vhost::docroot

apache_vhost

Data type: Hash

Default value: {}

ssl

Data type: Boolean

Default value: $roundcube::vhost::ssl

ssl_cert

Data type: Optional[Stdlib::Absolutepath]

Default value: $roundcube::vhost::ssl_cert

ssl_key

Data type: Optional[Stdlib::Absolutepath]

Default value: $roundcube::vhost::ssl_key

ssl_chain

Data type: Optional[Stdlib::Absolutepath]

Default value: $roundcube::vhost::ssl_chain

redirect_to_ssl

Data type: Boolean

Default value: $roundcube::vhost::redirect_to_ssl

Defined types

roundcube::plugin

configures plugins

Parameters

The following parameters are available in the roundcube::plugin defined type:

• plugin_config_dir
• configs
• plugin_name
• owner
• group
• mode

plugin_config_dir

Data type: String

directory

configs

Data type: Hash

the configurations

Default value: {}

plugin_name

Data type: String

name of the plugin

Default value: $title

owner

Data type: String

owner of the config file

Default value: 'root'

group

Data type: String

group of the config file

Default value: 'root'

mode

Data type: String

mode of the config file

Default value: '0644'