r4178 bugfix: PHP warnings were appearing before rackspace on SLB object page, defaul...
[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
ad592f37 3before contacting the developers directly.
de8695b2 4
ad592f37
DO
5Project homepage: http://racktables.org/
6Project SF page: http://sourceforge.net/projects/racktables/
7Documentation: http://sourceforge.net/apps/mediawiki/racktables/index.php?title=Main_Page
8Users mailing list: <racktables-users/=@=/freelists.org>
9Mailing list archive: http://www.freelists.org/archive/racktables-users
10Developers: <info/=@=/racktables.org>
de8695b2
DO
11
12*******************************************************
13* *
14* INSTALLING RACKTABLES *
15* *
16*******************************************************
17
d3372430 18I. Install dependencies.
de8695b2 19
3ebdbeed 20For database you must have a MySQL server installation
e1ae3fb4
AD
21version 4.x or 5.x. InnoDB support must be enabled.
22It is a good idea to make it use UTF-8 by default.
3ebdbeed 23
73d5a04a
DO
24* Fedora 13: yum install mysql-server mysql
25Make sure to have "character-set-server=utf8" line in "[mysqld]" section
26of /etc/my.cnf file!
3ebdbeed
DO
27
28* ALTLinux Desktop 4.0: apt-get install MySQL-server
29put "CHSET=utf8" into /etc/sysconfig/mysqld
30
3e1c9c67 31* openSUSE 11.0: YaST -> Software -> software management -> Web and LAMP server -> mysql
3ebdbeed 32put "default-character-set=utf8" into /etc/my.cnf
de8695b2 33
9ddee5ea
DO
34For web-frontend you must have Apache and PHP 5 with PDO and multibyte
35extensions:
3ebdbeed 36
73d5a04a 37* Fedora 13: yum install httpd php php-mysql php-pdo php-gd php-snmp php-mbstring
3ebdbeed
DO
38
39* ALTLinux Server 4.0: apt-get install apache2-httpd-prefork php5-gd2 \
9ddee5ea 40php5-pdo_mysql php5-pdo apache2-mod_php5 php5-mbstring
c2d46542 41
3ebdbeed 42* openSUSE 11.0: use YaST to apache2-mod_php5, php5-gd, php5-mbstring, php5-mysql,
93bdb7ba 43php5-snmp and php5-ldap
3ebdbeed 44
a3bce64d
DO
45* FreeBSD 7:
46# make -C /usr/ports/www/apache13-modssl install
47# make -C /usr/ports/www/php5-session install
48[X] CLI Build CLI version
49[X] APACHE Build Apache module
50[X] MULTIBYTE Enable zend multibyte support
51# make -C /usr/ports/graphics/php5-gd install
52# make -C /usr/ports/databases/php5-pdo_mysql install
c20f01f4
DO
53# make -C /usr/ports/devel/pcre install
54!!! Enable UTF-8 support ............ : yes
55!!! Unicode properties .............. : yes
a3bce64d
DO
56# make -C /usr/ports/devel/php5-pcre install
57# make -C /usr/ports/converters/php5-mbstring install
58[X] REGEX Enable multibyte regex support
59
60# make -C /usr/ports/net-mgmt/php5-snmp install
61# make -C /usr/ports/net/php5-ldap install
d3372430
DO
62
63II. Prepare the files and database.
de8695b2
DO
641. Unpack the tarball and make it web-accessible, e.g. http://yourcompany.com/racktables
65or http://racktables.mysite.org.
1538b9c9
DO
66
672. Setup MySQL database:
68mysql> CREATE DATABASE racktables_db CHARACTER SET utf8 COLLATE utf8_general_ci;
69mysql> grant all privileges on racktables_db.* to XXX@YYY identified by 'ZZZ';
c2d46542
DO
70
71
d3372430 72III. Finish the installation.
c2d46542
DO
73Open your RackTables URL and follow the instructions. In a suitable
74environment everything should take a minute or so.
75
de8695b2
DO
76*******************************************************
77* *
78* UPGRADING RACKTABLES *
79* *
80*******************************************************
d3372430
DO
81RackTables (since 0.14.6) provides an automatic database upgrade feature.
82If you already have a working installation, the following procedure
83should be sufficient:
de8695b2
DO
84
850. BACKUP YOUR DATABASE
80138748
DO
861. Remove all existing files except inc/secret.php, gateways'
87 configuration (in the gateways directory) and local mod (inc/local.php).
de8695b2 882. Unpack the new tarball into the place.
d3372430
DO
893. Open the RackTables page in your browser. The software detects version
90 mismatch and displays a message telling to log in as admin to finish
91 the upgrade.
924. Do that. Normally, everything should be Ok. If there are
93 errors displayed, copy and send them to us for review.
7fc5565c 94
c2d46542
DO
95*******************************************************
96* *
97* RELEASE NOTES *
98* *
99*******************************************************
100
6f542dde
AD
101*** Upgrading to 0.19.x ***
102
65e557dd
AA
103RackTables is now using PHP JSON extension which is included in the PHP core since 5.2.0.
104Installation process does not check for this extension because the lack of it does not affect
105base functionality. If some of ajax features are not working correctly, check if JSON extension
106is availible in your installation of PHP.
107
1679ddbd
DO
108*** Upgrading to 0.18.x ***
109
110RackTables from its version 0.18.0 and later is not compatible with
111RHEL/CentOS (at least with versions up to 5.5) Linux distributions
112in their default installation. There are yet options to work around that:
1131. Install RackTables on a server with a different distribution/OS.
1142. Request Linux distribution vendor to fix the bug with PCRE.
1153. Repair your RHEL/CentOS installation yourself by fixing its PCRE
116RPM as explained here: http://bugs.centos.org/view.php?id=3252
30d0a2a3
DO
117
118*** Upgrading to 0.17.0 ***
119
d74ae24c
DO
120One can always install RackTables 0.17.0 from scratch. However, upgrading
121an existing installation to 0.17.0 implies a certain upgrade path. If the
122existing database version is less, than 0.16.4, it must first be upgraded
123to version 0.16.4, 0.16.5 or 0.16.6 (at one's choice) using appropriate
124tar.gz distribution. The resulting 0.16.4+ database can be upgraded to
1250.17.0 (or later version) in a normal way (with tar.gz of the desired 0.17.x
126release).
127
2c9fde3a
DO
128LDAP options have been moved to LDAP_options array. This means, that if you were
129using LDAP authentication for users in version 0.16.x, it will break right after
aca5a846 130upgrade to 0.17.0. To get things working again, adjust existing secret.php file
2c9fde3a
DO
131according to secret-sample.php file provided with 0.17.0 release.
132
3e1c9c67
DO
133This release is the first to take advantage of the foreign key support
134provided by the InnoDB storage engine in MySQL. The installer and
e1ae3fb4
AD
135upgrader scripts check for InnoDB support and cannot complete without it.
136If you have trouble, the first step is to make sure the 'skip-innodb'
137option in my.cnf is commented out.
138
139Another change is the addition of support for file uploads. Files are stored
140in the database. There are several settings in php.ini which you may need to modify:
141 file_uploads - needs to be On
142 upload_max_filesize - max size for uploaded files
3e1c9c67
DO
143 post_max_size - max size of all form data submitted via POST (including files)
144
79b8ad1e 145User accounts used to have 'enabled' flag, which allowed individual blocking and
a476909e
DO
146unblocking of each. This flag was dropped in favor of existing mean of access
147setup (RackCode). An unconditional denying rule is automatically added into RackCode
148for such blocked account, so the effective security policy remains the same.