comptoir

Table of Contents

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

Description

Deploy and configure Comptoir-du-Libre.

Setup

What Comptoir-du-Libre affects

This module install and configure Comptoir-du-Libre.

By default, a PostgreSQL server is installed and configured locally, a role and a database are created.

Setup Requirements

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

• puppetlabs-apache
• puppet-nginx
• puppet-php

As backend, only PostgreSQL is supported. With Puppet, it is possible to use puppetlabs-postgresql.

Comptoir-du-Libre send some mail to webapp users. You have to ensure to set SMTP attributes accordingly with your SMTP infrastructure. With Puppet, it is possible to use puppet-postfix.

Beginning with Comptoir-du-Libre

The very basic steps can be simple include comptoir.

Usage

If you are using Apache, this setup is possible :

class { 'comptoir':
  app_secret        => 'ThisIsMySecetUsedToGenerateCSRFTokens',
  smtp_host         => 'smtp.example.org',
  smtp_port         => 465,
  smtp_user         => 'comptoir-username%40example.org',
  smtp_password     => 'comptoir-smtppassword',
  sys_rootpath      => '/var/www/comptoir.example.org',
  sys_rootpath_mode => '0700',
  sys_user          => 'www-data',
  sys_group         => 'www-data',
  webapp            => {
    trusted_hosts => '^comptoir.example.org$',
  },
}

Reference

Details are in REFERENCE.md file.

Limitations

Supported OSes are given in metadata.json file.

Development

Home at URL https://gitlab.adullact.net/Comptoir/puppet-comptoir-du-libre

Issues and MR are welcome.

Release Notes/Contributors/Etc.

Details in CHANGELOG.

Copyright (C) 2024 Association des Dveloppeurs et Utilisateurs de Logiciels Libres
                     pour les Administrations et Collctivits 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>.