xoxys.scan2mail/README.md

96 lines
1.5 KiB
Markdown
Raw Normal View History

2019-10-18 14:53:14 +02:00
# xoxys.scan2mail
[![Build Status](https://drone.rknet.org/api/badges/ansible/xoxys.scan2mail/status.svg)](https://drone.rknet.org/ansible/xoxys.scan2mail)
2019-08-25 20:18:43 +02:00
2019-10-18 14:53:14 +02:00
2019-11-06 21:15:13 +01:00
Setup scan2mail service
2019-10-18 14:53:14 +02:00
## Table of content
* [Default Variables](#default-variables)
* [scan2mail_from_address](#scan2mail_from_address)
* [scan2mail_incron_jobs](#scan2mail_incron_jobs)
2019-11-23 00:10:49 +01:00
* [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)
2019-10-18 14:53:14 +02:00
* [Dependencies](#dependencies)
* [License](#license)
* [Author](#author)
---
## Default Variables
2019-11-23 00:10:49 +01:00
### scan2mail_from_address
2019-10-18 14:53:14 +02:00
#### Default value
```YAML
2019-11-23 00:10:49 +01:00
scan2mail_from_address: printer@{{ scan2mail_mail_domain }}
2019-10-18 14:53:14 +02:00
```
2019-11-23 00:10:49 +01:00
### scan2mail_incron_jobs
2019-10-18 14:53:14 +02:00
#### Default value
```YAML
2019-11-23 00:10:49 +01:00
scan2mail_incron_jobs: []
2019-10-18 14:53:14 +02:00
```
2019-11-23 00:10:49 +01:00
#### Example usage
2019-10-18 14:53:14 +02:00
```YAML
2019-11-23 00:10:49 +01:00
scan2mail_incron_jobs:
- path: /path/to/scan/dir
mask: IN_CREATE
action: scan2mail
options:
- $@
- $
2019-10-18 14:53:14 +02:00
```
2019-11-23 00:10:49 +01:00
### scan2mail_incron_system_table_dir
2019-10-18 14:53:14 +02:00
#### Default value
```YAML
2019-11-23 00:10:49 +01:00
scan2mail_incron_system_table_dir: /etc/incron.d
2019-10-18 14:53:14 +02:00
```
2019-11-23 00:10:49 +01:00
### scan2mail_mail_domain
2019-10-18 14:53:14 +02:00
#### Default value
```YAML
2019-11-23 00:10:49 +01:00
scan2mail_mail_domain: example.com
2019-10-18 14:53:14 +02:00
```
2019-11-23 00:10:49 +01:00
### scan2mail_packages_extra
2019-10-18 14:53:14 +02:00
#### Default value
```YAML
2019-11-23 00:10:49 +01:00
scan2mail_packages_extra: []
2019-10-18 14:53:14 +02:00
```
2019-11-23 00:10:49 +01:00
### scan2mail_subject
#### Default value
2019-10-18 14:53:14 +02:00
```YAML
2019-11-23 00:10:49 +01:00
scan2mail_subject: Scan2Mail attachments
2019-10-18 14:53:14 +02:00
```
## Dependencies
None.
## License
MIT
## Author
2019-11-07 09:35:52 +01:00
[xoxys](https://gitea.rknet.org/xoxys)