[SKIP CI] update readme
This commit is contained in:
parent
3efff5ed50
commit
1e92682423
93
README.md
93
README.md
|
@ -1,2 +1,93 @@
|
|||
# ansible_scan2mail
|
||||
# xoxys.scan2mail
|
||||
|
||||
[![Build Status](https://drone.rknet.org/api/badges/ansible/xoxys.scan2mail/status.svg)](https://drone.rknet.org/ansible/xoxys.scan2mail)
|
||||
|
||||
|
||||
## Table of content
|
||||
|
||||
* [Default Variables](#default-variables)
|
||||
* [scan2mail_packages_extra](#scan2mail_packages_extra)
|
||||
* [scan2mail_mail_domain](#scan2mail_mail_domain)
|
||||
* [scan2mail_from_address](#scan2mail_from_address)
|
||||
* [scan2mail_subject](#scan2mail_subject)
|
||||
* [scan2mail_incron_system_table_dir](#scan2mail_incron_system_table_dir)
|
||||
* [scan2mail_incron_jobs](#scan2mail_incron_jobs)
|
||||
* [Dependencies](#dependencies)
|
||||
* [License](#license)
|
||||
* [Author](#author)
|
||||
|
||||
---
|
||||
|
||||
## Default Variables
|
||||
|
||||
### scan2mail_packages_extra
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
scan2mail_packages_extra: []
|
||||
```
|
||||
|
||||
### scan2mail_mail_domain
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
scan2mail_mail_domain: example.com
|
||||
```
|
||||
|
||||
### scan2mail_from_address
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
scan2mail_from_address: printer@{{ scan2mail_mail_domain }}
|
||||
```
|
||||
|
||||
### scan2mail_subject
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
scan2mail_subject: Scan2Mail attachments
|
||||
```
|
||||
|
||||
### scan2mail_incron_system_table_dir
|
||||
|
||||
#### Default value
|
||||
|
||||
```YAML
|
||||
scan2mail_incron_system_table_dir: /etc/incron.d
|
||||
```
|
||||
|
||||
### 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:
|
||||
- $@
|
||||
- $
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
None.
|
||||
|
||||
## License
|
||||
|
||||
MIT
|
||||
|
||||
## Author
|
||||
|
||||
xoxys
|
||||
|
|
Loading…
Reference in New Issue
Block a user