kjg/cdist-contrib
1
0
Fork 0
forked from ungleich-public/cdist-contrib
Code Issues Pull requests Projects Releases Wiki Activity

[type/__dma] Update man.rst

Browse source
This commit is contained in:
Dennis Camera 2020-10-01 17:18:01 +02:00
parent f202d11124
commit 1c9ab6e07b
2 changed files with 35 additions and 26 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
type/__dma/gencode-remote
View file

@ -66,7 +66,7 @@ conf_should=$(
echo 'STARTTLS' echo 'STARTTLS'
;; ;;
(opportunistic) (opportunistic)
default_smtp_port=25 # XXX: correct? default_smtp_port=25
echo 'SECURETRANSFER' echo 'SECURETRANSFER'
echo 'STARTTLS' echo 'STARTTLS'
echo 'OPPORTUNISTIC_TLS' echo 'OPPORTUNISTIC_TLS'
@ -152,7 +152,8 @@ CODE
fi fi
if test -f "${__object:?}/parameter/send-test-email" # Send a test email if enabled and necessary (=configuration changed)
if test -f "${__object:?}/parameter/send-test-mail"
then then
if grep -q '^__mail_alias/root:' "${__messages_in:?}" \ if grep -q '^__mail_alias/root:' "${__messages_in:?}" \
|| grep -q '^__dma_auth/' "${__messages_in:?}" \ || grep -q '^__dma_auth/' "${__messages_in:?}" \

56
type/__dma/man.rst
View file

@ -8,47 +8,46 @@ cdist-type__dma - Setup the DragonFly Mail Agent as the MTA.
DESCRIPTION DESCRIPTION
----------- -----------
This (singleton) type uses dma, a small Mail Transport Agent (MTA), to accept This (singleton) type uses DMA, a small Mail Transport Agent (MTA), to accept
mails from locally installed Mail User Agents (MUA) and deliver the mails mails from locally installed Mail User Agents (MUA) and either deliver the mails
to a remote destination. to a remote smart host for delivery or communicate with remote SMTP servers
directly.
Remote delivery happens over TLS to one or more mailboxes that are local to the
mail server configured in the ``smarthost`` parameter.
REQUIRED PARAMETERS REQUIRED PARAMETERS
------------------- -------------------
smarthost None.
The mail server used to send email.
It must be configured to act as a relay for the host being configured by
this type so that mail can be sent to users non-local to the smarthost.
BOOLEAN PARAMETERS BOOLEAN PARAMETERS
------------------ ------------------
defer defer
If enabled, the mail queue has to be manually flushed with the `-q` option. If enabled, mail will not be sent immediately, but stored in a queue.
full-bounce To flush the queue and send the mails, ```dma -q`` has to be run
Enable if the bounce message should include the complete original message, periodically (e.g. using a cron job.)
This type does not manage such a cron job, but some operating systems ship
such a cron job with the package.
fullbounce
Enable if bounce messages should include the complete original message,
not just the headers. not just the headers.
null-client nullclient
Enable to bypass aliases and local delivery, and instead forward all mails Enable to bypass aliases and local delivery, and instead forward all mails
to the defined ``--smarthost``. to the defined ``--smarthost``.
send-test-email send-test-mail
If present, after setup this type will send an email to root, to allow you If set, this type will send a test email to root after setup, to check if
to easily test your setup. the configured settings work.
OPTIONAL PARAMETERS OPTIONAL PARAMETERS
------------------- -------------------
mailname mailname
If present, this will be the hostname used to identify this host and the If present, this will be the hostname used to identify this host and the
remote part of the from addresses. remote part of the sender addresses.
If not defined, it defaults to `/etc/mailname` on Debian derivatives and to If not defined, it defaults to ``/etc/mailname`` on Debian derivatives and
`__target_fqdn` otherwise. to ``__target_fqdn`` otherwise.
See `dma(8)` for more information. See `dma(8)` for more information.
Note: on Debian derivatives the `/etc/mailname` file should be updated Note: on Debian derivatives the ``/etc/mailname`` file should be updated
instead of using this parameter. instead of using this parameter.
masquerade masquerade
Masquerade the envelope-from addresses with this address/hostname. Masquerade the envelope-from addresses with this address/hostname.
@ -59,7 +58,7 @@ masquerade
port port
The port on which to deliver email. The port on which to deliver email.
If not provided, a sensible default port will be used based on the If not provided, a sensible default port will be used based on the
`--security` argument. ``--security`` argument.
security security
Configures whether and how DMA should use secure connections. Configures whether and how DMA should use secure connections.
@ -74,14 +73,23 @@ security
messages directly to the outside mail exchangers. messages directly to the outside mail exchangers.
insecure insecure
allow plain text SMTP login over an insecure connection. allow plain text SMTP login over an insecure connection.
Should really not be used anymore! Should really *not* be used anymore!
smarthost
The mail server used to send email.
It must be configured to act as a relay for the host being configured by
this type so that mail can be sent to users non-local to the smarthost.
EXAMPLES EXAMPLES
-------- --------
.. code-block:: sh .. code-block:: sh
__dma --smarthost mx1.domain.tld --send-test-email # Install DMA and use the smarthost mx1.domain.tld to send mail.
__dma --smarthost mx1.domain.tld --send-test-mail
# Install DMA in a default configuration.
__dma
SEE ALSO SEE ALSO