diff --git a/README.md b/README.md index dfdb2a3a9c1ad577366857b63f4b8be34ae1d360..5f348b8210b2e967cf87e437fd7329fb1da57b68 100644 --- a/README.md +++ b/README.md @@ -17,41 +17,41 @@ This module install a mailing list server named [Sympa](https://www.sympa.commun ## Setup -### What sympa affects **OPTIONAL** +### What sympa affects -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. +With `manage_user` at true the module creates a local account on system. -If there's more that they should know about, though, this is the place to -mention: +With `manage_database` at true the module installs a PostgreSQL database server and database with role. -* 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** +### 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](https://forge.puppet.com/modules/puppetlabs/apache/readme) * [puppet-nginx](https://forge.puppet.com/modules/puppet/nginx/readme) -As backend, PostgreSQL or MySQL/MariaDB are supported. With Puppet, it is possible to use : - * [puppetlabs-postgresql](https://forge.puppet.com/modules/puppetlabs/postgresql/readme). - * [puppetlabs-mysql](https://forge.puppet.com/modules/puppetlabs/mysql/readme). ### Beginning with sympa -The very basic steps can be simple `include sympa`. +The very basic steps can be simple : + +`include sympa` + +But it's better to change `db_password` at least. ## 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. +To customize topics : + +``` +class { 'sympa': + topics => { + 'topic1' => { + 'en' => 'Topic one in English', + 'fr' => 'Cathégorie une en Français', + }, + }, +} +``` ## Reference @@ -61,6 +61,8 @@ Details are in [REFERENCE.md](https://gitlab.adullact.net/adullact/puppet-sympa/ Supported OSes are given in [metadata.json](https://gitlab.adullact.net/adullact/puppet-sympa/-/blob/main/metadata.json) file. +This module support only PostgreSQL as backend. + ## Development Home at URL https://gitlab.adullact.net/adullact/puppet-sympa