sympa

Table of Contents

1. Description
2. Setup - The basics of getting started with sympa
   • What sympa affects
   • Setup requirements
   • Beginning with sympa
3. Usage - Configuration options and additional functionality
4. Limitations - OS compatibility, etc.
5. Development - Guide for contributing to the module

Description

This module install a mailing list server named Sympa.

Setup

What sympa affects

With manage_user at true the module creates a local account on system.

With manage_database at true the module installs a PostgreSQL database server and database with role.

Setup Requirements

As a web app, you have to configure a web server. To do so with Puppet, it is possible to use :

• puppetlabs-apache
• puppet-nginx

Beginning with sympa

The very basic steps can be simple :

include sympa

But it's better to change db_password at least.

Usage

To customize topics :

class { 'sympa':
  topics => {
    'topic1' => {
      'en' => 'Topic one in English',
      'fr' => 'Cathégorie une en Français',
    },
  },
}

Reference

Details are in REFERENCE.md file.

Limitations

Supported OSes are given in metadata.json file.

This module support only PostgreSQL as backend.

Development

Home at URL https://gitlab.adullact.net/adullact/puppet-sympa

Issues and MR are welcome.

Release Notes/Contributors/Etc.

Details in CHANGELOG.md.

Copyright (C) 2025 Association des Développeurs et Utilisateurs de Logiciels Libres
                     pour les Administrations et Colléctivités Territoriales.

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/agpl.html>.

Reference

Table of Contents

Classes

• sympa: Install and configure Sympa mailing list manager

Data types

• Sympa::Topics: Hash representing topics (categories) of a mailing list.

Classes

sympa

Install and configure Sympa mailing list manager

Examples

include sympa

Parameters

The following parameters are available in the sympa class:

• manage_user
• user
• group
• manage_database
• db_host
• db_name
• db_user
• db_password
• prefix_path
• sysconf_dir
• aliases_file
• release
• listdomain
• listmaster
• lang
• topics

manage_user

Data type: Boolean

if true this puppet module manage user account settings.

Default value: true

user

Data type: String[1]

User account name

Default value: 'sympa'

group

Data type: String[1]

User account group name.

Default value: 'sympa'

manage_database

Data type: Boolean

If true this module manage postgreSQL server and database backend.

Default value: true

db_host

Data type: String[1]

Address of the database server with TCP connection (5432 is used as port).

Default value: 'localhost'

db_name

Data type: String[1]

Name of used database.

Default value: 'sympa'

db_user

Data type: String[1]

User for the database connection.

Default value: 'sympa'

db_password

Data type: Variant[String[1], Sensitive[String[1]]]

Password for the database connection.

Default value: 'changeme'

prefix_path

Data type: Stdlib::Absolutepath

Install Sympa files in this path.

Default value: '/home/sympa'

sysconf_dir

Data type: String[1]

Configuration dir under prefix_path

Default value: 'etc'

aliases_file

Data type: String[1]

Aliases file to store Sympa mail aliases, under sysconfig_dir

Default value: 'sympa_aliases'

release

Data type: String[1]

Installed release number of Sympa.

Default value: '6.2.74'

listdomain

Data type: Stdlib::Fqdn

Primary mail domain name. Web interface for Sympa mailing list manager, can be joined at https://$listdomain

Default value: 'listes.example.org'

listmaster

Data type: Stdlib::Email

Email addresses of listmaster

Default value: 'listmaster@example.org'

lang

Data type: Enum['fr']

Supported language

Default value: 'fr'

topics

Data type: Sympa::Topics

Defines topics (categories) of the mailing lists.

Default value: {}

Data types

Sympa::Topics

Hash representing topics (categories) of a mailing list.

Alias of

Hash[String, Struct[{
      'en' => String[1],
      'fr' => String[1],
  }]]

Changelog

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

Release 1.0.1

• manage_user and dependencies #8

Release 1.0.0

Initial release