Commit 7da0b8d6 authored by Matthieu FAURE's avatar Matthieu FAURE

doc: add example + parameters description

parent e4b28f2c
......@@ -3,7 +3,29 @@
# Install and configure AMIES, the open source citizen participation tool for cities streets
#
# @example
# include amies
# class { 'amies':
# smtp_host => 'smtp.example.org',
# smtp_port => 587,
# smtp_user_name => 'KateBush@example.org',
# smtp_user_passwd => 'RunningUpThatHill!',
# app_dir => '/home/amies/AMIES',
# picture_dir => '/home/amies/AMIES-pictures',
# security_key => '0123654789abcdefghijklm',
# ci_job_name => 'myJob',
# db_user_password => 'S3cr#TPassw0rdz',
# }
#
# @param smtp_host Hostname of SMTP relay host
# @param smtp_port Port of SMTP relay host
# @param smtp_user_name Username for SMTP credentials
# @param smtp_user_passwd Password for SMTP credentials
# @param app_dir Directory in which application will be copied
# @param picture_dir Directory holding user-uploaded pictures (may be fat)
# @param security_key Secret key for the application (used as salt)
# @param ci_job_name Gitlab CI job name from which to download AMIES jar file
# @param db_user_password Password for Amies database
# @param package_list List of packages to be installed beforehand (stored in Hiera)
class amies (
String $smtp_host,
Integer $smtp_port,
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment