[skip ci] automated docs update

This commit is contained in:
CI Bot 2024-02-18 11:59:00 +00:00
parent 4a193d03c6
commit 1035a690ef

103
README.md
View File

@ -1 +1,104 @@
# xoxys.postfix_relay
[![Build Status](https://ci.rknet.org/api/badges/ansible/xoxys.postfix_relay/status.svg)](https://ci.rknet.org/repos/ansible/xoxys.postfix_relay)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg?label=license)](https://gitea.rknet.org/ansible/xoxys.postfix_relay/src/branch/main/LICENSE)
Setup postfix as mail relay.
## Table of content
- [Requirements](#requirements)
- [Default Variables](#default-variables)
- [postfix_relay_auth_password](#postfix_relay_auth_password)
- [postfix_relay_auth_user](#postfix_relay_auth_user)
- [postfix_relay_relaydomain](#postfix_relay_relaydomain)
- [postfix_relay_relayhost](#postfix_relay_relayhost)
- [postfix_relay_relayport](#postfix_relay_relayport)
- [postfix_relay_senders](#postfix_relay_senders)
- [postfix_relay_smtpd_banner](#postfix_relay_smtpd_banner)
- [Dependencies](#dependencies)
- [License](#license)
- [Author](#author)
---
## Requirements
- Minimum Ansible version: `2.10`
## Default Variables
### postfix_relay_auth_password
#### Default value
```YAML
postfix_relay_auth_password: pass01
```
### postfix_relay_auth_user
#### Default value
```YAML
postfix_relay_auth_user: user01
```
### postfix_relay_relaydomain
#### Default value
```YAML
postfix_relay_relaydomain: smtp.org
```
### postfix_relay_relayhost
#### Default value
```YAML
postfix_relay_relayhost: test.{{ postfix_relay_relaydomain }}
```
### postfix_relay_relayport
#### Default value
```YAML
postfix_relay_relayport: '587'
```
### postfix_relay_senders
#### Default value
```YAML
postfix_relay_senders:
- user: root
address: '{{ ansible_hostname }}@{{ postfix_relay_relaydomain }}'
```
### postfix_relay_smtpd_banner
`smtpd_banner` contains $myhostname by default and
can't be removed. Options from the list will be appended.
#### Default value
```YAML
postfix_relay_smtpd_banner:
- ESMTP
- $mail_name
```
## Dependencies
None.
## License
MIT
## Author
[Robert Kaussow](https://gitea.rknet.org/xoxys)