Merge pull request #3053 from modoboa/doc-2-2

updated doc for 2.2

doc/manual_installation/dovecot.rst

@@ -171,20 +171,25 @@ For debian and derivative, you need to install mysql connector for dovecot::
 
   default_pass_scheme = CRYPT
 
+  user_query = \
+    SELECT '%{home_dir}/%%d/%%n' AS home, %mailboxes_owner_uid as uid, \
+    %mailboxes_owner_gid as gid, \
+    CONCAT('*:bytes=', mb.quota, 'M') AS quota_rule \
+    FROM admin_mailbox mb \
+    INNER JOIN admin_domain dom ON mb.domain_id=dom.id \
+    INNER JOIN core_user u ON u.id=mb.user_id \
+    WHERE (mb.is_send_only=0 OR '%s' NOT IN ('imap', 'pop3', 'lmtp')) \
+    AND mb.address='%%n' AND dom.name='%%d'
+
   password_query = \
-    SELECT email AS user, password \
+    SELECT email AS user, password, '%{home_dir}/%%d/%%n' AS userdb_home, \
+    %mailboxes_owner_uid AS userdb_uid, %mailboxes_owner_gid AS userdb_gid, \
+    CONCAT('*:bytes=', mb.quota, 'M') AS userdb_quota_rule \
     FROM core_user u \
     INNER JOIN admin_mailbox mb ON u.id=mb.user_id \
     INNER JOIN admin_domain dom ON mb.domain_id=dom.id \
-    WHERE u.email='%L{user}' AND u.is_active=1 AND dom.enabled=1
-
-  user_query = \
-    SELECT '<mailboxes storage directory>/%Ld/%Ln' AS home, \
-      <uid> as uid, <gid> as gid, CONCAT('*:bytes=', mb.quota, 'M') AS quota_rule \
-    FROM admin_mailbox mb \
-    INNER JOIN admin_domain dom ON mb.domain_id=dom.id \
-    INNER JOIN core_user u ON mb.user_id=u.id \
-    WHERE mb.address='%L{username}' AND dom.name='%L{domain}' AND u.is_active=1 AND dom.enabled=1
+    WHERE (mb.is_send_only=0 OR '%s' NOT IN ('imap', 'pop3')) \
+    AND u.email='%%u' AND u.is_active=1 AND dom.enabled=1
 
   iterate_query = SELECT email AS user FROM core_user WHERE is_active
 
@@ -204,20 +209,24 @@ For debian and derivative, you need to install postgres connector for dovecot::
 
   default_pass_scheme = CRYPT
 
+  user_query = \
+    SELECT '%{home_dir}/%%d/%%n' AS home, %mailboxes_owner_uid as uid, \
+    %mailboxes_owner_gid as gid, '*:bytes=' || mb.quota || 'M' AS quota_rule \
+    FROM admin_mailbox mb \
+    INNER JOIN admin_domain dom ON mb.domain_id=dom.id \
+    INNER JOIN core_user u ON u.id=mb.user_id \
+    WHERE (mb.is_send_only IS NOT TRUE OR '%s' NOT IN ('imap', 'pop3', 'lmtp')) \
+    AND mb.address='%%n' AND dom.name='%%d'
+
   password_query = \
-    SELECT email AS user, password \
+    SELECT email AS user, password, '%{home_dir}/%%d/%%n' AS userdb_home, \
+    %mailboxes_owner_uid AS userdb_uid, %mailboxes_owner_gid AS userdb_gid, \
+    CONCAT('*:bytes=', mb.quota, 'M') AS userdb_quota_rule \
     FROM core_user u \
     INNER JOIN admin_mailbox mb ON u.id=mb.user_id \
     INNER JOIN admin_domain dom ON mb.domain_id=dom.id \
-    WHERE u.email='%L{user}' AND u.is_active AND dom.enabled
-
-  user_query = \
-    SELECT '<mailboxes storage directory>/%Ld/%Ln' AS home, \
-      <uid> as uid, <gid> as gid, CONCAT('*:bytes=', mb.quota, 'M') AS quota_rule \
-    FROM admin_mailbox mb \
-    INNER JOIN admin_domain dom ON mb.domain_id=dom.id \
-    INNER JOIN core_user u ON mb.user_id=u.id \
-    WHERE mb.address='%L{username}' AND dom.name='%L{domain}' AND u.is_active AND dom.enabled
+    WHERE (mb.is_send_only IS NOT TRUE OR '%s' NOT IN ('imap', 'pop3'))\
+    AND email='%%u' AND is_active AND dom.enabled
 
   iterate_query = SELECT email AS user FROM core_user WHERE is_active
 

doc/manual_installation/modoboa.rst

@@ -311,11 +311,13 @@ But we recommend an automatic start using ``systemd`` or
 
 .. sourcecode:: ini
 
-   [program:modoboa-worker]
+   [program:modoboa-dkim-worker]
    autostart=true
    autorestart=true
-   command=/srv/modoboa/env/bin/python /srv/modoboa/instance/manage.py worker high default low
-   directory=/srv/modoboa
+   command=<path to Python binary inside the virtual environment> <path to Modoboa instance>/manage.py rqworker dkim
+   directory=<modoboa user home dir>
+   user=<opendkim user>
+   redirect_stderr=true
    numprocs=1
    stopsignal=TERM
 

doc/upgrade.rst

@@ -55,6 +55,24 @@ Make sure to use root privileges and run the following command:
 
 Then, reload postfix.
 
+
+Updating the installer
+======================
+
+It is important to keep the installer updated because it works on rolling release.
+To do that, go to modoboa-installer directory then:
+
+.. sourcecode:: bash
+
+   > git fetch && git pull
+
+If some error appears, you may try this:
+
+.. sourcecode:: bash
+
+   > git reset --hard origin/master
+
+
 New-admin interface
 ===================
 
@@ -117,10 +135,10 @@ Specific instructions
 =====
 
 .. note::
-   This version has not been released yet.
-
-.. note::
-   If you use the installer to perform the upgrade, you only need to edit ``urls.py`` and ``settings.py``
+   If you use the installer to perform the upgrade, you NEED to update it.
+   See above for instructions.
+   After updating the installer and modoboa with it,
+   you only need to edit ``urls.py`` and ``settings.py``
 
 * Django has been updated to 4.2LTS. Please upgrade all your extensions alongside modoboa
 * Support for Python 3.7 has been dropped, minimum Python version is now 3.8