r4677 copy recent SNMP updates to trunk
[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
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
44*** FreeBSD 8
45* Apache/PHP:
a3bce64d
DO
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 62
fedf925b
DO
63*** II. FILES ***
64Place the contents of "wwwroot" directory into desired directory on the
65web-server. Update Apache httpd configuration as necessary.
c2d46542 66
fedf925b
DO
67*** III. INSTALLER ***
68Open your configured RackTables URL and you will be prompted to configure
69and initialize the application.
c2d46542 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 79
fedf925b
DO
800. BACKUP YOUR DATABASE and check the release notes (below) before actually
81 starting the upgrade,.
80138748
DO
821. Remove all existing files except inc/secret.php, gateways'
83 configuration (in the gateways directory) and local mod (inc/local.php).
de8695b2 842. Unpack the new tarball into the place.
fedf925b 853. Open your RackTables page in a browser. The software detects version
d3372430
DO
86 mismatch and displays a message telling to log in as admin to finish
87 the upgrade.
884. Do that. Normally, everything should be Ok. If there are
fedf925b 89 errors displayed, send these in a bug report.
7fc5565c 90
c2d46542
DO
91*******************************************************
92* *
93* RELEASE NOTES *
94* *
95*******************************************************
96
9b8174d7
AD
97*** Upgrading to 0.20.0 ***
98
99Racks and Rows are now stored in the database as Objects. The RackObject table
100was renamed to Object. SQL views were created to ease the migration of custom
101reports and scripts.
102
36efe434
DO
103*** Upgrading to 0.19.2 ***
104
105This release is different in filesystem layout. The "gateways" directory
4f5aea8a
AA
106has been moved from "wwwroot" directory. This improves security a bit.
107You can also separate your local settings and add-ons from the core RackTables code.
108To do that, put a single index.php file into the DocumentRoot of your http server:
109
110<?php
111$racktables_confdir='/directory/where/your/secret.php/and/local.php/files/are/stored';
112require '/directory_where_you_extracted_racktables_distro/wwwroot/index.php';
113?>
114
115No more files are needed to be available directly over the HTTP.
116Full list of filesystem paths which could be specified in custom index.php or secret.php:
117 $racktables_gwdir: path to the gateways directory;
118 $racktables_staticdir: path to the directory containing 'pix', 'js', 'css' dirs;
119 $racktables_confdir: path where secret.php and local.php are located. It is not
120 recommended to define it in secret.php, cause only the path to
121 local.php will be affected;
122 $path_to_secret_php: Ignore $racktables_confdir when locating secret.php and use
123 the specified path;
124 $path_to_local_php: idem for local.php.
36efe434 125
841a5b54 126*** Upgrading to 0.19.0 ***
6f542dde 127
841a5b54
DO
128The files, which are intended for the httpd (web-server) directory, are
129now in the "wwwroot" directory of the tar.gz archive. Files outside of
130that directory are not directly intended for httpd environment and should
131not be copied to the server.
65e557dd 132
8489d2af
DO
133This release incorporates ObjectLog functionality, which used to be
134available as a separate plugin. For the best results it is advised to
135disable (through local.php) external ObjectLog plugin permanently before
136the new version is installed. All previously accumulated ObjectLog records
137will be available through the updated standard interface.
138
841a5b54
DO
139RackTables is now using PHP JSON extension which is included in the PHP
140core since 5.2.0.
141
142The barcode attribute was removed. The upgrade script attempts to
143preserve the data by moving it to either the 'OEM S/N 1' attribute or to
144a Log entry. You should backup your database beforehand anyway.
81659c05 145
1679ddbd
DO
146*** Upgrading to 0.18.x ***
147
148RackTables from its version 0.18.0 and later is not compatible with
149RHEL/CentOS (at least with versions up to 5.5) Linux distributions
150in their default installation. There are yet options to work around that:
1511. Install RackTables on a server with a different distribution/OS.
1522. Request Linux distribution vendor to fix the bug with PCRE.
1533. Repair your RHEL/CentOS installation yourself by fixing its PCRE
154RPM as explained here: http://bugs.centos.org/view.php?id=3252
30d0a2a3
DO
155
156*** Upgrading to 0.17.0 ***
157
d74ae24c
DO
158One can always install RackTables 0.17.0 from scratch. However, upgrading
159an existing installation to 0.17.0 implies a certain upgrade path. If the
160existing database version is less, than 0.16.4, it must first be upgraded
161to version 0.16.4, 0.16.5 or 0.16.6 (at one's choice) using appropriate
162tar.gz distribution. The resulting 0.16.4+ database can be upgraded to
1630.17.0 (or later version) in a normal way (with tar.gz of the desired 0.17.x
164release).
165
2c9fde3a
DO
166LDAP options have been moved to LDAP_options array. This means, that if you were
167using LDAP authentication for users in version 0.16.x, it will break right after
aca5a846 168upgrade to 0.17.0. To get things working again, adjust existing secret.php file
2c9fde3a
DO
169according to secret-sample.php file provided with 0.17.0 release.
170
3e1c9c67
DO
171This release is the first to take advantage of the foreign key support
172provided by the InnoDB storage engine in MySQL. The installer and
e1ae3fb4
AD
173upgrader scripts check for InnoDB support and cannot complete without it.
174If you have trouble, the first step is to make sure the 'skip-innodb'
175option in my.cnf is commented out.
176
177Another change is the addition of support for file uploads. Files are stored
178in the database. There are several settings in php.ini which you may need to modify:
179 file_uploads - needs to be On
180 upload_max_filesize - max size for uploaded files
3e1c9c67
DO
181 post_max_size - max size of all form data submitted via POST (including files)
182
79b8ad1e 183User accounts used to have 'enabled' flag, which allowed individual blocking and
a476909e
DO
184unblocking of each. This flag was dropped in favor of existing mean of access
185setup (RackCode). An unconditional denying rule is automatically added into RackCode
186for such blocked account, so the effective security policy remains the same.