r4242 justified and cleaned up the text a bit
[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 *** ALTLinux 4.0
25 * MySQL: apt-get install MySQL-server
26 * Apache/PHP: apt-get install apache2-httpd-prefork php5-gd2 \
27 php5-pdo_mysql php5-pdo apache2-mod_php5 php5-mbstring
28 * To enable Unicode, add "CHSET=utf8" line to "/etc/sysconfig/mysqld" file
29 and 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,
34 php5-mysql, php5-snmp and php5-ldap
35 * To enable Unicode, add "default-character-set=utf8" line to "[mysql]"
36 section of "/etc/my.cnf" file and restart mysqld.
37
38 *** FreeBSD 8
39 * Apache/PHP:
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
47 # make -C /usr/ports/devel/pcre install
48 !!! Enable UTF-8 support ............ : yes
49 !!! Unicode properties .............. : yes
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
56
57 *** II. FILES ***
58 Place the contents of "wwwroot" directory into desired directory on the
59 web-server. Update Apache httpd configuration as necessary.
60
61 *** III. INSTALLER ***
62 Open your configured RackTables URL and you will be prompted to configure
63 and initialize the application.
64
65 *******************************************************
66 * *
67 * UPGRADING RACKTABLES *
68 * *
69 *******************************************************
70 RackTables (since 0.14.6) provides an automatic database upgrade feature.
71 If you already have a working installation, the following procedure
72 should be sufficient:
73
74 0. BACKUP YOUR DATABASE and check the release notes (below) before actually
75 starting the upgrade,.
76 1. Remove all existing files except inc/secret.php, gateways'
77 configuration (in the gateways directory) and local mod (inc/local.php).
78 2. Unpack the new tarball into the place.
79 3. Open your RackTables page in a browser. The software detects version
80 mismatch and displays a message telling to log in as admin to finish
81 the upgrade.
82 4. Do that. Normally, everything should be Ok. If there are
83 errors displayed, send these in a bug report.
84
85 *******************************************************
86 * *
87 * RELEASE NOTES *
88 * *
89 *******************************************************
90
91 *** Upgrading to 0.19.0 ***
92
93 The files, which are intended for the httpd (web-server) directory, are
94 now in the "wwwroot" directory of the tar.gz archive. Files outside of
95 that directory are not directly intended for httpd environment and should
96 not be copied to the server.
97
98 This release incorporates ObjectLog functionality, which used to be
99 available as a separate plugin. For the best results it is advised to
100 disable (through local.php) external ObjectLog plugin permanently before
101 the new version is installed. All previously accumulated ObjectLog records
102 will be available through the updated standard interface.
103
104 RackTables is now using PHP JSON extension which is included in the PHP
105 core since 5.2.0.
106
107 The barcode attribute was removed. The upgrade script attempts to
108 preserve the data by moving it to either the 'OEM S/N 1' attribute or to
109 a Log entry. You should backup your database beforehand anyway.
110
111 *** Upgrading to 0.18.x ***
112
113 RackTables from its version 0.18.0 and later is not compatible with
114 RHEL/CentOS (at least with versions up to 5.5) Linux distributions
115 in their default installation. There are yet options to work around that:
116 1. Install RackTables on a server with a different distribution/OS.
117 2. Request Linux distribution vendor to fix the bug with PCRE.
118 3. Repair your RHEL/CentOS installation yourself by fixing its PCRE
119 RPM as explained here: http://bugs.centos.org/view.php?id=3252
120
121 *** Upgrading to 0.17.0 ***
122
123 One can always install RackTables 0.17.0 from scratch. However, upgrading
124 an existing installation to 0.17.0 implies a certain upgrade path. If the
125 existing database version is less, than 0.16.4, it must first be upgraded
126 to version 0.16.4, 0.16.5 or 0.16.6 (at one's choice) using appropriate
127 tar.gz distribution. The resulting 0.16.4+ database can be upgraded to
128 0.17.0 (or later version) in a normal way (with tar.gz of the desired 0.17.x
129 release).
130
131 LDAP options have been moved to LDAP_options array. This means, that if you were
132 using LDAP authentication for users in version 0.16.x, it will break right after
133 upgrade to 0.17.0. To get things working again, adjust existing secret.php file
134 according to secret-sample.php file provided with 0.17.0 release.
135
136 This release is the first to take advantage of the foreign key support
137 provided by the InnoDB storage engine in MySQL. The installer and
138 upgrader scripts check for InnoDB support and cannot complete without it.
139 If you have trouble, the first step is to make sure the 'skip-innodb'
140 option in my.cnf is commented out.
141
142 Another change is the addition of support for file uploads. Files are stored
143 in the database. There are several settings in php.ini which you may need to modify:
144 file_uploads - needs to be On
145 upload_max_filesize - max size for uploaded files
146 post_max_size - max size of all form data submitted via POST (including files)
147
148 User accounts used to have 'enabled' flag, which allowed individual blocking and
149 unblocking of each. This flag was dropped in favor of existing mean of access
150 setup (RackCode). An unconditional denying rule is automatically added into RackCode
151 for such blocked account, so the effective security policy remains the same.