ansible/xoxys.scan2mail
0
0
Fork 0
Code Issues Pull Requests Releases Activity

cleanup readme

Browse Source
This commit is contained in:
Robert Kaussow 2020-01-30 22:58:49 +01:00
parent 2bd7bfe8b1
commit 4aee4cfe22
1 changed files with 6 additions and 87 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

91
README.md
View File

@ -1,95 +1,14 @@
# xoxys.scan2mail # xoxys.scan2mail
[![Build Status](https://drone.rknet.org/api/badges/ansible/xoxys.scan2mail/status.svg)](https://drone.rknet.org/ansible/xoxys.scan2mail) [![Build Status](https://img.shields.io/drone/build/ansible/xoxys.scan2mail?logo=drone&server=https%3A%2F%2Fdrone.rknet.org)](https://drone.rknet.org/ansible/xoxys.scan2mail)
Setup scan2mail service Setup scan2mail service
## Table of content ### License
* [Default Variables](#default-variables) This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
* [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)
* [License](#license)
* [Author](#author)
--- ### Maintainers and Contributors
## Default Variables [Robert Kaussow](https://gitea.rknet.org/xoxys)
### 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.
## License
MIT
## Author
[xoxys](https://gitea.rknet.org/xoxys)