README inicial completo.

This commit is contained in:
Mauro Torrez 2019-05-28 00:04:17 -03:00
parent f1df31ddf5
commit 0732f83a36

142
README.md
View File

@ -44,83 +44,83 @@ Este rol instala y configura el servidor IMAP Dovecot.
### LDAP ### LDAP
dovecot_auth_ldap_enable: yes habilitar userdb/passdb ldap? * `dovecot_ldap_enable` (`yes`): indica si habilitar la userdb/passdb
LDAP.
dovecot_auth_ldap_servers: [ "localhost" ] servidores ldap * `dovecot_ldap_servers`: (`["localhost"]`): lista de servidores ldap
para consultar.
dovecot_auth_ldap_version: 3 version del protocolo LDAP * `dovecot_ldap_version` (`3`): version del protocolo LDAP.
* `dovecot_ldap_base` (`ou=People,dc=%Dd`): base para la búsqueda en
dovecot_auth_ldap_base: `ou=People,dc=%Dd` base para la busqueda en LDAP LDAP. `%Dd` convierte `mi.dominio.com` en `mi,dc=dominio,dc=com`.
* `dovecot_ldap_scope` (`subtree`): scope para la búsqueda. Valores
dovecot_auth_ldap_scope: `subtree` scope para la busqueda en ldap: base, onelevel, subtree posibles: `base`, `onelevel`, `subtree`.
* `dovecot_ldap_user_filter` (`(&(objectClass=inetOrgPerson)
dovecot_auth_ldap_user_filter: `(&(objectClass=inetOrgPerson)(uid=%n))` filtro para obtener la entrada del usuario LDAP (uid=%n))`): filtro para obtener la entrada del usuario LDAP.
* `dovecot_ldap_pass_filter` (`(&(objectClass=inetOrgPerson)
dovecot_auth_ldap_pass_filter: `(&(objectClass=inetOrgPerson)(uid=%n))` filtro para obtener la clave del usuario LDAP (uid=%n))`): filtro para obtener la clave del usuario LDAP.
* `dovecot_ldap_user_attrs` (`=home={{dovecot_user_home}},
dovecot_auth_ldap_user_attrs: > =uid={{vmail_user}}, =gid={{vmail_group}}`): atributos del usuario.
=home={{ dovecot_user_home }}, Por defecto se usan valores pre-calculados, sin consultar LDAP.
=uid={{ vmail_user }}, * `dovecot_ldap_pass_attrs` (`userPassword=password,
=gid={{ vmail_group }} =userdb_home={{dovecot_user_home}}, =userdb_uid={{vmail_user}},
atributos del usuario leidos de LDAP =userdb_gid={{vmail_group}}`): clave + mapeo de atributos
por defecto, usar valores pre-calculados LDAP=Dovecot del usuario.
* `dovecot_ldap_iterate_attrs` (`=user=%{ldap:uid}@%d`): iteracion que
dovecot_auth_ldap_pass_attrs: > lista todos los usuarios que Dovecot conoce. Es para poder ejecutar
userPassword=password, el comando `doveadm -A`. El formato es `<atributo LDAP>=<atributo
=userdb_home={{ dovecot_user_home }}, Dovecot>` o bien `=<atributo Dovecot>=<TEMPLATE>`, en donde TEMPLATE
=userdb_uid={{ vmail_user }}, es un string con campos `%{ldap:<nombre_atributo_ldap>}` que son
=userdb_gid={{ vmail_group }} reemplazados por el valor correspondiente traido de LDAP.
clave + atributos del usuario leidos de LDAP CAVEAT: al usar `%Dd` en `dovecot_ldap_base`, no se puede utilizar
por defecto, usar valores pre-calculados `doveadm -A`, sino que siempre se debe especificar un dominio usando
`doveadom -u "*@dominio"`. Cuando la base LDAP es fija (sin `%algo`),
dovecot_auth_ldap_iterate_attrs: `=user=%{ldap:uid}@%d` se puede simplificar este campo a `uid=user`.
iteracion con doveadm * `dovecot_ldap_iterate_filter` (`(objectClass=inetOrgPerson)`):
CAVEAT: al usar %Dd en ldap_base, no se puede utilizar doveadm -A, filtro para iteración, debe devolver todas las personas de tipo
sino que siempre se debe especificar un dominio usando -u `*@dominio` `usuario` en LDAP.
* `dovecot_ldap_default_pass_scheme` (`CRYPT`): esquema de clave en
dovecot_auth_ldap_iterate_attrs: `uid=user` ldap. No debería ser necesario con una autenticación bind.
cuando ldap_base es fija (sin %Dd):
dovecot_auth_ldap_iterate_filter: `(objectClass=inetOrgPerson)`
filtro para iteracion: este filtro debe devolver todas las personas
de tipo `usuario`
dovecot_auth_ldap_default_pass_scheme: `CRYPT` esquema de clave en ldap -- no se para que se utilizaría
### Antispam ### Antispam
dovecot_plugin_antispam_enable: yes Activar el plugin antispam? La configuración antispam viene por defecto para Bogofilter.
dovecot_plugin_antispam: opciones del plugin antispam * `dovecot_antispam_enable` (`yes`): Indica si activar el plugin
antispam.
* `dovecot_antispam_backend` (`pipe`): Backend. Valores posibles:
`crm114`, `dspam`, `pipe`, `spool2dir`.
* `dovecot_antispam_signature` (`X-Bogosity`): Header que indica que
el mail ha sido escaneado para spam.
* `dovecot_antispam_pipe_program` (`/usr/bin/bogofilter`): programa
que entrena leyendo el mail en STDIN.
* `dovecot_antispam_pipe_program_args` (`-l`): argumentos pasados al
programa en todos los casos.
* `dovecot_antispam_pipe_program_notspam_arg` (`-n`): argumento que
indica que el mail NO ES spam.
* `dovecot_antispam_pipe_program_spam_arg` (`-s`): argumento que
indica que el mail ES spam.
* `dovecot_antispam_pipe_tmpdir` (`/tmp`): directorio temporal de pipe
(creo que el mail se copia ahi primero).
* `dovecot_antispam_signature_missing` (`error`): acción cuando se
mueve un mail que no tiene signature de/hacia spam. Valores
posibles: `error` (fallar en la operación), `move` (mover el mensaje
de todos modos). Se recomienda empezar con `error` para detectar
errores al entrenar. Una vez todo andando se recomienda `move`.
* `dovecot_antispam_spam` (`Junk;junk;Junk Mail;Spam;spam;SPAM`):
nombres de carpeta a interpretar como spam.
* `dovecot_antispam_trash` (`Trash;trash;mail/trash;Deleted
Messages`): nombres de carpeta a interpretar como papelera.
* `dovecot_antispam_debug_enable` (`no`)
* `dovecot_antispam_debug_target` (`syslog`)
* `dovecot_antispam_debug_verbosity` (`0`)
backend: `pipe` crm114, dspam, pipe, spool2dir #### Para rspamd
signature: `X-Bogosity` Header que indica que el mail ha sido escaneado para spam ```yaml
dovecot_antispam_enable: yes
pipe_program: `/usr/bin/bogofilter` Pipe: programa que entrena leyendo el mail en STDIN dovecot_antispam_pipe_program: rspamc
dovecot_antispam_pipe_program_spam_arg learn_spam
pipe_program_args: `-l` antispam_pipe_program_args = --for;%u dovecot_antispam_pipe_program_notspam_arg: learn_ham
```
pipe_program_notspam_arg: `-n` Pipe: argumento que indica que el mail NO ES spam
pipe_program_spam_arg: `-s` Pipe: argumento que indica que el mail ES spam
pipe_tmpdir: `/tmp` Pipe: directorio temporal (creo que el mail se copia ahi primero)
signature_missing: `error` accion cuando se mueve un mail que no tiene signature de/hacia spam
valores posibles:
error: fallar en la operacion
move: mover el mensaje de todos modos
spam: `Junk;junk;Junk Mail;Spam;spam;SPAM` nombres de las carpetas de spam
trash: `Trash;trash;mail/trash;Deleted Messages` nombres de las carpetas de papelera
debug del plugin antispam
debug_enable: no
debug_target: `syslog`
debug_verbosity: 0
### Quota ### Quota