r4650 print_message_line(): new helper function to format messages in an uniform way
[racktables] / README
CommitLineData
fedf925b
DO
1Thank you for selecting RackTables as your datacenter management solution!
2If you are looking for documentation or wish to send feedback, please
3look for the respective links at project's web-site (racktables.org).
de8695b2
DO
4
5*******************************************************
6* *
7* INSTALLING RACKTABLES *
8* *
9*******************************************************
10
fedf925b 11*** I. SERVER ***
de8695b2 12
fedf925b
DO
13RackTables requires a MySQL server version 5.x built with InnoDB and
14Unicode support and configured appropriately. It also requires an Apache
15httpd with PHP 5 module and several PHP extensions. Below is a list of
16know-good distributions with respective setup notes.
3ebdbeed 17
fedf925b
DO
18*** Fedora 14
19* MySQL: yum install mysql-server mysql
20* Apache/PHP: yum install httpd php php-mysql php-pdo php-gd php-snmp php-mbstring
21* To enable Unicode, add "character-set-server=utf8" line to "[mysqld]"
22section of "/etc/my.cnf" file and restart mysqld.
3ebdbeed 23
fedf925b
DO
24*** ALTLinux 4.0
25* MySQL: apt-get install MySQL-server
26* Apache/PHP: apt-get install apache2-httpd-prefork php5-gd2 \
9ddee5ea 27php5-pdo_mysql php5-pdo apache2-mod_php5 php5-mbstring
fedf925b
DO
28* To enable Unicode, add "CHSET=utf8" line to "/etc/sysconfig/mysqld" file
29and restart mysqld.
30
31*** openSUSE 11.0
32* MySQL: YaST -> Software -> software management -> Web and LAMP server -> mysql
33* Apache/PHP: use YaST to install apache2-mod_php5, php5-gd, php5-mbstring,
34php5-mysql, php5-snmp and php5-ldap
35* To enable Unicode, add "default-character-set=utf8" line to "[mysql]"
36section of "/etc/my.cnf" file and restart mysqld.
37
38*** FreeBSD 8
39* Apache/PHP:
a3bce64d
DO
40# make -C /usr/ports/www/apache13-modssl install
41# make -C /usr/ports/www/php5-session install
42[X] CLI Build CLI version
43[X] APACHE Build Apache module
44[X] MULTIBYTE Enable zend multibyte support
45# make -C /usr/ports/graphics/php5-gd install
46# make -C /usr/ports/databases/php5-pdo_mysql install
c20f01f4
DO
47# make -C /usr/ports/devel/pcre install
48!!! Enable UTF-8 support ............ : yes
49!!! Unicode properties .............. : yes
a3bce64d
DO
50# make -C /usr/ports/devel/php5-pcre install
51# make -C /usr/ports/converters/php5-mbstring install
52[X] REGEX Enable multibyte regex support
53
54# make -C /usr/ports/net-mgmt/php5-snmp install
55# make -C /usr/ports/net/php5-ldap install
d3372430 56
fedf925b
DO
57*** II. FILES ***
58Place the contents of "wwwroot" directory into desired directory on the
59web-server. Update Apache httpd configuration as necessary.
c2d46542 60
fedf925b
DO
61*** III. INSTALLER ***
62Open your configured RackTables URL and you will be prompted to configure
63and initialize the application.
c2d46542 64
de8695b2
DO
65*******************************************************
66* *
67* UPGRADING RACKTABLES *
68* *
69*******************************************************
d3372430
DO
70RackTables (since 0.14.6) provides an automatic database upgrade feature.
71If you already have a working installation, the following procedure
72should be sufficient:
de8695b2 73
fedf925b
DO
740. BACKUP YOUR DATABASE and check the release notes (below) before actually
75 starting the upgrade,.
80138748
DO
761. Remove all existing files except inc/secret.php, gateways'
77 configuration (in the gateways directory) and local mod (inc/local.php).
de8695b2 782. Unpack the new tarball into the place.
fedf925b 793. Open your RackTables page in a browser. The software detects version
d3372430
DO
80 mismatch and displays a message telling to log in as admin to finish
81 the upgrade.
824. Do that. Normally, everything should be Ok. If there are
fedf925b 83 errors displayed, send these in a bug report.
7fc5565c 84
c2d46542
DO
85*******************************************************
86* *
87* RELEASE NOTES *
88* *
89*******************************************************
90
9b8174d7
AD
91*** Upgrading to 0.20.0 ***
92
93Racks and Rows are now stored in the database as Objects. The RackObject table
94was renamed to Object. SQL views were created to ease the migration of custom
95reports and scripts.
96
36efe434
DO
97*** Upgrading to 0.19.2 ***
98
99This release is different in filesystem layout. The "gateways" directory
4f5aea8a
AA
100has been moved from "wwwroot" directory. This improves security a bit.
101You can also separate your local settings and add-ons from the core RackTables code.
102To do that, put a single index.php file into the DocumentRoot of your http server:
103
104<?php
105$racktables_confdir='/directory/where/your/secret.php/and/local.php/files/are/stored';
106require '/directory_where_you_extracted_racktables_distro/wwwroot/index.php';
107?>
108
109No more files are needed to be available directly over the HTTP.
110Full list of filesystem paths which could be specified in custom index.php or secret.php:
111 $racktables_gwdir: path to the gateways directory;
112 $racktables_staticdir: path to the directory containing 'pix', 'js', 'css' dirs;
113 $racktables_confdir: path where secret.php and local.php are located. It is not
114 recommended to define it in secret.php, cause only the path to
115 local.php will be affected;
116 $path_to_secret_php: Ignore $racktables_confdir when locating secret.php and use
117 the specified path;
118 $path_to_local_php: idem for local.php.
36efe434 119
841a5b54 120*** Upgrading to 0.19.0 ***
6f542dde 121
841a5b54
DO
122The files, which are intended for the httpd (web-server) directory, are
123now in the "wwwroot" directory of the tar.gz archive. Files outside of
124that directory are not directly intended for httpd environment and should
125not be copied to the server.
65e557dd 126
8489d2af
DO
127This release incorporates ObjectLog functionality, which used to be
128available as a separate plugin. For the best results it is advised to
129disable (through local.php) external ObjectLog plugin permanently before
130the new version is installed. All previously accumulated ObjectLog records
131will be available through the updated standard interface.
132
841a5b54
DO
133RackTables is now using PHP JSON extension which is included in the PHP
134core since 5.2.0.
135
136The barcode attribute was removed. The upgrade script attempts to
137preserve the data by moving it to either the 'OEM S/N 1' attribute or to
138a Log entry. You should backup your database beforehand anyway.
81659c05 139
1679ddbd
DO
140*** Upgrading to 0.18.x ***
141
142RackTables from its version 0.18.0 and later is not compatible with
143RHEL/CentOS (at least with versions up to 5.5) Linux distributions
144in their default installation. There are yet options to work around that:
1451. Install RackTables on a server with a different distribution/OS.
1462. Request Linux distribution vendor to fix the bug with PCRE.
1473. Repair your RHEL/CentOS installation yourself by fixing its PCRE
148RPM as explained here: http://bugs.centos.org/view.php?id=3252
30d0a2a3
DO
149
150*** Upgrading to 0.17.0 ***
151
d74ae24c
DO
152One can always install RackTables 0.17.0 from scratch. However, upgrading
153an existing installation to 0.17.0 implies a certain upgrade path. If the
154existing database version is less, than 0.16.4, it must first be upgraded
155to version 0.16.4, 0.16.5 or 0.16.6 (at one's choice) using appropriate
156tar.gz distribution. The resulting 0.16.4+ database can be upgraded to
1570.17.0 (or later version) in a normal way (with tar.gz of the desired 0.17.x
158release).
159
2c9fde3a
DO
160LDAP options have been moved to LDAP_options array. This means, that if you were
161using LDAP authentication for users in version 0.16.x, it will break right after
aca5a846 162upgrade to 0.17.0. To get things working again, adjust existing secret.php file
2c9fde3a
DO
163according to secret-sample.php file provided with 0.17.0 release.
164
3e1c9c67
DO
165This release is the first to take advantage of the foreign key support
166provided by the InnoDB storage engine in MySQL. The installer and
e1ae3fb4
AD
167upgrader scripts check for InnoDB support and cannot complete without it.
168If you have trouble, the first step is to make sure the 'skip-innodb'
169option in my.cnf is commented out.
170
171Another change is the addition of support for file uploads. Files are stored
172in the database. There are several settings in php.ini which you may need to modify:
173 file_uploads - needs to be On
174 upload_max_filesize - max size for uploaded files
3e1c9c67
DO
175 post_max_size - max size of all form data submitted via POST (including files)
176
79b8ad1e 177User accounts used to have 'enabled' flag, which allowed individual blocking and
a476909e
DO
178unblocking of each. This flag was dropped in favor of existing mean of access
179setup (RackCode). An unconditional denying rule is automatically added into RackCode
180for such blocked account, so the effective security policy remains the same.