r2781 - reverted changeset:2623, ticket:39 is reopened
[racktables] / README
1 Thank you for selecting RackTables as your datacenter management
2 solution. Feel free to address your questions to the mailing list
3 before contacting the authors directly. The project web-site
4 (http://racktables.org/) is usually kept up to date with the
5 current version and URLs.
6
7 Mailing list: <racktables-users/=@=/freelists.org>
8 Bug tracker and Wiki: http://racktables.org/trac
9 Authors: <info/=@=/racktables.org>
10
11 *******************************************************
12 * *
13 * INSTALLING RACKTABLES *
14 * *
15 *******************************************************
16
17 I. Install dependencies.
18
19 For database you must have a MySQL server installation
20 version 4.x or 5.x. InnoDB support must be enabled.
21 It is a good idea to make it use UTF-8 by default.
22
23 * Fedora 8/9: yum install mysql-server mysql
24 put "default-character-set=utf8" into /etc/my.cnf
25
26 * ALTLinux Desktop 4.0: apt-get install MySQL-server
27 put "CHSET=utf8" into /etc/sysconfig/mysqld
28
29 * openSUSE 11.0: YaST -> Software -> software management -> Web and LAMP server -> mysql
30 put "default-character-set=utf8" into /etc/my.cnf
31
32 For web-frontend you must have Apache and PHP 5 with PDO and multibyte
33 extensions:
34
35 * Fedora 8/9: yum install httpd php php-mysql php-pdo php-gd php-snmp php-mbstring
36
37 * ALTLinux Server 4.0: apt-get install apache2-httpd-prefork php5-gd2 \
38 php5-pdo_mysql php5-pdo apache2-mod_php5 php5-mbstring
39
40 * openSUSE 11.0: use YaST to apache2-mod_php5, php5-gd, php5-mbstring, php5-mysql,
41 php5-snmp and php5-ldap
42
43
44 II. Prepare the files and database.
45 1. Unpack the tarball and make it web-accessible, e.g. http://yourcompany.com/racktables
46 or http://racktables.mysite.org.
47 2. mysql> create database database_name; grant all privileges on database_name.* to XXX@YYY identified by 'ZZZ';
48
49
50 III. Finish the installation.
51 Open your RackTables URL and follow the instructions. In a suitable
52 environment everything should take a minute or so.
53
54 *******************************************************
55 * *
56 * UPGRADING RACKTABLES *
57 * *
58 *******************************************************
59 RackTables (since 0.14.6) provides an automatic database upgrade feature.
60 If you already have a working installation, the following procedure
61 should be sufficient:
62
63 0. BACKUP YOUR DATABASE
64 1. Remove all existing files except inc/secret.php, gateways'
65 configuration (in the gateways directory) and local mod (inc/local.php).
66 2. Unpack the new tarball into the place.
67 3. Open the RackTables page in your browser. The software detects version
68 mismatch and displays a message telling to log in as admin to finish
69 the upgrade.
70 4. Do that. Normally, everything should be Ok. If there are
71 errors displayed, copy and send them to us for review.
72
73 *******************************************************
74 * *
75 * RELEASE NOTES *
76 * *
77 *******************************************************
78
79 *** Upgrading to 0.14.12 ***
80
81 The upgrade may show a failed query "alter database character set utf8", in
82 this case the user should issue the query manually from the mysql command
83 line.
84
85 *** Upgrading to 0.16.0 ***
86
87 This release features a completely new authorization system, RackCode,
88 which brings the tags feature (introduced in 0.15.0) to its full potential.
89 The old-style user permissions are converted during upgrade automatically,
90 but the result may appear not what you would expect. Review the RackCode
91 after upgrade (Main page -> Configuration -> Permissions) and adjust,
92 if necessary.
93
94 Another important change is a new dependency on "multibyte string" PHP
95 extension. Normally one should get it working before starting the upgrade,
96 this is typically achieved by installing a particular PHP RPM from the
97 standard package repository (and restarting Apache after that):
98
99 Fedora: yum install php-mbstring
100 ALTLinux: apt-get install php5-mbstring
101
102 *** Upgrading to 0.16.3 ***
103
104 This release fixes a missing UNIQUE KEY in a table. The upgrade script may
105 find it necessary first to transform some records. Because of this it is
106 normal to see several "update TagStorage ... Duplicate entry" failed queries
107 during the upgrade.
108
109 *** Upgrading to 0.17.0 ***
110
111 This release is the first to take advantage of the foreign key support
112 provided by the InnoDB storage engine in MySQL. The installer and
113 upgrader scripts check for InnoDB support and cannot complete without it.
114 If you have trouble, the first step is to make sure the 'skip-innodb'
115 option in my.cnf is commented out.
116
117 Another change is the addition of support for file uploads. Files are stored
118 in the database. There are several settings in php.ini which you may need to modify:
119 file_uploads - needs to be On
120 upload_max_filesize - max size for uploaded files
121 post_max_size - max size of all form data submitted via POST (including files)
122
123 User accounts used to have 'enabled' flag, which allowed individual blocking and
124 unblocking of each. This flag was dropped in favor of existing mean of access
125 setup (RackCode). An unconditional denying rule is automatically added into RackCode
126 for such blocked account, so the effective security policy remains the same.