puppet-sogo

Module to manage SOGo groupware

Example

$database = 'postgresql://sogo@127.0.0.1/sogo'

class { 'sogo':
    # postgresql support
    extra_packages => ['sope4.9-gdl1-postgresql'],
    config => {
        'SOGoProfileURL' => "${database}/sogo_user_profile",
        'OCSFolderInfoURL' => "${database}/sogo_folder_info",
        'OCSSessionsFolderURL' => "${database}/sogo_sessions_folder",
        'SOGoSieveScriptsEnabled' => 'YES',
        'SOGoMailCustomFromEnabled' => 'YES',
        'SOGoUserSources' => [
          {
            'type'                  => 'sql',
            'id'                    => 'directory',
            'viewURL'               => 'postgresql://sogo@127.0.0.1/sogo/sogo_view',
            'canAuthenticate'       => 'YES',
            'isAddressBook'         => 'YES',
            'userPasswordAlgorithm' => 'md5',
          },
        ],
    },
    envconfig => {
        'PREFORK' => 3,
    },
}

Multiple user sources can be defined as an array of hashes

class { 'sogo':
...
    config => {
        'SOGoUserSources' => [
          {
            'type' => 'sql',
            'id' => 'directory',
            'viewURL' => "${database}/sogo_view",
            'canAuthenticate' => 'YES',
            'isAddressBook' => 'YES',
            'userPasswordAlgorithm' => 'md5',
          },
          {
            'type' => 'sql',
            'id' => 'addressbook',
            'viewURL' => "${database}/sogo_view_addresses",
            'canAuthenticate' => 'NO',
            'isAddressBook' => 'YES',
          },
        ],
    }
...
}

Multidomain example

class { 'sogo':
...
    config => {
      'domains' => {
        'example.org' => {
          'SOGoSieveScriptsEnabled' => 'NO',
          'SOGoUserSources' => [
            {
              'type' => 'sql',
              'id' => 'directory',
              'viewURL' => 'postgresql://sogo@127.0.0.1/sogo/sogo_view',
            },
          ],
        },
        'example.net' => {
          'SOGoSieveScriptsEnabled' => 'YES',
          'SOGoUserSources' => [
            {
              'type' => 'sql',
              'id' => 'directory',
              'viewURL' => 'postgresql://sogo@127.0.0.1/sogo/sogo_view',
            },
          ],
        },
      },
    }
...

Reference

Table of Contents

Classes

Public Classes

• sogo: SoGo init class

Private Classes

• sogo::config: Manage SoGo configuration
• sogo::envconfig: Manage SoGo environment parameters
• sogo::install: Manage SoGO installation
• sogo::service: Manage SoGo service

Classes

sogo

SoGo init class

Parameters

The following parameters are available in the sogo class.

package_name

Data type: String

Name of the SOGo package

package_ensure

Data type: String

Ensure for package resource

extra_packages

Data type: Array[String]

Additional packages to install using package_ensure as ensure value

service_name

Data type: String

Name of the SOGo service

service_ensure

Data type: String

Ensure for service resource

config_path

Data type: String

Path to configuration file

envconfig_path

Data type: String

path to environment configuration

config

Data type: Hash

SOGo configuration

envconfig

Data type: Hash

environment configuration

Changelog

All notable changes to this project will be documented in this file.

v1.0.0 (2020-11-22)

All commits

Changes:

• Breaking change: Extended templating #5 by @mat1010

Until this change the Puppet Hash type was templated as an SOGo config array with the hash as it's only element. After it, Puppet types are rendered as their correct counterparts. As the config key SOGoUserSources requires an SOGo config array, you probably have to adjust the value provided to the $config parameter.

v0.3.0 (2020-10-14)

All commits

Changes:

• Add rspec tests #2 by @mat1010
• Add acceptance tests #3 by @mat1010
• Allow array of hashes in sogo.conf #4 by @mat1010