doc/web: Updated documentation for vmm-0.6.1.
authorPascal Volk <user@localhost.localdomain.org>
Wed, 03 Oct 2012 12:43:27 +0000
changeset 626 f151defe7078
parent 625 ac27f89fad86
child 627 682431c45b24
doc/web: Updated documentation for vmm-0.6.1.
doc/web/source/conf.py
doc/web/source/download.rst
doc/web/source/howto/manage_accounts.rst
doc/web/source/installation/install_vmm.rst
doc/web/source/installation/postgresql_configuration.rst
doc/web/source/pgsql_set_permissionspermissions.rst
doc/web/source/release_history.rst
doc/web/source/substitutions.rst
doc/web/source/upgrade/0.5-0.6.rst
--- a/doc/web/source/conf.py	Tue Oct 02 07:47:20 2012 +0200
+++ b/doc/web/source/conf.py	Wed Oct 03 12:43:27 2012 +0000
@@ -50,7 +50,7 @@
 # The short X.Y version.
 version = '0.6'
 # The full version, including alpha/beta/rc tags.
-release = '0.6.0'
+release = '0.6.1'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
--- a/doc/web/source/download.rst	Tue Oct 02 07:47:20 2012 +0200
+++ b/doc/web/source/download.rst	Wed Oct 03 12:43:27 2012 +0000
@@ -10,18 +10,18 @@
 Download a gzip compressed archive
 ----------------------------------
 vmm could be downloaded from the `download page`_ at `SourceForge`_. To
-extract the downloaded archive use ``tar xzf vmm-0.6.0.tar.gz``. This will
-create the new directory :file:`vmm-0.6.0` in the current working directory.
+extract the downloaded archive use ``tar xzf vmm-0.6.1.tar.gz``. This will
+create the new directory :file:`vmm-0.6.1` in the current working directory.
 
 Verify the downloaded archive
 -----------------------------
 If you have downloaded the archive from the download site you can
 optionally verify the integrity_ of this archive.
 In order to verify the integrity of the archive you have to download the
-corresponding signature file (:file:`vmm-0.6.0.tar.gz.sig`) too.
+corresponding signature file (:file:`vmm-0.6.1.tar.gz.sig`) too.
 The signature can be verified using GPG_ or PGP_.
-For example to check the signature of the archive :file:`vmm-0.6.0.tar.gz`
-you can execute this command ``gpg --verify vmm-0.6.0.tar.gz.sig``.
+For example to check the signature of the archive :file:`vmm-0.6.1.tar.gz`
+you can execute this command ``gpg --verify vmm-0.6.1.tar.gz.sig``.
 
 The tarball was signed by Pascal Volk (ID: CEC0904E).
 You can fetch the public key from a key server using the command
@@ -31,10 +31,10 @@
 -------------------------------------
 To get a tagged clone of the current vmm release from the Mercurial_
 repository use:
-``hg clone http://hg.localdomain.org/vmm/ -r vmm-0.6.0 vmm-0.6.0``.
-This will put the files into the new created directory :file:`vmm-0.6.0`.
+``hg clone http://hg.localdomain.org/vmm/ -r vmm-0.6.1 vmm-0.6.1``.
+This will put the files into the new created directory :file:`vmm-0.6.1`.
 
-When you omit the ``-r vmm-0.6.0`` option, you will get the latest changes
+When you omit the ``-r vmm-0.6.1`` option, you will get the latest changes
 from the `vmm repository`_. This code may work for you or not.
 
 .. include:: substitutions.rst
--- a/doc/web/source/howto/manage_accounts.rst	Tue Oct 02 07:47:20 2012 +0200
+++ b/doc/web/source/howto/manage_accounts.rst	Wed Oct 03 12:43:27 2012 +0000
@@ -173,6 +173,8 @@
 
  root@host:~# userservices d.user@example.com SMTP IMAP
 
+.. _usertransport:
+
 usertransport
 -------------
 Syntax:
--- a/doc/web/source/installation/install_vmm.rst	Tue Oct 02 07:47:20 2012 +0200
+++ b/doc/web/source/installation/install_vmm.rst	Wed Oct 03 12:43:27 2012 +0000
@@ -2,19 +2,19 @@
 Installing vmm
 ==============
 After you've prepared everything, it's time to install vmm.
-Change into the :file:`vmm-0.6.0` directory an execute the
+Change into the :file:`vmm-0.6.1` directory an execute the
 :file:`install.sh` script.
 You can adjust the installation prefix by modifying line 8 of the script.
 
 .. code-block:: console
 
- root@host:~# cd /path/to/vmm-0.6.0
- root@host:/path/to/vmm-0.6.0# ./install.sh
+ root@host:~# cd /path/to/vmm-0.6.1
+ root@host:/path/to/vmm-0.6.1# ./install.sh
 
  Don't forget to edit /usr/local/etc/vmm.cfg - or run: vmm cf
  and /etc/postfix/pgsql-*.cf files.
 
- root@host:/path/to/vmm-0.6.0#
+ root@host:/path/to/vmm-0.6.1#
 
 pgsql-\*.cf files
 -----------------
--- a/doc/web/source/installation/postgresql_configuration.rst	Tue Oct 02 07:47:20 2012 +0200
+++ b/doc/web/source/installation/postgresql_configuration.rst	Wed Oct 03 12:43:27 2012 +0000
@@ -98,14 +98,14 @@
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 .. code-block:: postgresql-console
 
- mailsys=> \i /path/to/vmm-0.6.0/pgsql/create_tables-dovecot-1.2.x.pgsql
+ mailsys=> \i /path/to/vmm-0.6.1/pgsql/create_tables-dovecot-1.2.x.pgsql
  mailsys=> \q
 
 Dovecot v1.0.x/v1.1.x
 ^^^^^^^^^^^^^^^^^^^^^
 .. code-block:: postgresql-console
 
- mailsys=> \i /path/to/vmm-0.6.0/pgsql/create_tables.pgsql
+ mailsys=> \i /path/to/vmm-0.6.1/pgsql/create_tables.pgsql
  mailsys=> \q
 
 Set database permissions
--- a/doc/web/source/pgsql_set_permissionspermissions.rst	Tue Oct 02 07:47:20 2012 +0200
+++ b/doc/web/source/pgsql_set_permissionspermissions.rst	Wed Oct 03 12:43:27 2012 +0000
@@ -3,7 +3,7 @@
 
 .. code-block:: console
 
- user@host:~$ python /path/to/vmm-0.6.0/pgsql/set-permissions.py -h
+ user@host:~$ python /path/to/vmm-0.6.1/pgsql/set-permissions.py -h
  Usage: set-permissions.py OPTIONS
  
  Set permissions for Dovecot and Postfix in the vmm database.
@@ -27,7 +27,7 @@
    -M USER, --postfix=USER
                          Database user name of the Postfix (MTA)  database
                          user. Default: postfix
- user@host:~$ python /path/to/vmm-0.6.0/pgsql/set-permissions.py -a -H 127.0.0.1 -U vmm
+ user@host:~$ python /path/to/vmm-0.6.1/pgsql/set-permissions.py -a -H 127.0.0.1 -U vmm
  Password: 
  user@host:~$ 
 
--- a/doc/web/source/release_history.rst	Tue Oct 02 07:47:20 2012 +0200
+++ b/doc/web/source/release_history.rst	Wed Oct 03 12:43:27 2012 +0000
@@ -5,6 +5,7 @@
 =========== ============ ======================================================
 Version     Release Date Download URL
 =========== ============ ======================================================
+vmm-0.6.1   Oct 03 2012  https://sourceforge.net/projects/vmm/files/vmm/0.6.1
 vmm-0.6.0   Jun 28 2012  https://sourceforge.net/projects/vmm/files/vmm/0.6.0
 vmm-0.5.2   Sep 09 2009  https://sourceforge.net/projects/vmm/files/vmm/0.5.2
 vmm-0.5.1   Aug 12 2009  https://sourceforge.net/projects/vmm/files/vmm/0.5.1
--- a/doc/web/source/substitutions.rst	Tue Oct 02 07:47:20 2012 +0200
+++ b/doc/web/source/substitutions.rst	Wed Oct 03 12:43:27 2012 +0000
@@ -1,4 +1,4 @@
-.. |curr_vers_rel_date| replace:: The most current version of vmm is 0.6.0,
- released on 28 June 2012.
+.. |curr_vers_rel_date| replace:: The most current version of vmm is 0.6.1,
+ released on 03 October 2012.
 .. |rel_hist| replace:: Older releases are listed in the :doc:`release_history`.
 
--- a/doc/web/source/upgrade/0.5-0.6.rst	Tue Oct 02 07:47:20 2012 +0200
+++ b/doc/web/source/upgrade/0.5-0.6.rst	Wed Oct 03 12:43:27 2012 +0000
@@ -50,14 +50,14 @@
 """"""""""""""""""""""""""""
 .. code-block:: postgresql-console
 
- mailsys=> \i /path/to/vmm-0.6.0/pgsql/update_tables_0.5.x-0.6-dovecot-1.2.x.pgsql
+ mailsys=> \i /path/to/vmm-0.6.1/pgsql/update_tables_0.5.x-0.6-dovecot-1.2.x.pgsql
  mailsys=> \q
 
 Dovecot v1.0.x/v1.1.x
 """""""""""""""""""""
 .. code-block:: postgresql-console
 
- mailsys=> \i /path/to/vmm-0.6.0/pgsql/update_tables_0.5.x-0.6.pgsql
+ mailsys=> \i /path/to/vmm-0.6.1/pgsql/update_tables_0.5.x-0.6.pgsql
  mailsys=> \q
 
 .. _set-database-permissions:
@@ -74,7 +74,7 @@
    So you have to adjust all your ``postfix/pgsql-*.cf`` files and also your
    ``/etc/dovecot/dovecot-sql.conf`` or ``/etc/dovecot/dovecot-sql.conf.ext``.
 
-   See the `vmm-0.6.0/postfix/pgsql-*.cf` files and
+   See the `vmm-0.6.1/postfix/pgsql-*.cf` files and
    :ref:`Dovecot configuration <dovecot-sql-conf-ext>`/`dovecot-sql.conf.ext`
    or :ref:`Dovecot configuration <dovecot-sql-conf>`/`dovecot-sql-conf`.
 
@@ -94,8 +94,8 @@
 
 .. code-block:: console
 
- root@host:~# cd /path/to/vmm-0.6.0
- root@host:/path/to/vmm-0.6.0# ./upgrade.sh
+ root@host:~# cd /path/to/vmm-0.6.1
+ root@host:/path/to/vmm-0.6.1# ./upgrade.sh
  Please have a look at your configuration: /usr/local/etc/vmm.cfg
  This are your Modified/Renamed/New settings:
  R   account.delete_directory = false
@@ -121,6 +121,63 @@
  Removed option "gid_mail" from section "misc" (obsolte)
 
 
+Upgrading from vmm-0.6.0
+------------------------
+
+Database fixes
+^^^^^^^^^^^^^^
+Due to an error in :ref:`usertransport`'s argument parsing, it is possible
+that some users' transport-ID points to the erroneous transport *domain*.
+To fix that error in your database, execute the following SQL statement:
+
+.. code-block:: psql
+
+ UPDATE users SET tid = NULL
+  WHERE tid = (SELECT tid FROM transport WHERE transport = 'domain');
+
+If you are using Dovecot < v.1.2.0, you have to replace the database
+function *dovecotpassword()*.
+The *service_set.ssid* was selected unconditionally.
+This may cause an empty result, which will make logins impossible.
+To replace the function execute the following SQL statement:
+
+.. code-block:: psql
+
+ CREATE OR REPLACE FUNCTION dovecotpassword(
+     IN localpart varchar, IN the_domain varchar) RETURNS SETOF dovecotpassword
+ AS $$
+     DECLARE
+         record dovecotpassword;
+         userid varchar(320) := localpart || '@' || the_domain;
+     BEGIN
+         FOR record IN
+             SELECT userid, passwd, smtp, pop3, imap, managesieve
+               FROM users, service_set, domain_data
+              WHERE users.gid = (SELECT gid
+                                   FROM domain_name
+                                  WHERE domainname = the_domain)
+                AND local_part = localpart
+                AND users.gid = domain_data.gid
+                AND CASE WHEN
+                   users.ssid IS NOT NULL
+                   THEN
+                     service_set.ssid = users.ssid
+                   ELSE
+                     service_set.ssid = domain_data.ssid
+                   END
+             LOOP
+                 RETURN NEXT record;
+             END LOOP;
+         RETURN;
+     END;
+ $$ LANGUAGE plpgsql STABLE
+ RETURNS NULL ON NULL INPUT
+ EXTERNAL SECURITY INVOKER;
+
+Upgrade vmm
+^^^^^^^^^^^
+Execute the :file:`upgrade.sh`, in order to install the updated code.
+
 Upgrade to Dovecot ≧ v1.2.beta2
 -------------------------------
 When you are upgrading your old Dovecot (< v.1.2.beta2) to a newer version,