Skip to content
Snippets Groups Projects
Fabien Combernous's avatar
Fabien Combernous authored
Resolve "drop unused parameters"

Closes #4

See merge request !3
d371bc66
History

sympa

Table of Contents

  1. Description
  2. Setup - The basics of getting started 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 OPTIONAL

If it's obvious what your module touches, you can skip this section. For example, folks can probably figure out that your mysql_instance module affects their MySQL instances.

If there's more that they should know about, though, this is the place to mention:

  • Files, packages, services, or operations that the module will alter, impact, or execute.
  • Dependencies that your module automatically installs.
  • Warnings or other important notices.

Setup Requirements OPTIONAL

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

As backend, PostgreSQL or MySQL/MariaDB are supported. With Puppet, it is possible to use :

Beginning with sympa

The very basic steps can be simple include sympa.

Usage

Include usage examples for common use cases in the Usage section. Show your users how to use your module to solve problems, and be sure to include code examples. Include three to five examples of the most important or common tasks a user can accomplish with your module. Show users how to accomplish more complex tasks that involve different types, classes, and functions working in tandem.

Reference

Details are in REFERENCE.md file.

Limitations

Supported OSes are given in metadata.json file.

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>.