802.1q -> 802.1Q
[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,.
dd14756b
AA
881. Remove all existing files except inc/secret.php and the gateways'
89 configuration (in the gateways directory).
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
dd14756b
AA
109New plugins engine instead of local.php file. To make your own code stored in local.php work,
110you must move the local.php file into the plugins/ directory. The name of this file does not
111matter any more. You also can store multiple files in that dir, separate your plugins by features,
112share them and try the plugins from other people just placing them into plugins/ dir, no more merging.
113$path_to_local_php variable has no special meaning any more.
114$racktables_confdir variable is now used only to search for secret.php file.
115$racktables_plugins_dir is a new overridable special variable pointing to plugins/ directory.
116
7ec03062
AA
117Beginning with this version it is possible to delete IP networks and VLANs from within
118theirs properties tab. So please inspect your permissions rules to assure there are no
119undesired allows for deletion of these objects.
120
86ff26ae
DO
121*** Upgrading to 0.19.13 ***
122A new "date" attribute type has been added. Existing date based fields
123("HW warranty expiration", "support contract expiration" and "SW warranty
124expiration") will be converted to this new type but must be in the format
125"mm/dd/yyyy" otherwise the conversion will fail.
126
36efe434
DO
127*** Upgrading to 0.19.2 ***
128
129This release is different in filesystem layout. The "gateways" directory
4f5aea8a
AA
130has been moved from "wwwroot" directory. This improves security a bit.
131You can also separate your local settings and add-ons from the core RackTables code.
132To do that, put a single index.php file into the DocumentRoot of your http server:
133
134<?php
135$racktables_confdir='/directory/where/your/secret.php/and/local.php/files/are/stored';
136require '/directory_where_you_extracted_racktables_distro/wwwroot/index.php';
137?>
138
139No more files are needed to be available directly over the HTTP.
140Full list of filesystem paths which could be specified in custom index.php or secret.php:
141 $racktables_gwdir: path to the gateways directory;
142 $racktables_staticdir: path to the directory containing 'pix', 'js', 'css' dirs;
143 $racktables_confdir: path where secret.php and local.php are located. It is not
144 recommended to define it in secret.php, cause only the path to
145 local.php will be affected;
146 $path_to_secret_php: Ignore $racktables_confdir when locating secret.php and use
147 the specified path;
148 $path_to_local_php: idem for local.php.
36efe434 149
841a5b54 150*** Upgrading to 0.19.0 ***
6f542dde 151
841a5b54
DO
152The files, which are intended for the httpd (web-server) directory, are
153now in the "wwwroot" directory of the tar.gz archive. Files outside of
154that directory are not directly intended for httpd environment and should
155not be copied to the server.
65e557dd 156
8489d2af
DO
157This release incorporates ObjectLog functionality, which used to be
158available as a separate plugin. For the best results it is advised to
159disable (through local.php) external ObjectLog plugin permanently before
160the new version is installed. All previously accumulated ObjectLog records
161will be available through the updated standard interface.
162
841a5b54
DO
163RackTables is now using PHP JSON extension which is included in the PHP
164core since 5.2.0.
165
166The barcode attribute was removed. The upgrade script attempts to
167preserve the data by moving it to either the 'OEM S/N 1' attribute or to
168a Log entry. You should backup your database beforehand anyway.
81659c05 169
1679ddbd
DO
170*** Upgrading to 0.18.x ***
171
172RackTables from its version 0.18.0 and later is not compatible with
173RHEL/CentOS (at least with versions up to 5.5) Linux distributions
174in their default installation. There are yet options to work around that:
1751. Install RackTables on a server with a different distribution/OS.
1762. Request Linux distribution vendor to fix the bug with PCRE.
1773. Repair your RHEL/CentOS installation yourself by fixing its PCRE
178RPM as explained here: http://bugs.centos.org/view.php?id=3252
30d0a2a3
DO
179
180*** Upgrading to 0.17.0 ***
181
d74ae24c
DO
182One can always install RackTables 0.17.0 from scratch. However, upgrading
183an existing installation to 0.17.0 implies a certain upgrade path. If the
184existing database version is less, than 0.16.4, it must first be upgraded
185to version 0.16.4, 0.16.5 or 0.16.6 (at one's choice) using appropriate
186tar.gz distribution. The resulting 0.16.4+ database can be upgraded to
1870.17.0 (or later version) in a normal way (with tar.gz of the desired 0.17.x
188release).
189
2c9fde3a
DO
190LDAP options have been moved to LDAP_options array. This means, that if you were
191using LDAP authentication for users in version 0.16.x, it will break right after
aca5a846 192upgrade to 0.17.0. To get things working again, adjust existing secret.php file
2c9fde3a
DO
193according to secret-sample.php file provided with 0.17.0 release.
194
3e1c9c67
DO
195This release is the first to take advantage of the foreign key support
196provided by the InnoDB storage engine in MySQL. The installer and
e1ae3fb4
AD
197upgrader scripts check for InnoDB support and cannot complete without it.
198If you have trouble, the first step is to make sure the 'skip-innodb'
199option in my.cnf is commented out.
200
201Another change is the addition of support for file uploads. Files are stored
202in the database. There are several settings in php.ini which you may need to modify:
203 file_uploads - needs to be On
204 upload_max_filesize - max size for uploaded files
3e1c9c67
DO
205 post_max_size - max size of all form data submitted via POST (including files)
206
79b8ad1e 207User accounts used to have 'enabled' flag, which allowed individual blocking and
a476909e
DO
208unblocking of each. This flag was dropped in favor of existing mean of access
209setup (RackCode). An unconditional denying rule is automatically added into RackCode
210for such blocked account, so the effective security policy remains the same.