459f76abdcfcdb364a10f8efc9f700e1514ffc78
[racktables] / README
1 Thank you for selecting RackTables as your datacenter management
2 solution. Feel free to address your questions to the mailing list
3 before contacting the authors directly. The project web-site
4 (http://racktables.org/) is usually kept up to date with the
5 current version and URLs.
6
7 Mailing list: <racktables-users/=@=/freelists.org>
8 Bug tracker and Wiki: http://racktables.org/trac
9 Authors: <info/=@=/racktables.org>
10
11 *******************************************************
12 * *
13 * INSTALLING RACKTABLES *
14 * *
15 *******************************************************
16
17 I. Install dependencies.
18
19 For database you must have a MySQL server installation
20 version 4.x or 5.x. InnoDB support must be enabled.
21 It is a good idea to make it use UTF-8 by default.
22
23 * Fedora 8/9: yum install mysql-server mysql
24 put "default-character-set=utf8" into /etc/my.cnf
25
26 * ALTLinux Desktop 4.0: apt-get install MySQL-server
27 put "CHSET=utf8" into /etc/sysconfig/mysqld
28
29 * openSUSE 11.0: YaST -> Software -> software management -> Web and LAMP server -> mysql
30 put "default-character-set=utf8" into /etc/my.cnf
31
32 For web-frontend you must have Apache and PHP 5 with PDO and multibyte
33 extensions:
34
35 * Fedora 8/9: yum install httpd php php-mysql php-pdo php-gd php-snmp php-mbstring
36
37 * ALTLinux Server 4.0: apt-get install apache2-httpd-prefork php5-gd2 \
38 php5-pdo_mysql php5-pdo apache2-mod_php5 php5-mbstring
39
40 * openSUSE 11.0: use YaST to apache2-mod_php5, php5-gd, php5-mbstring, php5-mysql,
41 php5-snmp and php5-ldap
42
43 * FreeBSD 7:
44 # make -C /usr/ports/www/apache13-modssl install
45 # make -C /usr/ports/www/php5-session install
46 [X] CLI Build CLI version
47 [X] APACHE Build Apache module
48 [X] MULTIBYTE Enable zend multibyte support
49 # make -C /usr/ports/graphics/php5-gd install
50 # make -C /usr/ports/databases/php5-pdo_mysql install
51 # make -C /usr/ports/devel/php5-pcre install
52 # make -C /usr/ports/converters/php5-mbstring install
53 [X] REGEX Enable multibyte regex support
54
55 # make -C /usr/ports/net-mgmt/php5-snmp install
56 # make -C /usr/ports/net/php5-ldap install
57
58 II. Prepare the files and database.
59 1. Unpack the tarball and make it web-accessible, e.g. http://yourcompany.com/racktables
60 or http://racktables.mysite.org.
61 2. mysql> create database database_name; grant all privileges on database_name.* to XXX@YYY identified by 'ZZZ';
62
63
64 III. Finish the installation.
65 Open your RackTables URL and follow the instructions. In a suitable
66 environment everything should take a minute or so.
67
68 *******************************************************
69 * *
70 * UPGRADING RACKTABLES *
71 * *
72 *******************************************************
73 RackTables (since 0.14.6) provides an automatic database upgrade feature.
74 If you already have a working installation, the following procedure
75 should be sufficient:
76
77 0. BACKUP YOUR DATABASE
78 1. Remove all existing files except inc/secret.php, gateways'
79 configuration (in the gateways directory) and local mod (inc/local.php).
80 2. Unpack the new tarball into the place.
81 3. Open the RackTables page in your browser. The software detects version
82 mismatch and displays a message telling to log in as admin to finish
83 the upgrade.
84 4. Do that. Normally, everything should be Ok. If there are
85 errors displayed, copy and send them to us for review.
86
87 *******************************************************
88 * *
89 * RELEASE NOTES *
90 * *
91 *******************************************************
92
93 *** Upgrading to 0.14.12 ***
94
95 The upgrade may show a failed query "alter database character set utf8", in
96 this case the user should issue the query manually from the mysql command
97 line.
98
99 *** Upgrading to 0.16.0 ***
100
101 This release features a completely new authorization system, RackCode,
102 which brings the tags feature (introduced in 0.15.0) to its full potential.
103 The old-style user permissions are converted during upgrade automatically,
104 but the result may appear not what you would expect. Review the RackCode
105 after upgrade (Main page -> Configuration -> Permissions) and adjust,
106 if necessary.
107
108 Another important change is a new dependency on "multibyte string" PHP
109 extension. Normally one should get it working before starting the upgrade,
110 this is typically achieved by installing a particular PHP RPM from the
111 standard package repository (and restarting Apache after that):
112
113 Fedora: yum install php-mbstring
114 ALTLinux: apt-get install php5-mbstring
115
116 *** Upgrading to 0.16.3 ***
117
118 This release fixes a missing UNIQUE KEY in a table. The upgrade script may
119 find it necessary first to transform some records. Because of this it is
120 normal to see several "update TagStorage ... Duplicate entry" failed queries
121 during the upgrade.
122
123 *** Upgrading to 0.17.0 ***
124
125 LDAP options have been moved to LDAP_options array. This means, that if you were
126 using LDAP authentication for users in version 0.16.x, it will break right after
127 upgrade to 0.17.0. To get things working again, adjust existing secret.php file
128 according to secret-sample.php file provided with 0.17.0 release.
129
130 This release is the first to take advantage of the foreign key support
131 provided by the InnoDB storage engine in MySQL. The installer and
132 upgrader scripts check for InnoDB support and cannot complete without it.
133 If you have trouble, the first step is to make sure the 'skip-innodb'
134 option in my.cnf is commented out.
135
136 Another change is the addition of support for file uploads. Files are stored
137 in the database. There are several settings in php.ini which you may need to modify:
138 file_uploads - needs to be On
139 upload_max_filesize - max size for uploaded files
140 post_max_size - max size of all form data submitted via POST (including files)
141
142 User accounts used to have 'enabled' flag, which allowed individual blocking and
143 unblocking of each. This flag was dropped in favor of existing mean of access
144 setup (RackCode). An unconditional denying rule is automatically added into RackCode
145 for such blocked account, so the effective security policy remains the same.