r2086 + display tags inline for virtual service and RS pool lists
[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
3before contacting the authors directly. The project web-site
4(http://racktables.org/) is usually kept up to date with the
2dfc597c 5current version and URLs.
de8695b2
DO
6
7Mailing list: <racktables-users/=@=/freelists.org>
2dfc597c 8Bug tracker and Wiki: http://racktables.org/trac
de8695b2
DO
9Authors: <info/=@=/racktables.org>
10
11*******************************************************
12* *
13* INSTALLING RACKTABLES *
14* *
15*******************************************************
16
17I. Dependencies.
18
19For database you must have a MySQL server installation version 4.x or 5.x:
20Fedora Core 6: yum install mysql-server mysql
21Fedora 8: yum install mysql-server mysql
22ALTLinux Compact 3.0: apt-get install MySQL-server MySQL-client
23ALTLinux Desktop 4.0: apt-get install MySQL-server
24
9ddee5ea
DO
25For web-frontend you must have Apache and PHP 5 with PDO and multibyte
26extensions:
de8695b2 27Fedora Core 6: # yum install httpd php php-mysql php-pdo php-gd
e6412f6e 28Fedora 8: yum install httpd php php-mysql php-pdo php-gd php-snmp php-mbstring
9ddee5ea
DO
29ALTLinux Server 4.0: apt-get install apache2-httpd-prefork php5-gd2 \
30php5-pdo_mysql php5-pdo apache2-mod_php5 php5-mbstring
c2d46542
DO
31
32II. Prepare the server.
de8695b2
DO
331. Unpack the tarball and make it web-accessible, e.g. http://yourcompany.com/racktables
34or http://racktables.mysite.org.
c2d46542
DO
352. mysql> create database_name; grant all privileges on database_name.* to XXX@YYY identified by 'ZZZ';
36
37
38There are two mutually exclusive ways to install RackTables, they are described as III-A and III-B.
39
40
41III-A. HTTP installation (starting with 0.14.12 release)
42Open your RackTables URL and follow the instructions. In a suitable
43environment everything should take a minute or so.
44
de8695b2 45
c2d46542
DO
46III-B. Manual installation.
471. Edit install/init-auth.sql and change admin password
48
492. Init database.
de8695b2
DO
50mysql> use database_name;
51mysql> source install/init-structure.sql
52mysql> source install/init-auth.sql
53$ rm -f install/init-auth.sql
54mysql> source install/init-dictbase.sql
55mysql> source install/init-dictvendors.sql
de8695b2 56
c2d46542 573. Edit inc/secret.php
de8695b2 58
c2d46542 594. $ rm -f install/init-auth.sql
de8695b2
DO
60(Just to be sure you did.)
61
62*******************************************************
63* *
64* UPGRADING RACKTABLES *
65* *
66*******************************************************
67RackTables now provides an automatic database upgrade feature.
68If you already have a working installation, the following
69procedure should be sufficient:
70
710. BACKUP YOUR DATABASE
721. Remove all existing files except inc/secret.php and gateways'
73 configuration (in the gateways directory).
742. Unpack the new tarball into the place.
753. Open the RackTables page in your browser.
764. Follow instructions. Normally, everything should be Ok. If it
77 is not so, write down the failed quieries for further investigation.
7fc5565c 78
c2d46542
DO
79*******************************************************
80* *
81* RELEASE NOTES *
82* *
83*******************************************************
84
9ddee5ea
DO
85*** Upgrading to 0.14.12 ***
86
7fc5565c
DO
87The upgrade may show a failed query "alter database character set utf8", in
88this case the user should issue the query manually from the mysql command
89line.
9ddee5ea
DO
90
91*** Upgrading to 0.16.0 ***
92
93This release features a completely new authorization system, RackCode,
94which brings the tags feature (introduced in 0.15.0) to its full potential.
95The old-style user permissions are converted during upgrade automatically,
96but the result may appear not what you would expect. Review the RackCode
97after upgrade (Main page -> Configuration -> Permissions) and adjust,
98if necessary.
99
100Another important change is a new dependency on "multibyte string" PHP
101extension. Normally one should get it working before starting the upgrade,
102this is typically achieved by installing a particular PHP RPM from the
103standard package repository (and restarting Apache after that):
104
105Fedora: yum install php-mbstring
106ALTLinux: apt-get install php5-mbstring