r2326 - add a code for "shared" address to fix "undefined index" warning
[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
3ebdbeed 19For database you must have a MySQL server installation
e1ae3fb4
AD
20version 4.x or 5.x. InnoDB support must be enabled.
21It is a good idea to make it use UTF-8 by default.
3ebdbeed
DO
22
23* Fedora 8/9: yum install mysql-server mysql
24put "default-character-set=utf8" into /etc/my.cnf
25
26* ALTLinux Desktop 4.0: apt-get install MySQL-server
27put "CHSET=utf8" into /etc/sysconfig/mysqld
28
29*openSUSE 11.0: YaST -> Software -> software management -> Web and LAMP server -> mysql
30put "default-character-set=utf8" into /etc/my.cnf
de8695b2 31
9ddee5ea
DO
32For web-frontend you must have Apache and PHP 5 with PDO and multibyte
33extensions:
3ebdbeed
DO
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 \
9ddee5ea 38php5-pdo_mysql php5-pdo apache2-mod_php5 php5-mbstring
c2d46542 39
3ebdbeed
DO
40* openSUSE 11.0: use YaST to apache2-mod_php5, php5-gd, php5-mbstring, php5-mysql,
41php2-snmp and php5-ldap
42
c2d46542 43II. Prepare the server.
de8695b2
DO
441. Unpack the tarball and make it web-accessible, e.g. http://yourcompany.com/racktables
45or http://racktables.mysite.org.
e1ae3fb4 462. mysql> create database database_name; grant all privileges on database_name.* to XXX@YYY identified by 'ZZZ';
c2d46542
DO
47
48
49There are two mutually exclusive ways to install RackTables, they are described as III-A and III-B.
50
51
52III-A. HTTP installation (starting with 0.14.12 release)
53Open your RackTables URL and follow the instructions. In a suitable
54environment everything should take a minute or so.
55
de8695b2 56
c2d46542
DO
57III-B. Manual installation.
581. Edit install/init-auth.sql and change admin password
59
602. Init database.
de8695b2
DO
61mysql> use database_name;
62mysql> source install/init-structure.sql
63mysql> source install/init-auth.sql
64$ rm -f install/init-auth.sql
65mysql> source install/init-dictbase.sql
66mysql> source install/init-dictvendors.sql
de8695b2 67
c2d46542 683. Edit inc/secret.php
de8695b2 69
c2d46542 704. $ rm -f install/init-auth.sql
de8695b2
DO
71(Just to be sure you did.)
72
73*******************************************************
74* *
75* UPGRADING RACKTABLES *
76* *
77*******************************************************
78RackTables now provides an automatic database upgrade feature.
79If you already have a working installation, the following
80procedure should be sufficient:
81
820. BACKUP YOUR DATABASE
831. Remove all existing files except inc/secret.php and gateways'
84 configuration (in the gateways directory).
852. Unpack the new tarball into the place.
863. Open the RackTables page in your browser.
874. Follow instructions. Normally, everything should be Ok. If it
88 is not so, write down the failed quieries for further investigation.
7fc5565c 89
c2d46542
DO
90*******************************************************
91* *
92* RELEASE NOTES *
93* *
94*******************************************************
95
9ddee5ea
DO
96*** Upgrading to 0.14.12 ***
97
7fc5565c
DO
98The upgrade may show a failed query "alter database character set utf8", in
99this case the user should issue the query manually from the mysql command
100line.
9ddee5ea
DO
101
102*** Upgrading to 0.16.0 ***
103
104This release features a completely new authorization system, RackCode,
105which brings the tags feature (introduced in 0.15.0) to its full potential.
106The old-style user permissions are converted during upgrade automatically,
107but the result may appear not what you would expect. Review the RackCode
108after upgrade (Main page -> Configuration -> Permissions) and adjust,
109if necessary.
110
111Another important change is a new dependency on "multibyte string" PHP
112extension. Normally one should get it working before starting the upgrade,
113this is typically achieved by installing a particular PHP RPM from the
114standard package repository (and restarting Apache after that):
115
116Fedora: yum install php-mbstring
117ALTLinux: apt-get install php5-mbstring
8608b285 118
4d69ff46
DO
119*** Upgrading to 0.16.3 ***
120
121This release fixes a missing UNIQUE KEY in a table. The upgrade script may
122find it necessary first to transform some records. Because of this it is
123normal to see several "update TagStorage ... Duplicate entry" failed queries
124during the upgrade.
30d0a2a3
DO
125
126*** Upgrading to 0.17.0 ***
127
e1ae3fb4
AD
128This release is the first to take advantage of the foreign key support
129provided by the InnoDB storage engine in MySQL. The installer and
130upgrader scripts check for InnoDB support and cannot complete without it.
131If you have trouble, the first step is to make sure the 'skip-innodb'
132option in my.cnf is commented out.
133
134Another change is the addition of support for file uploads. Files are stored
135in the database. There are several settings in php.ini which you may need to modify:
136 file_uploads - needs to be On
137 upload_max_filesize - max size for uploaded files
138 post_max_size - max size of all form data submitted via POST (including files)