r4008 update committer list for year 2010
[racktables] / README
CommitLineData
de8695b2
DO
1Thank you for selecting RackTables as your datacenter management
2solution. Feel free to address your questions to the mailing list
ad592f37 3before contacting the developers directly.
de8695b2 4
ad592f37
DO
5Project homepage: http://racktables.org/
6Project SF page: http://sourceforge.net/projects/racktables/
7Documentation: http://sourceforge.net/apps/mediawiki/racktables/index.php?title=Main_Page
8Users mailing list: <racktables-users/=@=/freelists.org>
9Mailing list archive: http://www.freelists.org/archive/racktables-users
10Developers: <info/=@=/racktables.org>
de8695b2
DO
11
12*******************************************************
13* *
14* INSTALLING RACKTABLES *
15* *
16*******************************************************
17
d3372430 18I. Install dependencies.
de8695b2 19
3ebdbeed 20For database you must have a MySQL server installation
e1ae3fb4
AD
21version 4.x or 5.x. InnoDB support must be enabled.
22It is a good idea to make it use UTF-8 by default.
3ebdbeed
DO
23
24* Fedora 8/9: yum install mysql-server mysql
25put "default-character-set=utf8" into /etc/my.cnf
26
27* ALTLinux Desktop 4.0: apt-get install MySQL-server
28put "CHSET=utf8" into /etc/sysconfig/mysqld
29
3e1c9c67 30* openSUSE 11.0: YaST -> Software -> software management -> Web and LAMP server -> mysql
3ebdbeed 31put "default-character-set=utf8" into /etc/my.cnf
de8695b2 32
9ddee5ea
DO
33For web-frontend you must have Apache and PHP 5 with PDO and multibyte
34extensions:
3ebdbeed
DO
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 \
9ddee5ea 39php5-pdo_mysql php5-pdo apache2-mod_php5 php5-mbstring
c2d46542 40
3ebdbeed 41* openSUSE 11.0: use YaST to apache2-mod_php5, php5-gd, php5-mbstring, php5-mysql,
93bdb7ba 42php5-snmp and php5-ldap
3ebdbeed 43
a3bce64d
DO
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
c20f01f4
DO
52# make -C /usr/ports/devel/pcre install
53!!! Enable UTF-8 support ............ : yes
54!!! Unicode properties .............. : yes
a3bce64d
DO
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
d3372430
DO
61
62II. Prepare the files and database.
de8695b2
DO
631. Unpack the tarball and make it web-accessible, e.g. http://yourcompany.com/racktables
64or http://racktables.mysite.org.
1538b9c9
DO
65
662. Setup MySQL database:
67mysql> CREATE DATABASE racktables_db CHARACTER SET utf8 COLLATE utf8_general_ci;
68mysql> grant all privileges on racktables_db.* to XXX@YYY identified by 'ZZZ';
c2d46542
DO
69
70
d3372430 71III. Finish the installation.
c2d46542
DO
72Open your RackTables URL and follow the instructions. In a suitable
73environment everything should take a minute or so.
74
de8695b2
DO
75*******************************************************
76* *
77* UPGRADING RACKTABLES *
78* *
79*******************************************************
d3372430
DO
80RackTables (since 0.14.6) provides an automatic database upgrade feature.
81If you already have a working installation, the following procedure
82should be sufficient:
de8695b2
DO
83
840. BACKUP YOUR DATABASE
80138748
DO
851. Remove all existing files except inc/secret.php, gateways'
86 configuration (in the gateways directory) and local mod (inc/local.php).
de8695b2 872. Unpack the new tarball into the place.
d3372430
DO
883. 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.
914. Do that. Normally, everything should be Ok. If there are
92 errors displayed, copy and send them to us for review.
7fc5565c 93
c2d46542
DO
94*******************************************************
95* *
96* RELEASE NOTES *
97* *
98*******************************************************
99
1679ddbd
DO
100*** Upgrading to 0.18.x ***
101
102RackTables from its version 0.18.0 and later is not compatible with
103RHEL/CentOS (at least with versions up to 5.5) Linux distributions
104in their default installation. There are yet options to work around that:
1051. Install RackTables on a server with a different distribution/OS.
1062. Request Linux distribution vendor to fix the bug with PCRE.
1073. Repair your RHEL/CentOS installation yourself by fixing its PCRE
108RPM as explained here: http://bugs.centos.org/view.php?id=3252
30d0a2a3
DO
109
110*** Upgrading to 0.17.0 ***
111
d74ae24c
DO
112One can always install RackTables 0.17.0 from scratch. However, upgrading
113an existing installation to 0.17.0 implies a certain upgrade path. If the
114existing database version is less, than 0.16.4, it must first be upgraded
115to version 0.16.4, 0.16.5 or 0.16.6 (at one's choice) using appropriate
116tar.gz distribution. The resulting 0.16.4+ database can be upgraded to
1170.17.0 (or later version) in a normal way (with tar.gz of the desired 0.17.x
118release).
119
2c9fde3a
DO
120LDAP options have been moved to LDAP_options array. This means, that if you were
121using LDAP authentication for users in version 0.16.x, it will break right after
aca5a846 122upgrade to 0.17.0. To get things working again, adjust existing secret.php file
2c9fde3a
DO
123according to secret-sample.php file provided with 0.17.0 release.
124
3e1c9c67
DO
125This release is the first to take advantage of the foreign key support
126provided by the InnoDB storage engine in MySQL. The installer and
e1ae3fb4
AD
127upgrader scripts check for InnoDB support and cannot complete without it.
128If you have trouble, the first step is to make sure the 'skip-innodb'
129option in my.cnf is commented out.
130
131Another change is the addition of support for file uploads. Files are stored
132in the database. There are several settings in php.ini which you may need to modify:
133 file_uploads - needs to be On
134 upload_max_filesize - max size for uploaded files
3e1c9c67
DO
135 post_max_size - max size of all form data submitted via POST (including files)
136
79b8ad1e 137User accounts used to have 'enabled' flag, which allowed individual blocking and
a476909e
DO
138unblocking of each. This flag was dropped in favor of existing mean of access
139setup (RackCode). An unconditional denying rule is automatically added into RackCode
140for such blocked account, so the effective security policy remains the same.