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