RackTables git mirrors - racktables/blob - 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 authors directly. The project web-site
   4 (http://racktables.org/) is usually kept up to date with the
   5 current version and URLs.
   6
   7 Mailing list: <racktables-users/=@=/freelists.org>
   8 Bug tracker and Wiki: http://racktables.org/trac
   9 Authors: <info/=@=/racktables.org>
  10
  11 *******************************************************
  12 *                                                     *
  13 *             INSTALLING RACKTABLES                   *
  14 *                                                     *
  15 *******************************************************
  16
  17 I. Dependencies.
  18
  19 For database you must have a MySQL server installation
  20 version 4.x or 5.x. InnoDB support must be enabled.
  21 It is a good idea to make it use UTF-8 by default.
  22
  23 * Fedora 8/9: yum install mysql-server mysql
  24 put "default-character-set=utf8" into /etc/my.cnf
  25
  26 * ALTLinux Desktop 4.0: apt-get install MySQL-server
  27 put "CHSET=utf8" into /etc/sysconfig/mysqld
  28
  29 * openSUSE 11.0: YaST -> Software -> software management -> Web and LAMP server -> mysql
  30 put "default-character-set=utf8" into /etc/my.cnf
  31
  32 For web-frontend you must have Apache and PHP 5 with PDO and multibyte
  33 extensions:
  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 \
  38 php5-pdo_mysql php5-pdo apache2-mod_php5 php5-mbstring
  39
  40 * openSUSE 11.0: use YaST to apache2-mod_php5, php5-gd, php5-mbstring, php5-mysql,
  41 php2-snmp and php5-ldap
  42
  43 II. Prepare the server.
  44 1. Unpack the tarball and make it web-accessible, e.g. http://yourcompany.com/racktables
  45 or http://racktables.mysite.org.
  46 2. mysql> create database database_name; grant all privileges on database_name.* to XXX@YYY identified by 'ZZZ';
  47
  48
  49 There are two mutually exclusive ways to install RackTables, they are described as III-A and III-B.
  50
  51
  52 III-A. HTTP installation (starting with 0.14.12 release)
  53 Open your RackTables URL and follow the instructions. In a suitable
  54 environment everything should take a minute or so.
  55
  56
  57 III-B. Manual installation.
  58 1. Edit install/init-auth.sql and change admin password
  59
  60 2. Init database.
  61 mysql> use database_name;
  62 mysql> source install/init-structure.sql
  63 mysql> source install/init-auth.sql
  64 $ rm -f install/init-auth.sql
  65 mysql> source install/init-dictbase.sql
  66 mysql> source install/init-dictvendors.sql
  67
  68 3. Edit inc/secret.php
  69
  70 4. $ rm -f install/init-auth.sql
  71 (Just to be sure you did.)
  72
  73 *******************************************************
  74 *                                                     *
  75 *              UPGRADING RACKTABLES                   *
  76 *                                                     *
  77 *******************************************************
  78 RackTables now provides an automatic database upgrade feature.
  79 If you already have a working installation, the following
  80 procedure should be sufficient:
  81
  82 0. BACKUP YOUR DATABASE
  83 1. Remove all existing files except inc/secret.php and gateways'
  84    configuration (in the gateways directory).
  85 2. Unpack the new tarball into the place.
  86 3. Open the RackTables page in your browser.
  87 4. Follow instructions. Normally, everything should be Ok. If it
  88    is not so, write down the failed quieries for further investigation.
  89
  90 *******************************************************
  91 *                                                     *
  92 *                   RELEASE NOTES                     *
  93 *                                                     *
  94 *******************************************************
  95
  96 *** Upgrading to 0.14.12 ***
  97
  98 The upgrade may show a failed query "alter database character set utf8", in
  99 this case the user should issue the query manually from the mysql command
 100 line.
 101
 102 *** Upgrading to 0.16.0 ***
 103
 104 This release features a completely new authorization system, RackCode,
 105 which brings the tags feature (introduced in 0.15.0) to its full potential.
 106 The old-style user permissions are converted during upgrade automatically,
 107 but the result may appear not what you would expect. Review the RackCode
 108 after upgrade (Main page -> Configuration -> Permissions) and adjust,
 109 if necessary.
 110
 111 Another important change is a new dependency on "multibyte string" PHP
 112 extension. Normally one should get it working before starting the upgrade,
 113 this is typically achieved by installing a particular PHP RPM from the
 114 standard package repository (and restarting Apache after that):
 115
 116 Fedora: yum install php-mbstring
 117 ALTLinux: apt-get install php5-mbstring
 118
 119 *** Upgrading to 0.16.3 ***
 120
 121 This release fixes a missing UNIQUE KEY in a table. The upgrade script may
 122 find it necessary first to transform some records. Because of this it is
 123 normal to see several "update TagStorage ... Duplicate entry" failed queries
 124 during the upgrade.
 125
 126 *** Upgrading to 0.17.0 ***
 127
 128 This release is the first to take advantage of the foreign key support
 129 provided by the InnoDB storage engine in MySQL.  The installer and
 130 upgrader scripts check for InnoDB support and cannot complete without it.
 131 If you have trouble, the first step is to make sure the 'skip-innodb'
 132 option in my.cnf is commented out.
 133
 134 Another change is the addition of support for file uploads.  Files are stored
 135 in 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)
 139
 140 User accounts used to have 'enabled' flag, which allowed individual blocking and
 141 unblocking of each. This flag was dropped in favor of existing mean of access
 142 setup (RackCode). An unconditional denying rule is automatically added into RackCode
 143 for such blocked account, so the effective security policy remains the same.