diff --git a/index.md b/index.md new file mode 100644 index 0000000..ba715bc --- /dev/null +++ b/index.md @@ -0,0 +1,83 @@ +--- +title: scan2mail +type: docs +--- + +Setup scan2mail service + +* [Default Variables](#default-variables) + * [scan2mail_from_address](#scan2mail-from-address) + * [scan2mail_incron_jobs](#scan2mail-incron-jobs) + * [scan2mail_incron_system_table_dir](#scan2mail-incron-system-table-dir) + * [scan2mail_mail_domain](#scan2mail-mail-domain) + * [scan2mail_packages_extra](#scan2mail-packages-extra) + * [scan2mail_subject](#scan2mail-subject) +* [Dependencies](#dependencies) + +--- + +## Default Variables + +### scan2mail_from_address + +#### Default value + +```YAML +scan2mail_from_address: printer@{{ scan2mail_mail_domain }} +``` + +### scan2mail_incron_jobs + +#### Default value + +```YAML +scan2mail_incron_jobs: [] +``` + +#### Example usage + +```YAML +scan2mail_incron_jobs: + - path: /path/to/scan/dir + mask: IN_CREATE + action: scan2mail + options: + - $@ + - $ +``` + +### scan2mail_incron_system_table_dir + +#### Default value + +```YAML +scan2mail_incron_system_table_dir: /etc/incron.d +``` + +### scan2mail_mail_domain + +#### Default value + +```YAML +scan2mail_mail_domain: example.com +``` + +### scan2mail_packages_extra + +#### Default value + +```YAML +scan2mail_packages_extra: [] +``` + +### scan2mail_subject + +#### Default value + +```YAML +scan2mail_subject: Scan2Mail attachments +``` + +## Dependencies + +None.