r2169 - add some comments for future reference
[racktables] / README
diff --git a/README b/README
index 54d1dd74ff26dab75bd170592897c5c78881737a..ca809d402674933632c0a4bd787237f63592b5dd 100644 (file)
--- a/README
+++ b/README
@@ -16,16 +16,29 @@ Authors: <info/=@=/racktables.org>
 
 I. Dependencies.
 
 
 I. Dependencies.
 
-For database you must have a MySQL server installation version 4.x or 5.x:
-Fedora Core 6: yum install mysql-server mysql
-Fedora 8: yum install mysql-server mysql
-ALTLinux Compact 3.0: apt-get install MySQL-server MySQL-client
-ALTLinux Desktop 4.0: apt-get install MySQL-server 
+For database you must have a MySQL server installation
+version 4.x or 5.x. It is a good idea to make it use UTF-8
+by default.
 
 
-For web-frontend you must have Apache and PHP 5 with PDO extension:
-Fedora Core 6: # yum install httpd php php-mysql php-pdo php-gd
-Fedora 8: yum install httpd php php-mysql php-pdo php-gd php-snmp
+* Fedora 8/9: yum install mysql-server mysql
+put "default-character-set=utf8" into /etc/my.cnf
 
 
+* ALTLinux Desktop 4.0: apt-get install MySQL-server 
+put "CHSET=utf8" into /etc/sysconfig/mysqld
+
+*openSUSE 11.0: YaST -> Software -> software management -> Web and LAMP server -> mysql
+put "default-character-set=utf8" into /etc/my.cnf
+
+For web-frontend you must have Apache and PHP 5 with PDO and multibyte
+extensions:
+
+* Fedora 8/9: yum install httpd php php-mysql php-pdo php-gd php-snmp php-mbstring
+
+* ALTLinux Server 4.0: apt-get install apache2-httpd-prefork php5-gd2 \
+php5-pdo_mysql php5-pdo apache2-mod_php5 php5-mbstring
+
+* openSUSE 11.0: use YaST to apache2-mod_php5, php5-gd, php5-mbstring, php5-mysql,
+php2-snmp and php5-ldap
 
 II. Prepare the server.
 1. Unpack the tarball and make it web-accessible, e.g. http://yourcompany.com/racktables
 
 II. Prepare the server.
 1. Unpack the tarball and make it web-accessible, e.g. http://yourcompany.com/racktables
@@ -80,7 +93,45 @@ procedure should be sufficient:
 *                                                     *
 *******************************************************
 
 *                                                     *
 *******************************************************
 
-Upgrading to 0.14.12
+*** Upgrading to 0.14.12 ***
+
 The upgrade may show a failed query "alter database character set utf8", in
 this case the user should issue the query manually from the mysql command
 line.
 The upgrade may show a failed query "alter database character set utf8", in
 this case the user should issue the query manually from the mysql command
 line.
+
+*** Upgrading to 0.16.0 ***
+
+This release features a completely new authorization system, RackCode,
+which brings the tags feature (introduced in 0.15.0) to its full potential.
+The old-style user permissions are converted during upgrade automatically,
+but the result may appear not what you would expect. Review the RackCode
+after upgrade (Main page -> Configuration -> Permissions) and adjust,
+if necessary.
+
+Another important change is a new dependency on "multibyte string" PHP
+extension. Normally one should get it working before starting the upgrade,
+this is typically achieved by installing a particular PHP RPM from the
+standard package repository (and restarting Apache after that):
+
+Fedora: yum install php-mbstring
+ALTLinux: apt-get install php5-mbstring
+
+*** Upgrading to 0.16.1 ***
+This release fixes a missing UNIQUE key in the database. However, this fix
+may sometimes fail, if the table contains duplicate records. If the
+0.16.0-0.16.1 upgrade batch completed without errors, no action needs to be
+taken. If you see a failed ADD UNIQUE query during upgrade, the only solution
+is to delete the duplicates manually. To do this, open a MySQL console and
+issue the failed query again:
+
+mysql> alter table IPVirtualService ADD UNIQUE endpoint (vip, vport, proto);
+
+The IP address of the duplicate VS will be known from the "Duplicate entry"
+message. For example, to decode "Duplicate entry '180879877-80-TCP' for key
+2" error message, issue:
+
+mysql> select inet_ntoa(180879877);
+
+Then go to "virtual services" web-interface page and adjust the data as
+necessary. You would need to get rid of the duplicates accurately one by
+one, repeating the ADD UNIQUE query until it succeeds.