From 296ddb81139475843380566b24b287f07f6c37f1 Mon Sep 17 00:00:00 2001 From: lhahn Date: Sun, 17 Sep 2023 10:55:59 +0200 Subject: [PATCH] Git initial commit --- LICENSE | 9 + README.md | 3 + defaults/main.yml | 49 ++ files/quota_update_script.sql | 37 ++ handlers/main.yml | 49 ++ meta/main.yml | 17 + tasks/dovecot.yml | 83 ++++ tasks/gunicorn.yml | 40 ++ tasks/main.yml | 84 ++++ tasks/modoboa.yml | 25 + tasks/opendkim.yml | 50 ++ tasks/postfix.yml | 40 ++ .../app/modoboa/instance/gunicorn.conf.py.j2 | 8 + templates/etc/cron.d/modoboa.j2 | 20 + templates/etc/dovecot/conf.d/10-auth.conf.j2 | 127 +++++ templates/etc/dovecot/conf.d/10-mail.conf.j2 | 437 ++++++++++++++++++ .../etc/dovecot/conf.d/10-master.conf.j2 | 150 ++++++ templates/etc/dovecot/conf.d/10-ssl.conf.j2 | 76 +++ templates/etc/dovecot/conf.d/15-lda.conf.j2 | 48 ++ templates/etc/dovecot/conf.d/20-imap.conf.j2 | 98 ++++ templates/etc/dovecot/conf.d/20-lmtp.conf.j2 | 26 ++ .../etc/dovecot/conf.d/20-managesieve.conf.j2 | 84 ++++ templates/etc/dovecot/conf.d/90-quota.conf.j2 | 83 ++++ templates/etc/dovecot/conf.d/90-sieve.conf.j2 | 215 +++++++++ .../etc/dovecot/conf.d/auth-sql.conf.ext.j2 | 10 + .../etc/dovecot/dovecot-mysql.conf.ext.j2 | 24 + .../etc/dovecot/dovecot-pgsql.conf.ext.j2 | 25 + templates/etc/dovecot/dovecot.conf.j2 | 105 +++++ templates/etc/opendkim.conf.j2 | 84 ++++ templates/etc/postfix/main.cf.j2 | 116 +++++ templates/etc/postfix/master.cf.j2 | 0 .../etc/systemd/system/gunicorn.service.j2 | 17 + templates/usr/local/bin/postlogin_mysql.sh | 9 + templates/usr/local/bin/postlogin_pgsql.sh | 5 + vars/main.yml | 26 ++ 35 files changed, 2279 insertions(+) create mode 100755 LICENSE create mode 100755 README.md create mode 100755 defaults/main.yml create mode 100755 files/quota_update_script.sql create mode 100755 handlers/main.yml create mode 100755 meta/main.yml create mode 100755 tasks/dovecot.yml create mode 100755 tasks/gunicorn.yml create mode 100755 tasks/main.yml create mode 100755 tasks/modoboa.yml create mode 100755 tasks/opendkim.yml create mode 100755 tasks/postfix.yml create mode 100755 templates/app/modoboa/instance/gunicorn.conf.py.j2 create mode 100755 templates/etc/cron.d/modoboa.j2 create mode 100755 templates/etc/dovecot/conf.d/10-auth.conf.j2 create mode 100755 templates/etc/dovecot/conf.d/10-mail.conf.j2 create mode 100755 templates/etc/dovecot/conf.d/10-master.conf.j2 create mode 100755 templates/etc/dovecot/conf.d/10-ssl.conf.j2 create mode 100755 templates/etc/dovecot/conf.d/15-lda.conf.j2 create mode 100755 templates/etc/dovecot/conf.d/20-imap.conf.j2 create mode 100755 templates/etc/dovecot/conf.d/20-lmtp.conf.j2 create mode 100755 templates/etc/dovecot/conf.d/20-managesieve.conf.j2 create mode 100755 templates/etc/dovecot/conf.d/90-quota.conf.j2 create mode 100755 templates/etc/dovecot/conf.d/90-sieve.conf.j2 create mode 100755 templates/etc/dovecot/conf.d/auth-sql.conf.ext.j2 create mode 100755 templates/etc/dovecot/dovecot-mysql.conf.ext.j2 create mode 100755 templates/etc/dovecot/dovecot-pgsql.conf.ext.j2 create mode 100755 templates/etc/dovecot/dovecot.conf.j2 create mode 100755 templates/etc/opendkim.conf.j2 create mode 100755 templates/etc/postfix/main.cf.j2 create mode 100755 templates/etc/postfix/master.cf.j2 create mode 100755 templates/etc/systemd/system/gunicorn.service.j2 create mode 100755 templates/usr/local/bin/postlogin_mysql.sh create mode 100755 templates/usr/local/bin/postlogin_pgsql.sh create mode 100755 vars/main.yml diff --git a/LICENSE b/LICENSE new file mode 100755 index 0000000..2071b23 --- /dev/null +++ b/LICENSE @@ -0,0 +1,9 @@ +MIT License + +Copyright (c) + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/README.md b/README.md new file mode 100755 index 0000000..ff69e22 --- /dev/null +++ b/README.md @@ -0,0 +1,3 @@ +# cloud-modoboa + +Ansible role to provide Modoboa as EMail server; currently still in development. \ No newline at end of file diff --git a/defaults/main.yml b/defaults/main.yml new file mode 100755 index 0000000..ecb5117 --- /dev/null +++ b/defaults/main.yml @@ -0,0 +1,49 @@ +--- +# HCS +hcs_update: false +hcs_name: "cloud" +hcs_home: "/{{ hcs_name }}" +hcs_domain_external: "my-domain.tld" +hcs_app_folder: /app +hcs_shared_group: "hcs" +hcs_python_envs: "{{ hcs_app_folder }}/pyenv" +hcs_storage: /storage + +# Modoboa +modoboa_user: modoboa +modoboa_url: "mail.{{ hcs_domain_external }}" +modoboa_instance_folder: "{{ hcs_app_folder }}/modoboa" +modoboa_instance: "{{ modoboa_url.split('.')[:-1] | join('') | regex_replace('[^a-zA-Z0-9]+','') }}" +modoboa_db_type: pgsql +modoboa_db_host: localhost +modoboa_db_configs: + dbname: modoboa + dbuser: modoboa + dbpass: modoboapassword +modoboa_storage: "{{ hcs_storage }}/modoboa" +modoboa_version: +psycopg2_version: 2.8.6 + +# Gunicorn +gunicorn_loglevel: info +gunicorn_backlog: 2048 #number of pending connections +gunicorn_workers: 2 # is mostly 2-4 * CPU + +# Dovecot +dovcot_target_instance: "{{ modoboa_instance_folder }}/{{ modoboa_instance }}" +dovecot_config: + - "protocols = imap pop3 lmtp" + - "instance_name = {{ modoboa_instance }}" +dovecot_process_limit: 32 +dovecot_mailplugins: + - quota + +# Postfix +postfix_mapping_folder: "{{ postfix_dir }}/mappings" + +# OpenDKIM +opendkim_port_listen: 12345 +opendkim_config_lines: + - "SOCKET=inet:{{ opendkim_port_listen }}@localhost" +opendkim_config_lines_off: + - "SOCKET=local:$RUNDIR/opendkim.sock" \ No newline at end of file diff --git a/files/quota_update_script.sql b/files/quota_update_script.sql new file mode 100755 index 0000000..d5d7eb6 --- /dev/null +++ b/files/quota_update_script.sql @@ -0,0 +1,37 @@ +CREATE OR REPLACE FUNCTION merge_quota() RETURNS TRIGGER AS $$ +BEGIN + IF NEW.messages < 0 OR NEW.messages IS NULL THEN + -- ugly kludge: we came here from this function, really do try to insert + IF NEW.messages IS NULL THEN + NEW.messages = 0; + ELSE + NEW.messages = -NEW.messages; + END IF; + return NEW; + END IF; + + LOOP + UPDATE admin_quota SET bytes = bytes + NEW.bytes, + messages = messages + NEW.messages + WHERE username = NEW.username; + IF found THEN + RETURN NULL; + END IF; + + BEGIN + IF NEW.messages = 0 THEN + RETURN NEW; + ELSE + NEW.messages = - NEW.messages; + return NEW; + END IF; + EXCEPTION WHEN unique_violation THEN + -- someone just inserted the record, update it + END; + END LOOP; +END; +$$ LANGUAGE plpgsql; + +DROP TRIGGER IF EXISTS mergequota ON admin_quota; +CREATE TRIGGER mergequota BEFORE INSERT ON admin_quota + FOR EACH ROW EXECUTE PROCEDURE merge_quota(); diff --git a/handlers/main.yml b/handlers/main.yml new file mode 100755 index 0000000..96b7b2b --- /dev/null +++ b/handlers/main.yml @@ -0,0 +1,49 @@ +--- +- name: reload gunicorn + systemd: + name: gunicorn + state: reloaded + daemon_reload: yes + +- name: update modoboa db quota schema + shell: "psql -d {{ modoboa_db_configs.dbname }} -c '{{ dovecot_pgsql_db_adjustment | join(\"\") }}'" + become: yes + become_user: "{{ modoboa_user }}" + listen: quota update + +- name: run quota update script + shell: "psql -d {{ modoboa_db_configs.dbname }} -c '{{ lookup(\"file\",\"files/quota_update_script.sql\") }}'" + become: yes + become_user: "{{ modoboa_user }}" + listen: quota update + +- name: restart dovecot + systemd: + name: dovecot + state: restarted + daemon_reload: yes + +- name: postfix mappings setup + shell: + cmd: > + {{ modoboa_py_venv_bin }}/python3 manage.py generate_postfix_maps --destdir {{ postfix_mapping_folder }} + chdir: "{{ modoboa_instance_folder }}/{{ modoboa_instance }}" + +- name: reload postfix + systemd: + name: postfix + state: reloaded + daemon_reload: yes + listen: opendkim update + +- name: update DB for odkim key definition + shell: "psql -d {{ modoboa_db_configs.dbname }} -c '{{ opendkim_update_sql }}'" + become: yes + become_user: "{{ modoboa_user }}" + listen: opendkim update + +- name: restart opendkim + systemd: + name: opendkim + state: restarted + daemon_reload: yes diff --git a/meta/main.yml b/meta/main.yml new file mode 100755 index 0000000..d2eda7f --- /dev/null +++ b/meta/main.yml @@ -0,0 +1,17 @@ +--- +galaxy_info: + role_name: modoboa + namespace: hahn-cloud + author: Lars Hahn + company: Data Learning + license: MIT + description: Role to setup Modoboa as an email server MDA; uses postfix, dovecot and opendkim in backend to an nginx server. + min_ansible_version: 2.7 + platforms: + - name: Debian + versions: + - 10 + galaxy_tags: + - modoboa +dependencies: + - postgres diff --git a/tasks/dovecot.yml b/tasks/dovecot.yml new file mode 100755 index 0000000..cef33e5 --- /dev/null +++ b/tasks/dovecot.yml @@ -0,0 +1,83 @@ +- name: install requirements for Dovecot + apt: + update_cache: yes + state: "{% if hcs_update | bool %}latest{% else %}present{% endif %}" + install_recommends: yes + pkg: + - dovecot-core + - dovecot-imapd + - dovecot-pop3d + - dovecot-lmtpd + - dovecot-mysql + - dovecot-pgsql + - dovecot-sieve + - dovecot-managesieved + - dovecot-antispam + +- name: setup modoboa management with dovecot every minute for modoboa user + cron: + name: manage modoboa + user: "vmail" + job: "{{ modoboa_py_venv_bin }}/python3 {{ dovcot_target_instance }}/manage.py handle_mailbox_operations" + notify: restart dovecot + +- name: setup dovecot configuration + template: + src: etc/dovecot/dovecot.conf.j2 + dest: "{{ dovecot_dir }}/dovecot.conf" + mode: 0664 + group: "{{ modoboa_user }}" + +- name: "setup db-engine sql connection for db type {{ modoboa_db_type }}" + template: + src: "etc/dovecot/dovecot-{{ modoboa_db_type }}.conf.ext.j2" + dest: "{{ dovecot_dir }}/dovecot-sql.conf.ext" + mode: 0664 + group: "{{ modoboa_user }}" + notify: restart dovecot + +- name: setup required configs + template: + src: "etc/dovecot/conf.d/{{ config }}.j2" + dest: "{{ dovecot_dir }}/conf.d/{{ config }}" + mode: 0664 + group: "{{ modoboa_user }}" + loop: + - 10-mail.conf + - 10-auth.conf + - 10-master.conf + - 10-ssl.conf + - 15-lda.conf + - 20-imap.conf + - 20-lmtp.conf + - 20-managesieve.conf + - 90-sieve.conf + - auth-sql.conf.ext + loop_control: + loop_var: config + label: "{{ config }}" + notify: restart dovecot + +- name: setup quota config + template: + src: "etc/dovecot/conf.d/90-quota.conf.j2" + dest: "{{ dovecot_dir }}/conf.d/90-quota.conf" + mode: 0644 + group: "{{ modoboa_user }}" +# notify: quota update + notify: restart dovecot + +- name: setup postlogin script + template: + src: "usr/local/bin/postlogin_{{ modoboa_db_type }}.sh" + dest: "{{ dovecot_sieve_exec }}" + mode: 0775 + group: "{{ modoboa_user }}" + notify: restart dovecot + +- name: enable dovecot systemd unit + systemd: + name: dovecot + enabled: yes + daemon_reload: yes + state: started \ No newline at end of file diff --git a/tasks/gunicorn.yml b/tasks/gunicorn.yml new file mode 100755 index 0000000..3263473 --- /dev/null +++ b/tasks/gunicorn.yml @@ -0,0 +1,40 @@ +--- +- name: install Gunicorn with dedicated pip virtualenv + pip: + name: + - gunicorn + state: "{% if hcs_update | bool %}latest{% else %}present{% endif %}" + virtualenv: "{{ modoboa_py_venv }}" + +- name: setup required logging folder + file: + state: directory + path: "{{ prefix }}/gunicorn" + loop: + - /var/log + - /var/run + loop_control: + loop_var: prefix + label: "{{ prefix }}/gunicorn" + +- name: setup gunicorn modoboa config + template: + src: app/modoboa/instance/gunicorn.conf.py.j2 + dest: "{{ modoboa_instance_folder }}/{{ modoboa_instance }}/gunicorn.conf.py" + mode: 0740 + group: www-data + notify: reload gunicorn + +- name: setup gunicorn service unit + template: + src: etc/systemd/system/gunicorn.service.j2 + dest: /etc/systemd/system/gunicorn.service + mode: 0755 + notify: reload gunicorn + +- name: enable gunicorn systemd unit + systemd: + name: gunicorn + enabled: yes + daemon_reload: yes + state: started \ No newline at end of file diff --git a/tasks/main.yml b/tasks/main.yml new file mode 100755 index 0000000..667fd99 --- /dev/null +++ b/tasks/main.yml @@ -0,0 +1,84 @@ +--- +- name: install requirements for Modoboa + apt: + update_cache: yes + state: "{% if hcs_update | bool %}latest{% else %}present{% endif %}" + install_recommends: yes + pkg: + - python3-dev + - build-essential + - libxml2-dev + - libxslt-dev + - libjpeg-dev + - librrd-dev + - rrdtool + - libffi-dev + - libssl-dev + - virtualenv + - libexttextcat-2.0-0 + - libexttextcat-data + - libopendbx1-pgsql + - liblua5.3-0 + - libstemmer0d + - libpq-dev + +- name: Setup required groups of users + group: + name: "{{ group }}" + state: present + loop: + - "{{ modoboa_user }}" + - "vmail" + loop_control: + loop_var: group + label: "{{ group }}" + +- name: setup modoboa user + user: + name: "vmail" + group: "vmail" + groups: + - "vmail" + comment: Virtual Mail User + shell: /sbin/nologin + state: present + +- name: setup modoboa user + user: + name: "{{ modoboa_user }}" + group: "{{ modoboa_user }}" + groups: + - "{{ modoboa_user }}" + - "{{ hcs_shared_group }}" + - "www-data" + comment: Modoboa + shell: /sbin/nologin + state: present + register: modoboa_user_stat + +- name: setup modoboa instance folder + file: + path: "{{ modoboa_instance_folder }}" + state: directory + mode: 0750 + owner: "root" + group: "www-data" + +- name: setup modoboa storage + file: + path: "{{ modoboa_storage }}" + state: directory + mode: 0770 + owner: "vmail" + group: "{{ modoboa_user }}" + + +- include_tasks: modoboa.yml + +- include_tasks: gunicorn.yml + +- include_tasks: dovecot.yml + +- include_tasks: postfix.yml + +- include_tasks: opendkim.yml \ No newline at end of file diff --git a/tasks/modoboa.yml b/tasks/modoboa.yml new file mode 100755 index 0000000..595a80e --- /dev/null +++ b/tasks/modoboa.yml @@ -0,0 +1,25 @@ +--- +- name: install Modoboa with dedicated pip virtualenv + pip: + name: + - "modoboa{% if modoboa_version is defined and modoboa_version is not none and modoboa_version != ''%}=={{ modoboa_version }}{% endif %}" + - "psycopg2-binary{% if psycopg2_version is defined and psycopg2_version is not none and psycopg2_version != ''%}=={{ psycopg2_version }}{% endif %}" + state: "{% if hcs_update | bool %}latest{% else %}present{% endif %}" + virtualenv: "{{ modoboa_py_venv }}" + +- name: deploy modoboa instance + shell: + cmd: > + {{ modoboa_py_venv_bin }}/python3 {{ modoboa_py_venv_bin }}/modoboa-admin.py + deploy {{ modoboa_instance }} + --collectstatic + --domain {{ modoboa_url }} + --dburl default:{% if modoboa_db_type == 'pgsql' %}postgres{% else %}{{ modoboa_db_type }}{% endif %}://{{ modoboa_db_configs.dbuser }}:{{ modoboa_db_configs.dbpass }}@{{ modoboa_db_host }}/{{ modoboa_db_configs.dbname }} + --extensions {{ modoboa_extensions | join(' ') }} + chdir: "{{ modoboa_instance_folder }}" + creates: "{{ modoboa_instance_folder }}/{{ modoboa_instance }}" + +- name: setup cronjobs for modoboa functionality + template: + src: "etc/cron.d/modoboa.j2" + dest: "/etc/cron.d/modoboa" diff --git a/tasks/opendkim.yml b/tasks/opendkim.yml new file mode 100755 index 0000000..646149c --- /dev/null +++ b/tasks/opendkim.yml @@ -0,0 +1,50 @@ +--- +- name: install requirements for Postfix + apt: + update_cache: yes + state: "{% if hcs_update | bool %}latest{% else %}present{% endif %}" + install_recommends: yes + pkg: + - opendkim + +- name: Setup opendkim config + template: + src: etc/opendkim.conf.j2 + dest: /etc/opendkim.conf + group: "{{ modoboa_user }}" + mode: 0640 + notify: "opendkim update" + +- name: off-setup opendkim configuration + lineinfile: + path: "/etc/default/opendkim" + regexp: '^{{ configline.split("=")[0]}}=' + line: "#{{ configline }}" + backrefs: yes + group: "{{ modoboa_user }}" + mode: 0640 + loop: "{{ opendkim_config_lines_off }}" + loop_control: + loop_var: configline + label: "#{{ configline }}" + notify: restart opendkim + +- name: setup default opendkim config + lineinfile: + path: "/etc/default/opendkim" + regexp: '^#?{{ configline.split("=")[0]}}=' + line: "{{ configline }}" + group: "{{ modoboa_user }}" + mode: 0640 + loop: "{{ opendkim_config_lines }}" + loop_control: + loop_var: configline + label: "{{ configline }}" + notify: restart opendkim + +- name: enable opendkim systemd unit + systemd: + name: opendkim + enabled: yes + daemon_reload: yes + state: started diff --git a/tasks/postfix.yml b/tasks/postfix.yml new file mode 100755 index 0000000..4cbbe8b --- /dev/null +++ b/tasks/postfix.yml @@ -0,0 +1,40 @@ +--- +- name: install requirements for Postfix + apt: + update_cache: yes + state: "{% if hcs_update | bool %}latest{% else %}present{% endif %}" + install_recommends: yes + pkg: + - postfix + - postfix-pgsql + - postfix-mysql + +- name: install Postfix pip requirements with dedicated pip virtualenv + pip: + name: + - psycopg2-binary + state: "{% if hcs_update | bool %}latest{% else %}present{% endif %}" + virtualenv: "{{ modoboa_py_venv }}" + +- name: setup folder for postfix mapping files + file: + state: directory + path: "{{ postfix_mapping_folder }}" + mode: 0660 + notify: postfix mappings setup + +- name: setup postfix config + template: + src: etc/postfix/main.cf.j2 + dest: "{{ postfix_dir }}/main.cf" + owner: "root" + group: "modoboa" + mode: 0664 + notify: reload postfix + +- name: enable postfix systemd unit + systemd: + name: postfix + enabled: yes + daemon_reload: yes + state: started diff --git a/templates/app/modoboa/instance/gunicorn.conf.py.j2 b/templates/app/modoboa/instance/gunicorn.conf.py.j2 new file mode 100755 index 0000000..be8d3b5 --- /dev/null +++ b/templates/app/modoboa/instance/gunicorn.conf.py.j2 @@ -0,0 +1,8 @@ +backlog = {{ gunicorn_backlog }} +bind = "unix:/run/gunicorn/{{ modoboa_instance }}.sock" +pidfile = "/run/gunicorn/{{ modoboa_instance }}.pid" +daemon = False +workers = {{ gunicorn_workers }} +accesslog = "/var/log/gunicorn/{{ modoboa_instance }}.access.log" +errorlog = "/var/log/gunicorn/{{ modoboa_instance }}.error.log" +loglevel = "{{ gunicorn_loglevel }}" diff --git a/templates/etc/cron.d/modoboa.j2 b/templates/etc/cron.d/modoboa.j2 new file mode 100755 index 0000000..d5bd6b6 --- /dev/null +++ b/templates/etc/cron.d/modoboa.j2 @@ -0,0 +1,20 @@ +# +# Modoboa specific cron jobs +# +PYTHON={{ modoboa_py_venv_bin }}/python3 +INSTANCE={{ modoboa_instance_folder }}/{{ modoboa_instance }} + +# Operations on mailboxes +* * * * * vmail $PYTHON $INSTANCE/manage.py handle_mailbox_operations + +# Generate DKIM keys (they will belong to the user running this job) +* * * * * root umask 077 && $PYTHON $INSTANCE/manage.py modo manage_dkim_keys + +# Sessions table cleanup +0 0 * * * modoboa $PYTHON $INSTANCE/manage.py clearsessions +# Logs table cleanup +0 0 * * * modoboa $PYTHON $INSTANCE/manage.py cleanlogs +# DNSBL checks +*/30 * * * * modoboa $PYTHON $INSTANCE/manage.py modo check_mx +# Public API communication +0 * * * * modoboa $PYTHON $INSTANCE/manage.py communicate_with_public_api diff --git a/templates/etc/dovecot/conf.d/10-auth.conf.j2 b/templates/etc/dovecot/conf.d/10-auth.conf.j2 new file mode 100755 index 0000000..f6ec0be --- /dev/null +++ b/templates/etc/dovecot/conf.d/10-auth.conf.j2 @@ -0,0 +1,127 @@ +## +## Authentication processes +## + +# Disable LOGIN command and all other plaintext authentications unless +# SSL/TLS is used (LOGINDISABLED capability). Note that if the remote IP +# matches the local IP (ie. you're connecting from the same computer), the +# connection is considered secure and plaintext authentication is allowed. +# See also ssl=required setting. +#disable_plaintext_auth = yes + +# Authentication cache size (e.g. 10M). 0 means it's disabled. Note that +# bsdauth, PAM and vpopmail require cache_key to be set for caching to be used. +#auth_cache_size = 0 +# Time to live for cached data. After TTL expires the cached record is no +# longer used, *except* if the main database lookup returns internal failure. +# We also try to handle password changes automatically: If user's previous +# authentication was successful, but this one wasn't, the cache isn't used. +# For now this works only with plaintext authentication. +#auth_cache_ttl = 1 hour +# TTL for negative hits (user not found, password mismatch). +# 0 disables caching them completely. +#auth_cache_negative_ttl = 1 hour + +# Space separated list of realms for SASL authentication mechanisms that need +# them. You can leave it empty if you don't want to support multiple realms. +# Many clients simply use the first one listed here, so keep the default realm +# first. +#auth_realms = + +# Default realm/domain to use if none was specified. This is used for both +# SASL realms and appending @domain to username in plaintext logins. +#auth_default_realm = + +# List of allowed characters in username. If the user-given username contains +# a character not listed in here, the login automatically fails. This is just +# an extra check to make sure user can't exploit any potential quote escaping +# vulnerabilities with SQL/LDAP databases. If you want to allow all characters, +# set this value to empty. +#auth_username_chars = abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ01234567890.-_@ + +# Username character translations before it's looked up from databases. The +# value contains series of from -> to characters. For example "#@/@" means +# that '#' and '/' characters are translated to '@'. +#auth_username_translation = + +# Username formatting before it's looked up from databases. You can use +# the standard variables here, eg. %Lu would lowercase the username, %n would +# drop away the domain if it was given, or "%n-AT-%d" would change the '@' into +# "-AT-". This translation is done after auth_username_translation changes. +auth_username_format = %Lu + +# If you want to allow master users to log in by specifying the master +# username within the normal username string (ie. not using SASL mechanism's +# support for it), you can specify the separator character here. The format +# is then . UW-IMAP uses "*" as the +# separator, so that could be a good choice. +auth_master_user_separator = * + +# Username to use for users logging in with ANONYMOUS SASL mechanism +#auth_anonymous_username = anonymous + +# Maximum number of dovecot-auth worker processes. They're used to execute +# blocking passdb and userdb queries (eg. MySQL and PAM). They're +# automatically created and destroyed as needed. +#auth_worker_max_count = 30 + +# Host name to use in GSSAPI principal names. The default is to use the +# name returned by gethostname(). Use "$ALL" (with quotes) to allow all keytab +# entries. +#auth_gssapi_hostname = + +# Kerberos keytab to use for the GSSAPI mechanism. Will use the system +# default (usually /etc/krb5.keytab) if not specified. You may need to change +# the auth service to run as root to be able to read this file. +#auth_krb5_keytab = + +# Do NTLM and GSS-SPNEGO authentication using Samba's winbind daemon and +# ntlm_auth helper. +#auth_use_winbind = no + +# Path for Samba's ntlm_auth helper binary. +#auth_winbind_helper_path = /usr/bin/ntlm_auth + +# Time to delay before replying to failed authentications. +#auth_failure_delay = 2 secs + +# Require a valid SSL client certificate or the authentication fails. +#auth_ssl_require_client_cert = no + +# Take the username from client's SSL certificate, using +# X509_NAME_get_text_by_NID() which returns the subject's DN's +# CommonName. +#auth_ssl_username_from_cert = no + +# Space separated list of wanted authentication mechanisms: +# plain login digest-md5 cram-md5 ntlm rpa apop anonymous gssapi otp skey +# gss-spnego +# NOTE: See also disable_plaintext_auth setting. +auth_mechanisms = plain login + +## +## Password and user databases +## + +# +# Password database is used to verify user's password (and nothing more). +# You can have multiple passdbs and userdbs. This is useful if you want to +# allow both system users (/etc/passwd) and virtual users to login without +# duplicating the system users into virtual database. +# +# +# +# User database specifies where mails are located and what user/group IDs +# own them. For single-UID configuration use "static" userdb. +# +# + +#!include auth-deny.conf.ext +#!include auth-master.conf.ext +#!include auth-system.conf.ext +!include auth-sql.conf.ext +#!include auth-ldap.conf.ext +#!include auth-passwdfile.conf.ext +#!include auth-checkpassword.conf.ext +#!include auth-vpopmail.conf.ext +#!include auth-static.conf.ext diff --git a/templates/etc/dovecot/conf.d/10-mail.conf.j2 b/templates/etc/dovecot/conf.d/10-mail.conf.j2 new file mode 100755 index 0000000..11d40df --- /dev/null +++ b/templates/etc/dovecot/conf.d/10-mail.conf.j2 @@ -0,0 +1,437 @@ +## +## Mailbox locations and namespaces +## + +# Location for users' mailboxes. The default is empty, which means that Dovecot +# tries to find the mailboxes automatically. This won't work if the user +# doesn't yet have any mail, so you should explicitly tell Dovecot the full +# location. +# +# If you're using mbox, giving a path to the INBOX file (eg. /var/mail/%u) +# isn't enough. You'll also need to tell Dovecot where the other mailboxes are +# kept. This is called the "root mail directory", and it must be the first +# path given in the mail_location setting. +# +# There are a few special variables you can use, eg.: +# +# %u - username +# %n - user part in user@domain, same as %u if there's no domain +# %d - domain part in user@domain, empty if there's no domain +# %h - home directory +# +# See doc/wiki/Variables.txt for full list. Some examples: +# +# mail_location = maildir:~/Maildir +# mail_location = mbox:~/mail:INBOX=/var/mail/%u +# mail_location = mbox:/var/mail/%d/%1n/%n:INDEX=/var/indexes/%d/%1n/%n +# +# +# +mail_location = maildir:~/Maildir + +# If you need to set multiple mailbox locations or want to change default +# namespace settings, you can do it by defining namespace sections. +# +# You can have private, shared and public namespaces. Private namespaces +# are for user's personal mails. Shared namespaces are for accessing other +# users' mailboxes that have been shared. Public namespaces are for shared +# mailboxes that are managed by sysadmin. If you create any shared or public +# namespaces you'll typically want to enable ACL plugin also, otherwise all +# users can access all the shared mailboxes, assuming they have permissions +# on filesystem level to do so. +namespace inbox { + # Namespace type: private, shared or public + #type = private + + # Hierarchy separator to use. You should use the same separator for all + # namespaces or some clients get confused. '/' is usually a good one. + # The default however depends on the underlying mail storage format. + #separator = + + # Prefix required to access this namespace. This needs to be different for + # all namespaces. For example "Public/". + #prefix = + + # Physical location of the mailbox. This is in same format as + # mail_location, which is also the default for it. + #location = + + # There can be only one INBOX, and this setting defines which namespace + # has it. + inbox = yes + + mailbox Drafts { + auto = subscribe + special_use = \Drafts + } + mailbox Junk { + auto = subscribe + special_use = \Junk + } + mailbox Sent { + auto = subscribe + special_use = \Sent + } + mailbox Trash { + auto = subscribe + special_use = \Trash + } + + # If namespace is hidden, it's not advertised to clients via NAMESPACE + # extension. You'll most likely also want to set list=no. This is mostly + # useful when converting from another server with different namespaces which + # you want to deprecate but still keep working. For example you can create + # hidden namespaces with prefixes "~/mail/", "~%u/mail/" and "mail/". + #hidden = no + + # Show the mailboxes under this namespace with LIST command. This makes the + # namespace visible for clients that don't support NAMESPACE extension. + # "children" value lists child mailboxes, but hides the namespace prefix. + #list = yes + + # Namespace handles its own subscriptions. If set to "no", the parent + # namespace handles them (empty prefix should always have this as "yes") + #subscriptions = yes + + # See 15-mailboxes.conf for definitions of special mailboxes. +} + +# Example shared namespace configuration +#namespace { + #type = shared + #separator = / + + # Mailboxes are visible under "shared/user@domain/" + # %%n, %%d and %%u are expanded to the destination user. + #prefix = shared/%%u/ + + # Mail location for other users' mailboxes. Note that %variables and ~/ + # expands to the logged in user's data. %%n, %%d, %%u and %%h expand to the + # destination user's data. + #location = maildir:%%h/Maildir:INDEX=~/Maildir/shared/%%u + + # Use the default namespace for saving subscriptions. + #subscriptions = no + + # List the shared/ namespace only if there are visible shared mailboxes. + #list = children +#} +# Should shared INBOX be visible as "shared/user" or "shared/user/INBOX"? +#mail_shared_explicit_inbox = no + +# System user and group used to access mails. If you use multiple, userdb +# can override these by returning uid or gid fields. You can use either numbers +# or names. +#mail_uid = +#mail_gid = + +# Group to enable temporarily for privileged operations. Currently this is +# used only with INBOX when either its initial creation or dotlocking fails. +# Typically this is set to "mail" to give access to /var/mail. +#mail_privileged_group = mail + +# Grant access to these supplementary groups for mail processes. Typically +# these are used to set up access to shared mailboxes. Note that it may be +# dangerous to set these if users can create symlinks (e.g. if "mail" group is +# set here, ln -s /var/mail ~/mail/var could allow a user to delete others' +# mailboxes, or ln -s /secret/shared/box ~/mail/mybox would allow reading it). +#mail_access_groups = + +# Allow full filesystem access to clients. There's no access checks other than +# what the operating system does for the active UID/GID. It works with both +# maildir and mboxes, allowing you to prefix mailboxes names with eg. /path/ +# or ~user/. +#mail_full_filesystem_access = no + +# Dictionary for key=value mailbox attributes. This is used for example by +# URLAUTH and METADATA extensions. +#mail_attribute_dict = + +# A comment or note that is associated with the server. This value is +# accessible for authenticated users through the IMAP METADATA server +# entry "/shared/comment". +#mail_server_comment = "" + +# Indicates a method for contacting the server administrator. According to +# RFC 5464, this value MUST be a URI (e.g., a mailto: or tel: URL), but that +# is currently not enforced. Use for example mailto:admin@example.com. This +# value is accessible for authenticated users through the IMAP METADATA server +# entry "/shared/admin". +#mail_server_admin = + +## +## Mail processes +## + +# Don't use mmap() at all. This is required if you store indexes to shared +# filesystems (NFS or clustered filesystem). +#mmap_disable = no + +# Rely on O_EXCL to work when creating dotlock files. NFS supports O_EXCL +# since version 3, so this should be safe to use nowadays by default. +#dotlock_use_excl = yes + +# When to use fsync() or fdatasync() calls: +# optimized (default): Whenever necessary to avoid losing important data +# always: Useful with e.g. NFS when write()s are delayed +# never: Never use it (best performance, but crashes can lose data) +#mail_fsync = optimized + +# Locking method for index files. Alternatives are fcntl, flock and dotlock. +# Dotlocking uses some tricks which may create more disk I/O than other locking +# methods. NFS users: flock doesn't work, remember to change mmap_disable. +#lock_method = fcntl + +# Directory where mails can be temporarily stored. Usually it's used only for +# mails larger than >= 128 kB. It's used by various parts of Dovecot, for +# example LDA/LMTP while delivering large mails or zlib plugin for keeping +# uncompressed mails. +#mail_temp_dir = /tmp + +# Valid UID range for users, defaults to 500 and above. This is mostly +# to make sure that users can't log in as daemons or other system users. +# Note that denying root logins is hardcoded to dovecot binary and can't +# be done even if first_valid_uid is set to 0. +#first_valid_uid = 500 +#last_valid_uid = 0 + +# Valid GID range for users, defaults to non-root/wheel. Users having +# non-valid GID as primary group ID aren't allowed to log in. If user +# belongs to supplementary groups with non-valid GIDs, those groups are +# not set. +#first_valid_gid = 1 +#last_valid_gid = 0 + +# Maximum allowed length for mail keyword name. It's only forced when trying +# to create new keywords. +#mail_max_keyword_length = 50 + +# ':' separated list of directories under which chrooting is allowed for mail +# processes (ie. /var/mail will allow chrooting to /var/mail/foo/bar too). +# This setting doesn't affect login_chroot, mail_chroot or auth chroot +# settings. If this setting is empty, "/./" in home dirs are ignored. +# WARNING: Never add directories here which local users can modify, that +# may lead to root exploit. Usually this should be done only if you don't +# allow shell access for users. +#valid_chroot_dirs = + +# Default chroot directory for mail processes. This can be overridden for +# specific users in user database by giving /./ in user's home directory +# (eg. /home/./user chroots into /home). Note that usually there is no real +# need to do chrooting, Dovecot doesn't allow users to access files outside +# their mail directory anyway. If your home directories are prefixed with +# the chroot directory, append "/." to mail_chroot. +#mail_chroot = + +# UNIX socket path to master authentication server to find users. +# This is used by imap (for shared users) and lda. +#auth_socket_path = /var/run/dovecot/auth-userdb + +# Directory where to look up mail plugins. +#mail_plugin_dir = /usr/lib/dovecot/modules + +# Space separated list of plugins to load for all services. Plugins specific to +# IMAP, LDA, etc. are added to this list in their own .conf files. +#mail_plugins = + +## +## Mailbox handling optimizations +## + +# Mailbox list indexes can be used to optimize IMAP STATUS commands. They are +# also required for IMAP NOTIFY extension to be enabled. +#mailbox_list_index = yes + +# Trust mailbox list index to be up-to-date. This reduces disk I/O at the cost +# of potentially returning out-of-date results after e.g. server crashes. +# The results will be automatically fixed once the folders are opened. +#mailbox_list_index_very_dirty_syncs = yes + +# Should INBOX be kept up-to-date in the mailbox list index? By default it's +# not, because most of the mailbox accesses will open INBOX anyway. +#mailbox_list_index_include_inbox = no + +# The minimum number of mails in a mailbox before updates are done to cache +# file. This allows optimizing Dovecot's behavior to do less disk writes at +# the cost of more disk reads. +#mail_cache_min_mail_count = 0 + +# When IDLE command is running, mailbox is checked once in a while to see if +# there are any new mails or other changes. This setting defines the minimum +# time to wait between those checks. Dovecot can also use inotify and +# kqueue to find out immediately when changes occur. +#mailbox_idle_check_interval = 30 secs + +# Save mails with CR+LF instead of plain LF. This makes sending those mails +# take less CPU, especially with sendfile() syscall with Linux and FreeBSD. +# But it also creates a bit more disk I/O which may just make it slower. +# Also note that if other software reads the mboxes/maildirs, they may handle +# the extra CRs wrong and cause problems. +#mail_save_crlf = no + +# Max number of mails to keep open and prefetch to memory. This only works with +# some mailbox formats and/or operating systems. +#mail_prefetch_count = 0 + +# How often to scan for stale temporary files and delete them (0 = never). +# These should exist only after Dovecot dies in the middle of saving mails. +#mail_temp_scan_interval = 1w + +# How many slow mail accesses sorting can perform before it returns failure. +# With IMAP the reply is: NO [LIMIT] Requested sort would have taken too long. +# The untagged SORT reply is still returned, but it's likely not correct. +#mail_sort_max_read_count = 0 + +protocol !indexer-worker { + # If folder vsize calculation requires opening more than this many mails from + # disk (i.e. mail sizes aren't in cache already), return failure and finish + # the calculation via indexer process. Disabled by default. This setting must + # be 0 for indexer-worker processes. + #mail_vsize_bg_after_count = 0 +} + +## +## Maildir-specific settings +## + +# By default LIST command returns all entries in maildir beginning with a dot. +# Enabling this option makes Dovecot return only entries which are directories. +# This is done by stat()ing each entry, so it causes more disk I/O. +# (For systems setting struct dirent->d_type, this check is free and it's +# done always regardless of this setting) +#maildir_stat_dirs = no + +# When copying a message, do it with hard links whenever possible. This makes +# the performance much better, and it's unlikely to have any side effects. +#maildir_copy_with_hardlinks = yes + +# Assume Dovecot is the only MUA accessing Maildir: Scan cur/ directory only +# when its mtime changes unexpectedly or when we can't find the mail otherwise. +#maildir_very_dirty_syncs = no + +# If enabled, Dovecot doesn't use the S= in the Maildir filenames for +# getting the mail's physical size, except when recalculating Maildir++ quota. +# This can be useful in systems where a lot of the Maildir filenames have a +# broken size. The performance hit for enabling this is very small. +#maildir_broken_filename_sizes = no + +# Always move mails from new/ directory to cur/, even when the \Recent flags +# aren't being reset. +#maildir_empty_new = no + +## +## mbox-specific settings +## + +# Which locking methods to use for locking mbox. There are four available: +# dotlock: Create .lock file. This is the oldest and most NFS-safe +# solution. If you want to use /var/mail/ like directory, the users +# will need write access to that directory. +# dotlock_try: Same as dotlock, but if it fails because of permissions or +# because there isn't enough disk space, just skip it. +# fcntl : Use this if possible. Works with NFS too if lockd is used. +# flock : May not exist in all systems. Doesn't work with NFS. +# lockf : May not exist in all systems. Doesn't work with NFS. +# +# You can use multiple locking methods; if you do the order they're declared +# in is important to avoid deadlocks if other MTAs/MUAs are using multiple +# locking methods as well. Some operating systems don't allow using some of +# them simultaneously. +# +# The Debian value for mbox_write_locks differs from upstream Dovecot. It is +# changed to be compliant with Debian Policy (section 11.6) for NFS safety. +# Dovecot: mbox_write_locks = dotlock fcntl +# Debian: mbox_write_locks = fcntl dotlock +# +#mbox_read_locks = fcntl +#mbox_write_locks = fcntl dotlock + +# Maximum time to wait for lock (all of them) before aborting. +#mbox_lock_timeout = 5 mins + +# If dotlock exists but the mailbox isn't modified in any way, override the +# lock file after this much time. +#mbox_dotlock_change_timeout = 2 mins + +# When mbox changes unexpectedly we have to fully read it to find out what +# changed. If the mbox is large this can take a long time. Since the change +# is usually just a newly appended mail, it'd be faster to simply read the +# new mails. If this setting is enabled, Dovecot does this but still safely +# fallbacks to re-reading the whole mbox file whenever something in mbox isn't +# how it's expected to be. The only real downside to this setting is that if +# some other MUA changes message flags, Dovecot doesn't notice it immediately. +# Note that a full sync is done with SELECT, EXAMINE, EXPUNGE and CHECK +# commands. +#mbox_dirty_syncs = yes + +# Like mbox_dirty_syncs, but don't do full syncs even with SELECT, EXAMINE, +# EXPUNGE or CHECK commands. If this is set, mbox_dirty_syncs is ignored. +#mbox_very_dirty_syncs = no + +# Delay writing mbox headers until doing a full write sync (EXPUNGE and CHECK +# commands and when closing the mailbox). This is especially useful for POP3 +# where clients often delete all mails. The downside is that our changes +# aren't immediately visible to other MUAs. +#mbox_lazy_writes = yes + +# If mbox size is smaller than this (e.g. 100k), don't write index files. +# If an index file already exists it's still read, just not updated. +#mbox_min_index_size = 0 + +# Mail header selection algorithm to use for MD5 POP3 UIDLs when +# pop3_uidl_format=%m. For backwards compatibility we use apop3d inspired +# algorithm, but it fails if the first Received: header isn't unique in all +# mails. An alternative algorithm is "all" that selects all headers. +#mbox_md5 = apop3d + +## +## mdbox-specific settings +## + +# Maximum dbox file size until it's rotated. +#mdbox_rotate_size = 10M + +# Maximum dbox file age until it's rotated. Typically in days. Day begins +# from midnight, so 1d = today, 2d = yesterday, etc. 0 = check disabled. +#mdbox_rotate_interval = 0 + +# When creating new mdbox files, immediately preallocate their size to +# mdbox_rotate_size. This setting currently works only in Linux with some +# filesystems (ext4, xfs). +#mdbox_preallocate_space = no + +## +## Mail attachments +## + +# sdbox and mdbox support saving mail attachments to external files, which +# also allows single instance storage for them. Other backends don't support +# this for now. + +# Directory root where to store mail attachments. Disabled, if empty. +#mail_attachment_dir = + +# Attachments smaller than this aren't saved externally. It's also possible to +# write a plugin to disable saving specific attachments externally. +#mail_attachment_min_size = 128k + +# Filesystem backend to use for saving attachments: +# posix : No SiS done by Dovecot (but this might help FS's own deduplication) +# sis posix : SiS with immediate byte-by-byte comparison during saving +# sis-queue posix : SiS with delayed comparison and deduplication +#mail_attachment_fs = sis posix + +# Hash format to use in attachment filenames. You can add any text and +# variables: %{md4}, %{md5}, %{sha1}, %{sha256}, %{sha512}, %{size}. +# Variables can be truncated, e.g. %{sha256:80} returns only first 80 bits +#mail_attachment_hash = %{sha1} + +# Settings to control adding $HasAttachment or $HasNoAttachment keywords. +# By default, all MIME parts with Content-Disposition=attachment, or inlines +# with filename parameter are consired attachments. +# add-flags-on-save - Add the keywords when saving new mails. +# content-type=type or !type - Include/exclude content type. Excluding will +# never consider the matched MIME part as attachment. Including will only +# negate an exclusion (e.g. content-type=!foo/* content-type=foo/bar). +# exclude-inlined - Exclude any Content-Disposition=inline MIME part. +#mail_attachment_detection_options = diff --git a/templates/etc/dovecot/conf.d/10-master.conf.j2 b/templates/etc/dovecot/conf.d/10-master.conf.j2 new file mode 100755 index 0000000..52b46a7 --- /dev/null +++ b/templates/etc/dovecot/conf.d/10-master.conf.j2 @@ -0,0 +1,150 @@ +#default_process_limit = 100 +#default_client_limit = 1000 + +# Default VSZ (virtual memory size) limit for service processes. This is mainly +# intended to catch and kill processes that leak memory before they eat up +# everything. +#default_vsz_limit = 256M + +# Login user is internally used by login processes. This is the most untrusted +# user in Dovecot system. It shouldn't have access to anything at all. +#default_login_user = dovenull + +# Internal user is used by unprivileged processes. It should be separate from +# login user, so that login processes can't disturb other processes. +#default_internal_user = dovecot + +service imap-login { + inet_listener imap { + #port = 143 + } + inet_listener imaps { + #port = 993 + #ssl = yes + } + + # Number of connections to handle before starting a new process. Typically + # the only useful values are 0 (unlimited) or 1. 1 is more secure, but 0 + # is faster. + #service_count = 1 + + # Number of processes to always keep waiting for more connections. + #process_min_avail = 0 + + # If you set service_count=0, you probably need to grow this. + #vsz_limit = $default_vsz_limit +} + +service pop3-login { + inet_listener pop3 { + #port = 110 + } + inet_listener pop3s { + #port = 995 + #ssl = yes + } +} + +service submission-login { + inet_listener submission { + #port = 587 + } +} + +service lmtp { + unix_listener lmtp { + #mode = 0666 + } + unix_listener /var/spool/postfix/private/dovecot-lmtp { + mode = 0600 + user = postfix + group = postfix + } + # Create inet listener only if you can't use the above UNIX socket + #inet_listener lmtp { + # Avoid making LMTP visible for the entire internet + #address = + #port = + #} +} + +service imap { + # Most of the memory goes to mmap()ing files. You may need to increase this + # limit if you have huge mailboxes. + #vsz_limit = $default_vsz_limit + + # Max. number of IMAP processes (connections) + #process_limit = 1024 + process_limit = {{ dovecot_process_limit }} + + #executable = imap postlogin +} + +service pop3 { + # Max. number of POP3 processes (connections) + #process_limit = 1024 + process_limit = {{ dovecot_process_limit }} + + #executable = pop3 postlogin +} + +service submission { + # Max. number of SMTP Submission processes (connections) + #process_limit = 1024 + process_limit = {{ dovecot_process_limit }} +} + +service auth { + # auth_socket_path points to this userdb socket by default. It's typically + # used by dovecot-lda, doveadm, possibly imap process, etc. Users that have + # full permissions to this socket are able to get a list of all usernames and + # get the results of everyone's userdb lookups. + # + # The default 0666 mode allows anyone to connect to the socket, but the + # userdb lookups will succeed only if the userdb returns an "uid" field that + # matches the caller process's UID. Also if caller's uid or gid matches the + # socket's uid or gid the lookup succeeds. Anything else causes a failure. + # + # To give the caller full permissions to lookup all users, set the mode to + # something else than 0666 and Dovecot lets the kernel enforce the + # permissions (e.g. 0777 allows everyone full permissions). + unix_listener auth-userdb { + #mode = 0666 + user = modoboa + group = modoboa + } + + # Postfix smtp-auth + unix_listener /var/spool/postfix/private/auth { + mode = 0666 + user = postfix + group = postfix + } + + # Auth process is run as this user. + #user = $default_internal_user + # Radicale auth + #unix_listener auth-radicale { + # mode = 0666 + # user = radicale + # group = radicale + #} +} + +service auth-worker { + # Auth worker process is run as root by default, so that it can access + # /etc/shadow. If this isn't necessary, the user should be changed to + # $default_internal_user. + #user = root +} + +service dict { + # If dict proxy is used, mail processes should have access to its socket. + # For example: mode=0660, group=vmail and global mail_access_groups=vmail + unix_listener dict { + mode = 0600 + user = {{ modoboa_user }} + group = {{ modoboa_user }} + } +} + diff --git a/templates/etc/dovecot/conf.d/10-ssl.conf.j2 b/templates/etc/dovecot/conf.d/10-ssl.conf.j2 new file mode 100755 index 0000000..e266d19 --- /dev/null +++ b/templates/etc/dovecot/conf.d/10-ssl.conf.j2 @@ -0,0 +1,76 @@ +## +## SSL settings +## + +# SSL/TLS support: yes, no, required. +ssl = yes + +# PEM encoded X.509 SSL/TLS certificate and private key. They're opened before +# dropping root privileges, so keep the key file unreadable by anyone but +# root. Included doc/mkcert.sh can be used to easily generate self-signed +# certificate, just make sure to update the domains in dovecot-openssl.cnf +ssl_cert = was automatically rejected:%n%r + +# Delimiter character between local-part and detail in email address. +#recipient_delimiter = + + +# Header where the original recipient address (SMTP's RCPT TO: address) is taken +# from if not available elsewhere. With dovecot-lda -a parameter overrides this. +# A commonly used header for this is X-Original-To. +#lda_original_recipient_header = + +# Should saving a mail to a nonexistent mailbox automatically create it? +#lda_mailbox_autocreate = no + +# Should automatically created mailboxes be also automatically subscribed? +#lda_mailbox_autosubscribe = no + +protocol lda { + # Space separated list of plugins to load (default is global mail_plugins). + mail_plugins = $mail_plugins sieve +} diff --git a/templates/etc/dovecot/conf.d/20-imap.conf.j2 b/templates/etc/dovecot/conf.d/20-imap.conf.j2 new file mode 100755 index 0000000..6cfb1ab --- /dev/null +++ b/templates/etc/dovecot/conf.d/20-imap.conf.j2 @@ -0,0 +1,98 @@ +## +## IMAP specific settings +## + +# If nothing happens for this long while client is IDLEing, move the connection +# to imap-hibernate process and close the old imap process. This saves memory, +# because connections use very little memory in imap-hibernate process. The +# downside is that recreating the imap process back uses some resources. +#imap_hibernate_timeout = 0 + +# Maximum IMAP command line length. Some clients generate very long command +# lines with huge mailboxes, so you may need to raise this if you get +# "Too long argument" or "IMAP command line too large" errors often. +#imap_max_line_length = 64k + +# IMAP logout format string: +# %i - total number of bytes read from client +# %o - total number of bytes sent to client +# %{fetch_hdr_count} - Number of mails with mail header data sent to client +# %{fetch_hdr_bytes} - Number of bytes with mail header data sent to client +# %{fetch_body_count} - Number of mails with mail body data sent to client +# %{fetch_body_bytes} - Number of bytes with mail body data sent to client +# %{deleted} - Number of mails where client added \Deleted flag +# %{expunged} - Number of mails that client expunged, which does not +# include automatically expunged mails +# %{autoexpunged} - Number of mails that were automatically expunged after +# client disconnected +# %{trashed} - Number of mails that client copied/moved to the +# special_use=\Trash mailbox. +# %{appended} - Number of mails saved during the session +#imap_logout_format = in=%i out=%o deleted=%{deleted} expunged=%{expunged} \ +# trashed=%{trashed} hdr_count=%{fetch_hdr_count} \ +# hdr_bytes=%{fetch_hdr_bytes} body_count=%{fetch_body_count} \ +# body_bytes=%{fetch_body_bytes} + +# Override the IMAP CAPABILITY response. If the value begins with '+', +# add the given capabilities on top of the defaults (e.g. +XFOO XBAR). +#imap_capability = + +# How long to wait between "OK Still here" notifications when client is +# IDLEing. +#imap_idle_notify_interval = 2 mins + +# ID field names and values to send to clients. Using * as the value makes +# Dovecot use the default value. The following fields have default values +# currently: name, version, os, os-version, support-url, support-email. +#imap_id_send = + +# ID fields sent by client to log. * means everything. +#imap_id_log = + +# Workarounds for various client bugs: +# delay-newmail: +# Send EXISTS/RECENT new mail notifications only when replying to NOOP +# and CHECK commands. Some clients ignore them otherwise, for example OSX +# Mail ( + #service_count = 1 + + # Number of processes to always keep waiting for more connections. + #process_min_avail = 0 + + # If you set service_count=0, you probably need to grow this. + #vsz_limit = 64M +} + +service managesieve { + # Max. number of ManageSieve processes (connections) + #process_limit = 1024 + process_limit = {{ dovecot_process_limit }} +} + +# Service configuration + +protocol sieve { + # Maximum ManageSieve command line length in bytes. ManageSieve usually does + # not involve overly long command lines, so this setting will not normally + # need adjustment + #managesieve_max_line_length = 65536 + + # Maximum number of ManageSieve connections allowed for a user from each IP + # address. + # NOTE: The username is compared case-sensitively. + #mail_max_userip_connections = 10 + + # Space separated list of plugins to load (none known to be useful so far). + # Do NOT try to load IMAP plugins here. + #mail_plugins = + + # MANAGESIEVE logout format string: + # %i - total number of bytes read from client + # %o - total number of bytes sent to client + # %{put_bytes} - Number of bytes saved using PUTSCRIPT command + # %{put_count} - Number of scripts saved using PUTSCRIPT command + # %{get_bytes} - Number of bytes read using GETCRIPT command + # %{get_count} - Number of scripts read using GETSCRIPT command + # %{get_bytes} - Number of bytes processed using CHECKSCRIPT command + # %{get_count} - Number of scripts checked using CHECKSCRIPT command + # %{deleted_count} - Number of scripts deleted using DELETESCRIPT command + # %{renamed_count} - Number of scripts renamed using RENAMESCRIPT command + #managesieve_logout_format = bytes=%i/%o + + # To fool ManageSieve clients that are focused on CMU's timesieved you can + # specify the IMPLEMENTATION capability that Dovecot reports to clients. + # For example: 'Cyrus timsieved v2.2.13' + #managesieve_implementation_string = Dovecot Pigeonhole + + # Explicitly specify the SIEVE and NOTIFY capability reported by the server + # before login. If left unassigned these will be reported dynamically + # according to what the Sieve interpreter supports by default (after login + # this may differ depending on the user). + #managesieve_sieve_capability = + #managesieve_notify_capability = + + # The maximum number of compile errors that are returned to the client upon + # script upload or script verification. + #managesieve_max_compile_errors = 5 + # Refer to 90-sieve.conf for script quota configuration and configuration of + # Sieve execution limits. +} diff --git a/templates/etc/dovecot/conf.d/90-quota.conf.j2 b/templates/etc/dovecot/conf.d/90-quota.conf.j2 new file mode 100755 index 0000000..3308c05 --- /dev/null +++ b/templates/etc/dovecot/conf.d/90-quota.conf.j2 @@ -0,0 +1,83 @@ +## +## Quota configuration. +## + +# Note that you also have to enable quota plugin in mail_plugins setting. +# + +## +## Quota limits +## + +# Quota limits are set using "quota_rule" parameters. To get per-user quota +# limits, you can set/override them by returning "quota_rule" extra field +# from userdb. It's also possible to give mailbox-specific limits, for example +# to give additional 100 MB when saving to Trash: + +plugin { + #quota_rule = *:storage=1G + #quota_rule2 = Trash:storage=+100M + + # LDA/LMTP allows saving the last mail to bring user from under quota to + # over quota, if the quota doesn't grow too high. Default is to allow as + # long as quota will stay under 10% above the limit. Also allowed e.g. 10M. + #quota_grace = 10%% + + # Quota plugin can also limit the maximum accepted mail size. + #quota_max_mail_size = 100M +} + +## +## Quota warnings +## + +# You can execute a given command when user exceeds a specified quota limit. +# Each quota root has separate limits. Only the command for the first +# exceeded limit is executed, so put the highest limit first. +# The commands are executed via script service by connecting to the named +# UNIX socket (quota-warning below). +# Note that % needs to be escaped as %%, otherwise "% " expands to empty. + +plugin { + #quota_warning = storage=95%% quota-warning 95 %u + #quota_warning2 = storage=80%% quota-warning 80 %u +} + +# Example quota-warning service. The unix listener's permissions should be +# set in a way that mail processes can connect to it. Below example assumes +# that mail processes run as vmail user. If you use mode=0666, all system users +# can generate quota warnings to anyone. +#service quota-warning { +# executable = script /usr/local/bin/quota-warning.sh +# user = dovecot +# unix_listener quota-warning { +# user = vmail +# } +#} + +## +## Quota backends +## + +# Multiple backends are supported: +# dirsize: Find and sum all the files found from mail directory. +# Extremely SLOW with Maildir. It'll eat your CPU and disk I/O. +# dict: Keep quota stored in dictionary (eg. SQL) +# maildir: Maildir++ quota +# fs: Read-only support for filesystem quota + +plugin { + #quota = dirsize:User quota + #quota = maildir:User quota + #quota = dict:User quota::proxy::quota + #quota = fs:User quota +} + +# Multiple quota roots are also possible, for example this gives each user +# their own 100MB quota and one shared 1GB quota within the domain: +plugin { + #quota = dict:user::proxy::quota + #quota2 = dict:domain:%d:proxy::quota_domain + #quota_rule = *:storage=102400 + #quota2_rule = *:storage=1048576 +} diff --git a/templates/etc/dovecot/conf.d/90-sieve.conf.j2 b/templates/etc/dovecot/conf.d/90-sieve.conf.j2 new file mode 100755 index 0000000..87f5837 --- /dev/null +++ b/templates/etc/dovecot/conf.d/90-sieve.conf.j2 @@ -0,0 +1,215 @@ +## +## Settings for the Sieve interpreter +## + +# Do not forget to enable the Sieve plugin in 15-lda.conf and 20-lmtp.conf +# by adding it to the respective mail_plugins= settings. + +# The Sieve interpreter can retrieve Sieve scripts from several types of +# locations. The default `file' location type is a local filesystem path +# pointing to a Sieve script file or a directory containing multiple Sieve +# script files. More complex setups can use other location types such as +# `ldap' or `dict' to fetch Sieve scripts from remote databases. +# +# All settings that specify the location of one ore more Sieve scripts accept +# the following syntax: +# +# location = [:]path[;