r2960 - maintenance->trunk sync of changeset:2953
[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.
e1ae3fb4 612. mysql> create database database_name; grant all privileges on database_name.* to XXX@YYY identified by 'ZZZ';
c2d46542
DO
62
63
d3372430 64III. Finish the installation.
c2d46542
DO
65Open your RackTables URL and follow the instructions. In a suitable
66environment everything should take a minute or so.
67
de8695b2
DO
68*******************************************************
69* *
70* UPGRADING RACKTABLES *
71* *
72*******************************************************
d3372430
DO
73RackTables (since 0.14.6) provides an automatic database upgrade feature.
74If you already have a working installation, the following procedure
75should be sufficient:
de8695b2
DO
76
770. BACKUP YOUR DATABASE
80138748
DO
781. Remove all existing files except inc/secret.php, gateways'
79 configuration (in the gateways directory) and local mod (inc/local.php).
de8695b2 802. Unpack the new tarball into the place.
d3372430
DO
813. Open the RackTables page in your browser. The software detects version
82 mismatch and displays a message telling to log in as admin to finish
83 the upgrade.
844. Do that. Normally, everything should be Ok. If there are
85 errors displayed, copy and send them to us for review.
7fc5565c 86
c2d46542
DO
87*******************************************************
88* *
89* RELEASE NOTES *
90* *
91*******************************************************
92
9ddee5ea
DO
93*** Upgrading to 0.14.12 ***
94
7fc5565c
DO
95The upgrade may show a failed query "alter database character set utf8", in
96this case the user should issue the query manually from the mysql command
97line.
9ddee5ea
DO
98
99*** Upgrading to 0.16.0 ***
100
101This release features a completely new authorization system, RackCode,
102which brings the tags feature (introduced in 0.15.0) to its full potential.
103The old-style user permissions are converted during upgrade automatically,
104but the result may appear not what you would expect. Review the RackCode
105after upgrade (Main page -> Configuration -> Permissions) and adjust,
106if necessary.
107
108Another important change is a new dependency on "multibyte string" PHP
109extension. Normally one should get it working before starting the upgrade,
110this is typically achieved by installing a particular PHP RPM from the
111standard package repository (and restarting Apache after that):
112
113Fedora: yum install php-mbstring
114ALTLinux: apt-get install php5-mbstring
8608b285 115
4d69ff46
DO
116*** Upgrading to 0.16.3 ***
117
118This release fixes a missing UNIQUE KEY in a table. The upgrade script may
119find it necessary first to transform some records. Because of this it is
120normal to see several "update TagStorage ... Duplicate entry" failed queries
121during the upgrade.
30d0a2a3
DO
122
123*** Upgrading to 0.17.0 ***
124
2c9fde3a
DO
125LDAP options have been moved to LDAP_options array. This means, that if you were
126using LDAP authentication for users in version 0.16.x, it will break right after
aca5a846 127upgrade to 0.17.0. To get things working again, adjust existing secret.php file
2c9fde3a
DO
128according to secret-sample.php file provided with 0.17.0 release.
129
3e1c9c67
DO
130This release is the first to take advantage of the foreign key support
131provided by the InnoDB storage engine in MySQL. The installer and
e1ae3fb4
AD
132upgrader scripts check for InnoDB support and cannot complete without it.
133If you have trouble, the first step is to make sure the 'skip-innodb'
134option in my.cnf is commented out.
135
136Another change is the addition of support for file uploads. Files are stored
137in the database. There are several settings in php.ini which you may need to modify:
138 file_uploads - needs to be On
139 upload_max_filesize - max size for uploaded files
3e1c9c67
DO
140 post_max_size - max size of all form data submitted via POST (including files)
141
79b8ad1e 142User accounts used to have 'enabled' flag, which allowed individual blocking and
a476909e
DO
143unblocking of each. This flag was dropped in favor of existing mean of access
144setup (RackCode). An unconditional denying rule is automatically added into RackCode
145for such blocked account, so the effective security policy remains the same.