Skip to content
Snippets Groups Projects
Commit 8d7deb84 authored by Fabrice Gangler's avatar Fabrice Gangler :art:
Browse files

fix: update REFERENCE.md file

parent 5b918d18
No related branches found
No related tags found
No related merge requests found
......@@ -10,7 +10,7 @@
## Classes
### `comptoir`
### <a name="comptoir"></a>`comptoir`
Deploy and configure Comptoir-du-Libre webapp.
......@@ -30,25 +30,54 @@ class { 'comptoir':
#### Parameters
The following parameters are available in the `comptoir` class.
##### `download_url`
The following parameters are available in the `comptoir` class:
* [`download_url`](#-comptoir--download_url)
* [`download_checksum`](#-comptoir--download_checksum)
* [`checksum_type`](#-comptoir--checksum_type)
* [`app_name`](#-comptoir--app_name)
* [`app_shortname`](#-comptoir--app_shortname)
* [`app_secret`](#-comptoir--app_secret)
* [`config_path`](#-comptoir--config_path)
* [`var_path`](#-comptoir--var_path)
* [`trusted_hosts`](#-comptoir--trusted_hosts)
* [`timezone`](#-comptoir--timezone)
* [`i18ndefaultlocale`](#-comptoir--i18ndefaultlocale)
* [`sys_usermanage`](#-comptoir--sys_usermanage)
* [`sys_user`](#-comptoir--sys_user)
* [`sys_group`](#-comptoir--sys_group)
* [`sys_rootpath`](#-comptoir--sys_rootpath)
* [`sys_rootpath_mode`](#-comptoir--sys_rootpath_mode)
* [`db_manage`](#-comptoir--db_manage)
* [`db_host`](#-comptoir--db_host)
* [`db_version`](#-comptoir--db_version)
* [`db_user`](#-comptoir--db_user)
* [`db_password`](#-comptoir--db_password)
* [`db_name`](#-comptoir--db_name)
* [`smtp_host`](#-comptoir--smtp_host)
* [`smtp_port`](#-comptoir--smtp_port)
* [`smtp_user`](#-comptoir--smtp_user)
* [`smtp_password`](#-comptoir--smtp_password)
* [`smtp_mailfrom`](#-comptoir--smtp_mailfrom)
* [`smtp_mailalertingto`](#-comptoir--smtp_mailalertingto)
##### <a name="-comptoir--download_url"></a>`download_url`
Data type: `Stdlib::HTTPSUrl`
URL where Comptoir-du-Libre archive is stored.
Default value: `'https://gitlab.adullact.net/Comptoir/comptoir-du-libre/-/package_files/zzzzzzzzzzzzzzzzzzz/download'`
Default value: `'https://gitlab.adullact.net/Comptoir/comptoir-du-libre/-/package_files/1052/download'`
##### `download_checksum`
##### <a name="-comptoir--download_checksum"></a>`download_checksum`
Data type: `String[1]`
Archive file checksum (match checksum_type) used to verify of archive file.
Default value: `'uuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuu'`
Default value: `'ff9581ac13a5594e9f33cf8e394f25b4fe80a95f1a0391cc2ae1ec739226dbdc'`
##### `checksum_type`
##### <a name="-comptoir--checksum_type"></a>`checksum_type`
Data type: `Enum['md5', 'sha1', 'sha2', 'sha256', 'sha384', 'sha512']`
......@@ -56,7 +85,7 @@ Checksum type given with download_checksum.
Default value: `'sha256'`
##### `app_name`
##### <a name="-comptoir--app_name"></a>`app_name`
Data type: `String[1]`
......@@ -64,7 +93,7 @@ A custom string displayed to users as name of service.
Default value: `'Comptoir-du-Libre'`
##### `app_shortname`
##### <a name="-comptoir--app_shortname"></a>`app_shortname`
Data type: `String[1]`
......@@ -72,7 +101,7 @@ A custom string displayed to users as short name of service.
Default value: `'Comptoir'`
##### `app_secret`
##### <a name="-comptoir--app_secret"></a>`app_secret`
Data type: `String[1]`
......@@ -80,7 +109,7 @@ Application secret is required to generate CSRF tokens
Default value: `'ThisTokenIsNotSoSecretChangeIt'`
##### `config_path`
##### <a name="-comptoir--config_path"></a>`config_path`
Data type: `Stdlib::Absolutepath`
......@@ -88,7 +117,7 @@ Directory where Comptoir-du-Libre configuration file is stored.
Default value: `'/etc/comptoir'`
##### `var_path`
##### <a name="-comptoir--var_path"></a>`var_path`
Data type: `Stdlib::Absolutepath`
......@@ -96,7 +125,7 @@ Directory where Comptoir-du-Libre stores var files.
Default value: `'/var/comptoir'`
##### `trusted_hosts`
##### <a name="-comptoir--trusted_hosts"></a>`trusted_hosts`
Data type: `String[1]`
......@@ -104,7 +133,7 @@ Regular expression listing allowed domains and IP to prevent HTTP Host header at
Default value: `$facts['networking']['fqdn']`
##### `timezone`
##### <a name="-comptoir--timezone"></a>`timezone`
Data type: `String[1]`
......@@ -112,7 +141,7 @@ Time Zone used by Comptoir-du-Libre web application
Default value: `'Europe/Paris'`
##### `i18ndefaultlocale`
##### <a name="-comptoir--i18ndefaultlocale"></a>`i18ndefaultlocale`
Data type: `Enum['en','fr']`
......@@ -120,15 +149,15 @@ Default language used by Comptoir-du-Libre in WebUI.
Default value: `'en'`
##### `sys_usermanage`
##### <a name="-comptoir--sys_usermanage"></a>`sys_usermanage`
Data type: `Boolean`
To enable/disable the creation of system user and group. To permit manage then by external process.
Default value: ``true``
Default value: `true`
##### `sys_user`
##### <a name="-comptoir--sys_user"></a>`sys_user`
Data type: `String[1]`
......@@ -136,7 +165,7 @@ Operating system user account owner of Comptoir-du-Libre files
Default value: `'comptoir'`
##### `sys_group`
##### <a name="-comptoir--sys_group"></a>`sys_group`
Data type: `String[1]`
......@@ -144,7 +173,7 @@ Operating system group owner of Comptoir-du-Libre files
Default value: `'comptoir'`
##### `sys_rootpath`
##### <a name="-comptoir--sys_rootpath"></a>`sys_rootpath`
Data type: `Stdlib::Absolutepath`
......@@ -152,7 +181,7 @@ Path where Comptoir-du-Libre is installed
Default value: `'/opt/comptoir'`
##### `sys_rootpath_mode`
##### <a name="-comptoir--sys_rootpath_mode"></a>`sys_rootpath_mode`
Data type: `String`
......@@ -160,15 +189,15 @@ Unix mode set to path defined by $sys_rootpath
Default value: `'0750'`
##### `db_manage`
##### <a name="-comptoir--db_manage"></a>`db_manage`
Data type: `Boolean`
To enable/disable installation of local PostgreSQl server, creation of role and database. To permit manage then by external process.
Default value: ``true``
Default value: `true`
##### `db_host`
##### <a name="-comptoir--db_host"></a>`db_host`
Data type: `Stdlib::Host`
......@@ -176,7 +205,7 @@ PostgreSQL server to use
Default value: `'127.0.0.1'`
##### `db_version`
##### <a name="-comptoir--db_version"></a>`db_version`
Data type: `String[1]`
......@@ -184,7 +213,7 @@ Version of PostgreSQL server
Default value: `'14'`
##### `db_user`
##### <a name="-comptoir--db_user"></a>`db_user`
Data type: `String[1]`
......@@ -192,15 +221,15 @@ Database user used to connect PostgreSQL server
Default value: `'dbcomptoir'`
##### `db_password`
##### <a name="-comptoir--db_password"></a>`db_password`
Data type: `Variant[String[1], Sensitive[String]]`
Database password used to connect PostgreSQL server
Default value: `('changeit')`
Default value: `Sensitive.new('changeit')`
##### `db_name`
##### <a name="-comptoir--db_name"></a>`db_name`
Data type: `String[1]`
......@@ -208,7 +237,7 @@ Database name used by Comptoir-du-Libre
Default value: `'comptoir'`
##### `smtp_host`
##### <a name="-comptoir--smtp_host"></a>`smtp_host`
Data type: `Stdlib::Host`
......@@ -216,7 +245,7 @@ SMTP host to use
Default value: `'127.0.0.1'`
##### `smtp_port`
##### <a name="-comptoir--smtp_port"></a>`smtp_port`
Data type: `Stdlib::Port`
......@@ -224,23 +253,23 @@ SMTP port to use
Default value: `25`
##### `smtp_user`
##### <a name="-comptoir--smtp_user"></a>`smtp_user`
Data type: `Optional[String[1]]`
SMTP user used with SMTP auth. If user is email, use username%40example.org instead of username@example.org.
Default value: ``undef``
Default value: `undef`
##### `smtp_password`
##### <a name="-comptoir--smtp_password"></a>`smtp_password`
Data type: `Optional[Variant[String[1], Sensitive[String]]]`
SMTP password used with SMTP auth
Default value: ``undef``
Default value: `undef`
##### `smtp_mailfrom`
##### <a name="-comptoir--smtp_mailfrom"></a>`smtp_mailfrom`
Data type: `Stdlib::Email`
......@@ -248,7 +277,7 @@ Who the email sent by Comptoir-du-Libre should come from.
Default value: `"admin@${facts['networking']['domain']}"`
##### `smtp_mailalertingto`
##### <a name="-comptoir--smtp_mailalertingto"></a>`smtp_mailalertingto`
Data type: `Stdlib::Email`
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment