r3230 - 0.17.8: pre-release adjustments
[racktables] / README
CommitLineData
de8695b2
DO
1Thank you for selecting RackTables as your datacenter management
2solution. Feel free to address your questions to the mailing list
3before contacting the authors directly. The project web-site
4(http://racktables.org/) is usually kept up to date with the
2dfc597c 5current version and URLs.
de8695b2
DO
6
7Mailing list: <racktables-users/=@=/freelists.org>
2dfc597c 8Bug tracker and Wiki: http://racktables.org/trac
de8695b2
DO
9Authors: <info/=@=/racktables.org>
10
11*******************************************************
12* *
13* INSTALLING RACKTABLES *
14* *
15*******************************************************
16
d3372430 17I. Install dependencies.
de8695b2 18
3ebdbeed 19For database you must have a MySQL server installation
e1ae3fb4
AD
20version 4.x or 5.x. InnoDB support must be enabled.
21It is a good idea to make it use UTF-8 by default.
3ebdbeed
DO
22
23* Fedora 8/9: yum install mysql-server mysql
24put "default-character-set=utf8" into /etc/my.cnf
25
26* ALTLinux Desktop 4.0: apt-get install MySQL-server
27put "CHSET=utf8" into /etc/sysconfig/mysqld
28
3e1c9c67 29* openSUSE 11.0: YaST -> Software -> software management -> Web and LAMP server -> mysql
3ebdbeed 30put "default-character-set=utf8" into /etc/my.cnf
de8695b2 31
9ddee5ea
DO
32For web-frontend you must have Apache and PHP 5 with PDO and multibyte
33extensions:
3ebdbeed
DO
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 \
9ddee5ea 38php5-pdo_mysql php5-pdo apache2-mod_php5 php5-mbstring
c2d46542 39
3ebdbeed 40* openSUSE 11.0: use YaST to apache2-mod_php5, php5-gd, php5-mbstring, php5-mysql,
93bdb7ba 41php5-snmp and php5-ldap
3ebdbeed 42
a3bce64d
DO
43* FreeBSD 7:
44# make -C /usr/ports/www/apache13-modssl install
45# make -C /usr/ports/www/php5-session install
46[X] CLI Build CLI version
47[X] APACHE Build Apache module
48[X] MULTIBYTE Enable zend multibyte support
49# make -C /usr/ports/graphics/php5-gd install
50# make -C /usr/ports/databases/php5-pdo_mysql install
51# make -C /usr/ports/devel/php5-pcre install
52# make -C /usr/ports/converters/php5-mbstring install
53[X] REGEX Enable multibyte regex support
54
55# make -C /usr/ports/net-mgmt/php5-snmp install
56# make -C /usr/ports/net/php5-ldap install
d3372430
DO
57
58II. Prepare the files and database.
de8695b2
DO
591. Unpack the tarball and make it web-accessible, e.g. http://yourcompany.com/racktables
60or http://racktables.mysite.org.
1538b9c9
DO
61
622. Setup MySQL database:
63mysql> CREATE DATABASE racktables_db CHARACTER SET utf8 COLLATE utf8_general_ci;
64mysql> grant all privileges on racktables_db.* to XXX@YYY identified by 'ZZZ';
c2d46542
DO
65
66
d3372430 67III. Finish the installation.
c2d46542
DO
68Open your RackTables URL and follow the instructions. In a suitable
69environment everything should take a minute or so.
70
de8695b2
DO
71*******************************************************
72* *
73* UPGRADING RACKTABLES *
74* *
75*******************************************************
d3372430
DO
76RackTables (since 0.14.6) provides an automatic database upgrade feature.
77If you already have a working installation, the following procedure
78should be sufficient:
de8695b2
DO
79
800. BACKUP YOUR DATABASE
80138748
DO
811. Remove all existing files except inc/secret.php, gateways'
82 configuration (in the gateways directory) and local mod (inc/local.php).
de8695b2 832. Unpack the new tarball into the place.
d3372430
DO
843. Open the RackTables page in your browser. The software detects version
85 mismatch and displays a message telling to log in as admin to finish
86 the upgrade.
874. Do that. Normally, everything should be Ok. If there are
88 errors displayed, copy and send them to us for review.
7fc5565c 89
c2d46542
DO
90*******************************************************
91* *
92* RELEASE NOTES *
93* *
94*******************************************************
95
9ddee5ea
DO
96*** Upgrading to 0.14.12 ***
97
7fc5565c
DO
98The upgrade may show a failed query "alter database character set utf8", in
99this case the user should issue the query manually from the mysql command
100line.
9ddee5ea
DO
101
102*** Upgrading to 0.16.0 ***
103
104This release features a completely new authorization system, RackCode,
105which brings the tags feature (introduced in 0.15.0) to its full potential.
106The old-style user permissions are converted during upgrade automatically,
107but the result may appear not what you would expect. Review the RackCode
108after upgrade (Main page -> Configuration -> Permissions) and adjust,
109if necessary.
110
111Another important change is a new dependency on "multibyte string" PHP
112extension. Normally one should get it working before starting the upgrade,
113this is typically achieved by installing a particular PHP RPM from the
114standard package repository (and restarting Apache after that):
115
116Fedora: yum install php-mbstring
117ALTLinux: apt-get install php5-mbstring
8608b285 118
4d69ff46
DO
119*** Upgrading to 0.16.3 ***
120
121This release fixes a missing UNIQUE KEY in a table. The upgrade script may
122find it necessary first to transform some records. Because of this it is
123normal to see several "update TagStorage ... Duplicate entry" failed queries
124during the upgrade.
30d0a2a3
DO
125
126*** Upgrading to 0.17.0 ***
127
d74ae24c
DO
128One can always install RackTables 0.17.0 from scratch. However, upgrading
129an existing installation to 0.17.0 implies a certain upgrade path. If the
130existing database version is less, than 0.16.4, it must first be upgraded
131to version 0.16.4, 0.16.5 or 0.16.6 (at one's choice) using appropriate
132tar.gz distribution. The resulting 0.16.4+ database can be upgraded to
1330.17.0 (or later version) in a normal way (with tar.gz of the desired 0.17.x
134release).
135
2c9fde3a
DO
136LDAP options have been moved to LDAP_options array. This means, that if you were
137using LDAP authentication for users in version 0.16.x, it will break right after
aca5a846 138upgrade to 0.17.0. To get things working again, adjust existing secret.php file
2c9fde3a
DO
139according to secret-sample.php file provided with 0.17.0 release.
140
3e1c9c67
DO
141This release is the first to take advantage of the foreign key support
142provided by the InnoDB storage engine in MySQL. The installer and
e1ae3fb4
AD
143upgrader scripts check for InnoDB support and cannot complete without it.
144If you have trouble, the first step is to make sure the 'skip-innodb'
145option in my.cnf is commented out.
146
147Another change is the addition of support for file uploads. Files are stored
148in the database. There are several settings in php.ini which you may need to modify:
149 file_uploads - needs to be On
150 upload_max_filesize - max size for uploaded files
3e1c9c67
DO
151 post_max_size - max size of all form data submitted via POST (including files)
152
79b8ad1e 153User accounts used to have 'enabled' flag, which allowed individual blocking and
a476909e
DO
154unblocking of each. This flag was dropped in favor of existing mean of access
155setup (RackCode). An unconditional denying rule is automatically added into RackCode
156for such blocked account, so the effective security policy remains the same.