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