r2780 - getDict(): correctly fill "refcnt" section for chapters 1 (RackObjectType...
[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
d3372430 17I. Install dependencies.
de8695b2 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
3e1c9c67 29* openSUSE 11.0: YaST -> Software -> software management -> Web and LAMP server -> mysql
3ebdbeed 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 40* openSUSE 11.0: use YaST to apache2-mod_php5, php5-gd, php5-mbstring, php5-mysql,
93bdb7ba 41php5-snmp and php5-ldap
3ebdbeed 42
d3372430
DO
43
44II. Prepare the files and database.
de8695b2
DO
451. Unpack the tarball and make it web-accessible, e.g. http://yourcompany.com/racktables
46or http://racktables.mysite.org.
e1ae3fb4 472. mysql> create database database_name; grant all privileges on database_name.* to XXX@YYY identified by 'ZZZ';
c2d46542
DO
48
49
d3372430 50III. Finish the installation.
c2d46542
DO
51Open your RackTables URL and follow the instructions. In a suitable
52environment everything should take a minute or so.
53
de8695b2
DO
54*******************************************************
55* *
56* UPGRADING RACKTABLES *
57* *
58*******************************************************
d3372430
DO
59RackTables (since 0.14.6) provides an automatic database upgrade feature.
60If you already have a working installation, the following procedure
61should be sufficient:
de8695b2
DO
62
630. BACKUP YOUR DATABASE
063ad43c
AD
641. Remove all existing files except local/secret.php, gateways'
65 configuration (in the gateways directory) and local mod (local/local.php).
de8695b2 662. Unpack the new tarball into the place.
d3372430
DO
673. Open the RackTables page in your browser. The software detects version
68 mismatch and displays a message telling to log in as admin to finish
69 the upgrade.
704. Do that. Normally, everything should be Ok. If there are
71 errors displayed, copy and send them to us for review.
7fc5565c 72
c2d46542
DO
73*******************************************************
74* *
75* RELEASE NOTES *
76* *
77*******************************************************
78
9ddee5ea
DO
79*** Upgrading to 0.14.12 ***
80
7fc5565c
DO
81The upgrade may show a failed query "alter database character set utf8", in
82this case the user should issue the query manually from the mysql command
83line.
9ddee5ea
DO
84
85*** Upgrading to 0.16.0 ***
86
87This release features a completely new authorization system, RackCode,
88which brings the tags feature (introduced in 0.15.0) to its full potential.
89The old-style user permissions are converted during upgrade automatically,
90but the result may appear not what you would expect. Review the RackCode
91after upgrade (Main page -> Configuration -> Permissions) and adjust,
92if necessary.
93
94Another important change is a new dependency on "multibyte string" PHP
95extension. Normally one should get it working before starting the upgrade,
96this is typically achieved by installing a particular PHP RPM from the
97standard package repository (and restarting Apache after that):
98
99Fedora: yum install php-mbstring
100ALTLinux: apt-get install php5-mbstring
8608b285 101
4d69ff46
DO
102*** Upgrading to 0.16.3 ***
103
104This release fixes a missing UNIQUE KEY in a table. The upgrade script may
105find it necessary first to transform some records. Because of this it is
106normal to see several "update TagStorage ... Duplicate entry" failed queries
107during the upgrade.
30d0a2a3
DO
108
109*** Upgrading to 0.17.0 ***
110
063ad43c
AD
111User-modifiable files have been moved to a dedicated directory to make future upgrades easier.
112cd to the RackTables directory and run these commands:
113
1141. mkdir local
1152. mv inc/secret*.php local/
1163. mv inc/local.php local/
117
3e1c9c67
DO
118This release is the first to take advantage of the foreign key support
119provided by the InnoDB storage engine in MySQL. The installer and
e1ae3fb4
AD
120upgrader scripts check for InnoDB support and cannot complete without it.
121If you have trouble, the first step is to make sure the 'skip-innodb'
122option in my.cnf is commented out.
123
124Another change is the addition of support for file uploads. Files are stored
125in the database. There are several settings in php.ini which you may need to modify:
126 file_uploads - needs to be On
127 upload_max_filesize - max size for uploaded files
3e1c9c67
DO
128 post_max_size - max size of all form data submitted via POST (including files)
129
79b8ad1e 130User accounts used to have 'enabled' flag, which allowed individual blocking and
a476909e
DO
131unblocking of each. This flag was dropped in favor of existing mean of access
132setup (RackCode). An unconditional denying rule is automatically added into RackCode
133for such blocked account, so the effective security policy remains the same.