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