reformat most of the README in Markdown
[racktables] /
1# Welcome!
2Thank you for selecting RackTables as your datacenter management solution!
3If you are looking for documentation or wish to send feedback, please
4look for the respective links at [project's web-site](
6# Installing RackTables
8## I. Prepare the server
10RackTables requires a MySQL server version 5.x built with InnoDB and
11Unicode support and configured appropriately. By default RackTables is
12developed on Apache httpd with PHP 5 module and several PHP extensions.
13Below is a list of known-good distributions with respective setup notes.
15### Fedora 8-16
16* MySQL: `yum install mysql-server mysql`
17* Apache/PHP: `yum install httpd php php-mysql php-pdo php-gd php-snmp php-mbstring php-bcmath`
18* To enable Unicode, add `character-set-server=utf8` line to `[mysqld]`
19 section of `/etc/my.cnf` file and restart mysqld.
21### Debian 6
22* MySQL: `aptitude install mysql-server-5.1`
23* Apache/PHP: `aptitude install libapache2-mod-php5 php5-gd php5-mysql php5-snmp`
24* To enable Unicode, add `character-set-server=utf8` line to `[mysqld]`
25 section of `/etc/mysql/my.cnf` file and restart mysqld.
27### Debian 7 with nginx
28* MySQL: `aptitude install mysql-server-5.1`
29* nginx: `aptitude install nginx php5-fpm`
30* To enable Unicode, add `character-set-server=utf8` line to `[mysqld]`
31 section of `/etc/mysql/my.cnf` file and restart mysqld.
33Remember to adjust `server_name` in `server {}` section, otherwise your logout link
34will point to localhost (and thus fail).
35Notice, that fpm.sock is advised, keep the rest on default configuration, or
36tweak to your needs. You may need to set `fastcgi_read_timeout 600;` if you use
37some external addons like fping, which may take some time in certain situations.
38Please note that setting aggresive caching for php scripts may result in stale
39content - so maximum of 60 seconds is advised, but by default it is not enabled.
41### Ubuntu 14.04
42* MySQL: `apt-get install mysql-server`
43* Apache/PHP: `apt-get install apache2-bin libapache2-mod-php5 php5-gd php5-mysql php5-snmp`
44* To enable Unicode:
46printf "[mysqld]\ncharacter-set-server=utf8\n" > /etc/mysql/conf.d/charset.cnf
47service mysql restart
49* During install time: MySQL UNIX socket path is `/var/run/mysqld/mysqld.sock`
50 and Apache httpd runs as www-data:www-data.
52### ALTLinux 4.0
53* MySQL: `apt-get install MySQL-server`
54* Apache/PHP: `apt-get install apache2-httpd-prefork php5-gd2 php5-pdo_mysql php5-pdo apache2-mod_php5 php5-mbstring`
55* To enable Unicode, add `CHSET=utf8` line to `/etc/sysconfig/mysqld` file
56 and restart mysqld.
58### openSUSE 11.0
59* MySQL: YaST -> Software -> software management -> Web and LAMP server -> mysql
60* Apache/PHP: use YaST to install apache2-mod_php5, php5-gd, php5-mbstring,
61 php5-mysql, php5-bcmath, php5-snmp and php5-ldap
62* To enable Unicode, add `default-character-set=utf8` line to `[mysql]`
63 section of `/etc/my.cnf` file and restart mysqld.
65### Scientific Linux 6
66* MySQL: `yum install mysql-server mysql`
67* Apache/PHP: `yum install httpd php php-mysql php-pdo php-gd php-mbstring php-bcmath`
68* To enable Unicode, add `character-set-server=utf8` line to `[mysqld]`
69 section of `/etc/my.cnf` file and restart mysqld.
71### CentOS 5
72* MySQL: `yum install mysql-server mysql`
73* Apache/PHP: `yum install httpd php53 php53-mysql php53-pdo php53-gd php53-mbstring php53-bcmath`
74* To enable Unicode, add `character-set-server=utf8` line to `[mysqld]`
75 section of `/etc/my.cnf` file and restart mysqld.
77### FreeBSD 8
78* Apache/PHP:
80# make -C /usr/ports/www/apache13-modssl install
81# make -C /usr/ports/www/php5-session install
82[X] CLI Build CLI version
83[X] APACHE Build Apache module
84[X] MULTIBYTE Enable zend multibyte support
85# make -C /usr/ports/graphics/php5-gd install
86# make -C /usr/ports/databases/php5-pdo_mysql install
87# make -C /usr/ports/devel/pcre install
88!!! Enable UTF-8 support ............ : yes
89!!! Unicode properties .............. : yes
90# make -C /usr/ports/devel/php5-pcre install
91# make -C /usr/ports/converters/php5-mbstring install
92[X] REGEX Enable multibyte regex support
94# make -C /usr/ports/net-mgmt/php5-snmp install
95# make -C /usr/ports/net/php5-ldap install
98## II. Copy the files
99Unpack the tar.gz/zip archive to a directory of your choice and configure Apache
100httpd to use `wwwroot` subdirectory as a new DocumentRoot. Alternatively,
101symlinks to `wwwroot` or even to `index.php` from an existing DocumentRoot are
102also possible and often adisable (see `README.Fedora`).
104## III. Run the installer
105Open the configured RackTables URL and you will be prompted to configure
106and initialize the application.
108# Upgrading RackTables
1100. **Backup your database** and check the release notes below before actually
111 starting the upgrade.
1121. Remove all existing files except configuration (the `inc/secret.php` file)
113 and local plugins (in the `plugins/` directory).
1142. Put the contents of the new tar.gz/zip archive into the place.
1153. Open the RackTables page in a browser. The software will detect version
116 mismatch and display a message telling to log in as admin to finish
117 the upgrade.
1184. Do that and report any errors to the bug tracker or the mailing list.
120## Release notes
122### Upgrading to 0.20.7
124From now on the minimum (oldest) release of PHP that can run RackTables is
1255.2.10. In particular, to continue running RackTables on CentOS 5 it is
126necessary to replace its php* RPM packages with respective php53* packages
127before the upgrade (except the JSON package, which PHP 5.3 provides internally).
129Database triggers are used for some data consistency measures. The database
130user account must have the 'TRIGGER' privilege, which was introduced in
131MySQL 5.1.7.
133The `IPV4OBJ_LISTSRC` configuration option is reset to an expression which enables
134the IP addressing feature for all object types except those listed.
136Tags could now be assigned on the Edit/Properties tab using a text input with
137auto-completion. Type a star '*' to view full tag tree in auto-complete menu.
138It is worth to add the following line to the permissions script if the
139old-fashioned 'Tags' tab is not needed any more:
141 deny {$tab_tags} # this hides 'Tags' tab
144This release converts collation of all DB fields to the `utf8_unicode_ci`. This
145procedure may take some time, and could fail if there are rows that differ only
146by letter case. If this happen, you'll see the failed SQL query in upgrade report
147with the "Duplicate entry" error message. Feel free to continue using your
148installation. If desired so, you could eliminate the case-duplicating rows
149and re-apply the failed query.
151### Upgrading to 0.20.6
153New `MGMT_PROTOS` configuration option replaces the `TELNET_OBJS_LISTSRC`,
154`SSH_OBJS_LISTSRC` and `RDP_OBJS_LISTSRC` options (converting existing settings as
155necessary). `MGMT_PROTOS` allows to specify any management protocol for a
156particular device list using a RackCode filter. The default value
157(`ssh: {$typeid_4}, telnet: {$typeid_8}`) produces `ssh://server.fqdn` for
158servers and `telnet://switch.fqdn` for network switches.
160### Upgrading to 0.20.5
162This release introduces the VS groups feature. VS groups is a new way to store
163and display virtual services configuration. There is a new "ipvs" (VS group)
164realm. All previously existing VS configuration remains functional and user
165is free to convert it to the new format, which displays it in a more natural way
166and allows to generate virtual_server_group keepalived configs. To convert a
167virtual service to the new format, it is necessary to manually create a VS group
168object and assign IP addresses to it. The VS group will display a "Migrate" tab
169to convert the old-style VS objects, which can be removed after a successful
172The old-style VS configuration becomes **deprecated**. Its support will be removed
173in a future major release. So it is strongly recommended to convert it to the
174new format.
176### Upgrading to 0.20.4
178Please note that some dictionary items of Cisco Catalyst 2960 series switches
179were renamed to meet official Cisco classification:
181old name | new name
1832960-48TT | 2960-48TT-L
1842960-24TC | 2960-24TC-L
1852960-24TT | 2960-24TT-L
1862960-8TC | 2960-8TC-L
1872960G-48TC | 2960G-48TC-L
1882960G-24TC | 2960G-24TC-L
1892960G-8TC | 2960G-8TC-L
190C2960-24 | C2960-24-S
191C2960G-24PC | C2960-24PC-L
193The `DATETIME_FORMAT` configuration option used in setting date and time output
194format now uses a [different](
195syntax. During upgrade the option is reset to
196the default value, which is now %Y-%m-%d (YYYY-MM-DD) per ISO 8601.
198This release intoduces two new configuration options:
201### Upgrading to 0.20.1
203The 0.20.0 release includes bug which breaks IP networks' capacity displaying on
20432-bit architecture machines. To fix this, this release makes use of PHP's BC
205Math module. It is a new reqiurement. Most PHP distributions have this module
206already enabled, but if yours does not - you need yo recompile PHP.
208Security context of 'ipaddress' page now includes tags from the network
209containing an IP address. This means that you should audit your permission rules
210to check there is no unintended allows of changing IPs based on network's
211tagset. Example:
213 allow {client network} and {New York}
215This rule now not only allows any operation on NY client networks, but also any
216operation with IP addresses included in those networks. To fix this, you should
217change the rule this way:
219 allow {client network} and {New York} and not {$page_ipaddress}
222### Upgrading to 0.20.0
224WARNING: This release have too many internal changes, some of them were waiting
225more than a year to be released. So this release is considered "BETA" and is
226recommended only to curiuos users, who agree to sacrifice the stability to the
229Racks and Rows are now stored in the database as Objects. The RackObject table
230was renamed to Object. SQL views were created to ease the migration of custom
231reports and scripts.
233New plugins engine instead of `local.php` file. To make your own code stored in
234`local.php` work, you must move the `local.php` file into the `plugins/` directory.
235The name of this file does not matter any more. You also can store multiple
236files in that dir, separate your plugins by features, share them and try the
237plugins from other people just placing them into `plugins/` dir, no more merging.
239* `$path_to_local_php` variable has no special meaning any more.
240* `$racktables_confdir` variable is now used only to search for `secret.php` file.
241* `$racktables_plugins_dir` is a new overridable special variable pointing to `plugins/` directory.
243Beginning with this version it is possible to delete IP prefixes, VLANs, Virtual
244services and RS pools from within theirs properties tab. So please inspect your
245permissions rules to assure there are no undesired allows for deletion of these
246objects. To ensure this, you could try this code in the beginning of permissions
249allow {userid_1} and {$op_del}
250deny {$op_del} and ({$tab_edit} or {$tab_properties})
253Hardware gateways engine was rewritten in this version of RackTables. This means
254that the file `gateways/deviceconfig/switch.secrets.php` is not used any more. To
255get information about configuring connection properties and credentials in a new
256way please read [this](
258This also means that recently added features based on old API (D-Link switches
259and Linux gateway support contributed by Ilya Evseev) are not working any more
260and waiting to be forward-ported to new gateways API. Sorry for that.
262Two new config variables appeared in this version:
263 - `SEARCH_DOMAINS`. Comma-separated list of DNS domains which are considered
264 "base" for your network. If RackTables search engine finds multiple objects
265 based on your search input, but there is only one which FQDN consists of
266 your input and one of these search domains, you will be redirected to this
267 object and other results will be discarded. Such behavior was unconditional
268 since 0.19.3, which caused many objections from users. So welcome this
269 config var.
270 - `QUICK_LINK_PAGES`. Comma-separated list of RackTables pages to display links
271 to them on top. Each user could have his own list.
273Also some of config variables have changed their default values in this version.
274This means that upgrade script will change their values if you have them in
275previous default state. This could be inconvenient, but it is the most effective
276way to encourage users to use new features. If this behavior is not what you
277want, simply revert these variables' values:
279variable | old | new | comment
281`SHOW_LAST_TAB` | no | yes
282`IPV4_TREE_SHOW_USAGE` | yes | no | Networks' usage is still available by click.
283`IPV4LB_LISTSRC` | {$typeid_4} | false
284`FILTER_DEFAULT_ANDOR` | or | and | This implicitly enables the feature of dynamic tree shrinking.
285`FILTER_SUGGEST_EXTRA` | no | yes | Yes, we have extra logical filters!
286`IPV4_TREE_RTR_AS_CELL` | yes | no | Display routers as simple text, not cell.
288Also please note that variable `IPV4_TREE_RTR_AS_CELL` now has third special value
289besides 'yes' and 'no': 'none'. Use 'none' value if you are experiencing low
290performance on IP tree page. It will completely disable IP ranges scan for
291used/spare IPs and the speed of IP tree will increase radically. The price is
292you will not see the routers in IP tree at all.
294### Upgrading to 0.19.13
295A new "date" attribute type has been added. Existing date based fields ("HW
296warranty expiration", "support contract expiration" and "SW warranty
297expiration") will be converted to this new type but must be in the format
298"mm/dd/yyyy" otherwise the conversion will fail.
300### Upgrading to 0.19.2
302This release is different in filesystem layout. The "gateways" directory has
303been moved from `wwwroot` directory. This improves security a bit. You can also
304separate your local settings and add-ons from the core RackTables code. To do
305that, put a single `index.php` file into the DocumentRoot of your http server:
310require '/directory_where_you_extracted_racktables_distro/wwwroot/index.php';
314No more files are needed to be available directly over the HTTP. Full list of
315filesystem paths which could be specified in custom `index.php` or `secret.php`:
316* `$racktables_gwdir`: path to the gateways directory;
317* `$racktables_staticdir`: path to the directory containing `pix`, `js`, `css` directories;
318* `$racktables_confdir`: path where secret.php and local.php are located. It is not recommended to define it in `secret.php`, cause only the path to `local.php` will be affected;
319* `$path_to_secret_php`: Ignore `$racktables_confdir` when locating `secret.php` and use the specified path;
320* `$path_to_local_php`: idem for `local.php`.
322### Upgrading to 0.19.0
324The files, which are intended for the httpd (web-server) directory, are now in
325the `wwwroot` directory of the tar.gz archive. Files outside of that directory
326are not directly intended for httpd environment and should not be copied to the
329This release incorporates ObjectLog functionality, which used to be available as
330a separate plugin. For the best results it is advised to disable (through
331`local.php`) external ObjectLog plugin permanently before the new version is
332installed. All previously accumulated ObjectLog records will be available
333through the updated standard interface.
335RackTables is now using PHP JSON extension which is included in the PHP core
336since 5.2.0.
338The barcode attribute was removed. The upgrade script attempts to preserve the
339data by moving it to either the 'OEM S/N 1' attribute or to a Log entry. You
340should backup your database beforehand anyway.
342### Upgrading to 0.18.x
344RackTables from its version 0.18.0 and later is not compatible with RHEL/CentOS
345(at least with versions up to 5.5) Linux distributions in their default
346installation. There are yet options to work around that:
3481. Install RackTables on a server with a different distribution/OS.
3492. Request Linux distribution vendor to fix the bug with PCRE.
3503. Repair your RHEL/CentOS installation yourself by fixing its PCRE
351 RPM as explained [here](