Update dictionary.php
[racktables] / README
CommitLineData
fedf925b
DO
1Thank you for selecting RackTables as your datacenter management solution!
2If you are looking for documentation or wish to send feedback, please
3look for the respective links at project's web-site (racktables.org).
de8695b2
DO
4
5*******************************************************
6* *
7* INSTALLING RACKTABLES *
8* *
9*******************************************************
10
fedf925b 11*** I. SERVER ***
de8695b2 12
fedf925b
DO
13RackTables requires a MySQL server version 5.x built with InnoDB and
14Unicode support and configured appropriately. It also requires an Apache
15httpd with PHP 5 module and several PHP extensions. Below is a list of
d1a9e5cf 16known-good distributions with respective setup notes.
3ebdbeed 17
570f1df4 18*** Fedora 8-16
fedf925b 19* MySQL: yum install mysql-server mysql
65ccc533
DO
20* Apache/PHP: yum install httpd php php-mysql php-pdo php-gd php-snmp \
21 php-mbstring php-bcmath
fedf925b
DO
22* To enable Unicode, add "character-set-server=utf8" line to "[mysqld]"
23section of "/etc/my.cnf" file and restart mysqld.
3ebdbeed 24
e8be2f81
DO
25*** Debian 6
26* MySQL: aptitude install mysql-server-5.1
27* Apache/PHP: aptitude install libapache2-mod-php5 php5-gd php5-mysql php5-snmp
28* To enable Unicode, add "character-set-server=utf8" line to "[mysqld]"
29section of "/etc/mysql/my.cnf" file and restart mysqld.
30
fedf925b
DO
31*** ALTLinux 4.0
32* MySQL: apt-get install MySQL-server
33* Apache/PHP: apt-get install apache2-httpd-prefork php5-gd2 \
9ddee5ea 34php5-pdo_mysql php5-pdo apache2-mod_php5 php5-mbstring
fedf925b
DO
35* To enable Unicode, add "CHSET=utf8" line to "/etc/sysconfig/mysqld" file
36and restart mysqld.
37
38*** openSUSE 11.0
39* MySQL: YaST -> Software -> software management -> Web and LAMP server -> mysql
40* Apache/PHP: use YaST to install apache2-mod_php5, php5-gd, php5-mbstring,
9dedb20f 41php5-mysql, php5-bcmath, php5-snmp and php5-ldap
fedf925b
DO
42* To enable Unicode, add "default-character-set=utf8" line to "[mysql]"
43section of "/etc/my.cnf" file and restart mysqld.
44
1c433d1e
DO
45*** Scientific Linux 6
46* MySQL: yum install mysql-server mysql
9dedb20f 47* Apache/PHP: httpd php php-mysql php-pdo php-gd php-mbstring php-bcmath
1c433d1e
DO
48* To enable Unicode, add "character-set-server=utf8" line to "[mysqld]"
49section of "/etc/my.cnf" file and restart mysqld.
50
fedf925b
DO
51*** FreeBSD 8
52* Apache/PHP:
a3bce64d
DO
53# make -C /usr/ports/www/apache13-modssl install
54# make -C /usr/ports/www/php5-session install
55[X] CLI Build CLI version
56[X] APACHE Build Apache module
57[X] MULTIBYTE Enable zend multibyte support
58# make -C /usr/ports/graphics/php5-gd install
59# make -C /usr/ports/databases/php5-pdo_mysql install
c20f01f4
DO
60# make -C /usr/ports/devel/pcre install
61!!! Enable UTF-8 support ............ : yes
62!!! Unicode properties .............. : yes
a3bce64d
DO
63# make -C /usr/ports/devel/php5-pcre install
64# make -C /usr/ports/converters/php5-mbstring install
65[X] REGEX Enable multibyte regex support
66
67# make -C /usr/ports/net-mgmt/php5-snmp install
68# make -C /usr/ports/net/php5-ldap install
d3372430 69
fedf925b 70*** II. FILES ***
d1a9e5cf 71Unpack distro files to any directory you want and configure Apache to "wwwroot"
65ccc533
DO
72subdirectory as DocumentRoot. Symlinks to wwwroot or even index.php from your
73web server root are also possible.
c2d46542 74
fedf925b
DO
75*** III. INSTALLER ***
76Open your configured RackTables URL and you will be prompted to configure
77and initialize the application.
c2d46542 78
de8695b2
DO
79*******************************************************
80* *
81* UPGRADING RACKTABLES *
82* *
83*******************************************************
d3372430
DO
84RackTables (since 0.14.6) provides an automatic database upgrade feature.
85If you already have a working installation, the following procedure
86should be sufficient:
de8695b2 87
fedf925b
DO
880. BACKUP YOUR DATABASE and check the release notes (below) before actually
89 starting the upgrade,.
dd14756b
AA
901. Remove all existing files except inc/secret.php and the gateways'
91 configuration (in the gateways directory).
de8695b2 922. Unpack the new tarball into the place.
fedf925b 933. Open your RackTables page in a browser. The software detects version
d3372430
DO
94 mismatch and displays a message telling to log in as admin to finish
95 the upgrade.
964. Do that. Normally, everything should be Ok. If there are
fedf925b 97 errors displayed, send these in a bug report.
7fc5565c 98
c2d46542
DO
99*******************************************************
100* *
101* RELEASE NOTES *
102* *
103*******************************************************
104
6a40d076 105*** Upgrading to 0.20.6 ***
a7390942
AD
106
107Database triggers are used for some data consistency measures. The database
108user account must have the 'TRIGGER' privilege, which was introduced in
109MySQL 5.1.7.
110
111Cable paths can be traced and displayed in a graphical format. This requires
6a40d076 112the Image_GraphViz PEAR module (http://pear.php.net/package/Image_GraphViz).
a7390942 113
fd3ef4e7
AA
114Config variables TELNET_OBJS_LISTSRC, SSH_OBJS_LISTSRC, RDP_OBJS_LISTSRC were merged into new MGMT_PROTOS.
115The old ones were deleted from the DB. MGMT_PROTOS allows to specify any management protocol for a particular
116device list by RackCode filter. The default value is 'ssh: {\$typeid_4}, telnet: {\$typeid_8}' which leads to
117object's FQDN linked to 'ssh://server.fqdn' and 'telnet://switch.fqdn'. If the old variables contained any data,
118it will be converted to the new syntax and stored into MGMT_PROTOS variable.
119
eacc0983
AA
120*** Upgrading to 0.20.5 ***
121
122This release introduces the VS groups feature. VS groups is a new way to store
123and display virtual services configuration. New realm 'ipvs' (VS group) is created.
124All the existing VS configuration is kept and displayed as-is, but user is free to convert
125it to the new format, which displays it in more natural way and allows to generate
ceea33a2 126virtual_server_group keepalived configs. To convert a virtual service to the new format,
eacc0983
AA
127you need to manually create the vs group object and assign IP addresses to it. Then, if you
128have the old-style VSes configured, the Migrate tab will be displayed on the particular VS group's
129page. After successfull migration, you can remove the old-style VS objects.
130
131Old-style VS configuration becomes DEPRECATED. Its support will be removed in one of the following
132major releases. So it is strongly recommended to convert it to the new format.
133
ef550f27
AA
134*** Upgrading to 0.20.4 ***
135
65ccc533
DO
136Please note that some dictionary items of Cisco Catalyst 2960 series switches
137were renamed to meet official Cisco classification:
ef550f27
AA
138 2960-48TT => 2960-48TT-L
139 2960-24TC => 2960-24TC-L
140 2960-24TT => 2960-24TT-L
141 2960-8TC => 2960-8TC-L
142 2960G-48TC => 2960G-48TC-L
143 2960G-24TC => 2960G-24TC-L
144 2960G-8TC => 2960G-8TC-L
145 C2960-24 => C2960-24-S
146 C2960G-24PC => C2960-24PC-L
147
2a943f85
DO
148The DATETIME_FORMAT configuration option used in setting date and time output
149format now uses a different [1] syntax. During upgrade the option is reset to
150the default value, which is now %Y-%m-%d (YYYY-MM-DD) per ISO 8601.
151
a7192a34
AA
152This release intoduces two new configuration options:
153REVERSED_RACKS_LISTSRC and NEAREST_RACKS_CHECKBOX.
154
2a943f85 155[1] http://php.net/manual/en/function.strftime.php
ef550f27 156
038739ac
AA
157*** Upgrading to 0.20.1 ***
158
65ccc533
DO
159The 0.20.0 release includes bug which breaks IP networks' capacity displaying on
16032-bit architecture machines. To fix this, this release makes use of PHP's BC
161Math module. It is a new reqiurement. Most PHP distributions have this module
162already enabled, but if yours does not - you need yo recompile PHP.
d76549bc 163
65ccc533
DO
164Security context of 'ipaddress' page now includes tags from the network
165containing an IP address. This means that you should audit your permission rules
166to check there is no unintended allows of changing IPs based on network's
167tagset. Example:
038739ac 168 allow {client network} and {New York}
65ccc533
DO
169This rule now not only allows any operation on NY client networks, but also any
170operation with IP addresses included in those networks. To fix this, you should
171change the rule this way:
038739ac
AA
172 allow {client network} and {New York} and not {$page_ipaddress}
173
9b8174d7
AD
174*** Upgrading to 0.20.0 ***
175
65ccc533
DO
176WARNING: This release have too many internal changes, some of them were waiting
177more than a year to be released. So this release is considered "BETA" and is
178recommended only to curiuos users, who agree to sacrifice the stability to the
179progress.
d1a9e5cf
AA
180
181Racks and Rows are now stored in the database as Objects. The RackObject table
182was renamed to Object. SQL views were created to ease the migration of custom
9b8174d7
AD
183reports and scripts.
184
65ccc533
DO
185New plugins engine instead of local.php file. To make your own code stored in
186local.php work, you must move the local.php file into the plugins/ directory.
187The name of this file does not matter any more. You also can store multiple
188files in that dir, separate your plugins by features, share them and try the
189plugins from other people just placing them into plugins/ dir, no more merging.
190
d1a9e5cf 191$path_to_local_php variable has no special meaning any more.
dd14756b 192$racktables_confdir variable is now used only to search for secret.php file.
65ccc533
DO
193$racktables_plugins_dir is a new overridable special variable pointing to
194 plugins/ directory.
dd14756b 195
65ccc533
DO
196Beginning with this version it is possible to delete IP prefixes, VLANs, Virtual
197services and RS pools from within theirs properties tab. So please inspect your
198permissions rules to assure there are no undesired allows for deletion of these
199objects. To ensure this, you could try this code in the beginning of permissions
200script:
d1a9e5cf
AA
201
202 allow {userid_1} and {$op_del}
203 deny {$op_del} and ({$tab_edit} or {$tab_properties})
204
65ccc533
DO
205Hardware gateways engine was rewritten in this version of RackTables. This means
206that the file gateways/deviceconfig/switch.secrets.php is not used any more. To
207get information about configuring connection properties and credentials in a new
208way please visit http://wiki.racktables.org/index.php/Gateways
d1a9e5cf 209
65ccc533
DO
210This also means that recently added features based on old API (D-Link switches
211and Linux gateway support contributed by Ilya Evseev) are not working any more
212and waiting to be forward-ported to new gateways API. Sorry for that.
d1a9e5cf
AA
213
214Two new config variables appeared in this version:
65ccc533
DO
215 - SEARCH_DOMAINS. Comma-separated list of DNS domains which are considered
216 "base" for your network. If RackTables search engine finds multiple objects
217 based on your search input, but there is only one which FQDN consists of
218 your input and one of these search domains, you will be redirected to this
219 object and other results will be discarded. Such behavior was unconditional
220 since 0.19.3, which caused many objections from users. So welcome this
221 config var.
222 - QUICK_LINK_PAGES. Comma-separated list of RackTables pages to display links
223 to them on top. Each user could have his own list.
d1a9e5cf
AA
224
225Also some of config variables have changed their default values in this version.
65ccc533
DO
226This means that upgrade script will change their values if you have them in
227previous default state. This could be inconvenient, but it is the most effective
228way to encourage users to use new features. If this behavior is not what you
229want, simply revert these variables' values:
d1a9e5cf 230 - SHOW_LAST_TAB no => yes
65ccc533
DO
231 - IPV4_TREE_SHOW_USAGE yes =>no (networks' usage is still available
232 by click)
d1a9e5cf 233 - IPV4LB_LISTSRC {$typeid_4} => false
65ccc533
DO
234 - FILTER_DEFAULT_ANDOR or => and (this implicitly enables the feature
235 of dynamic tree shrinking)
d1a9e5cf 236 - FILTER_SUGGEST_EXTRA no => yes (yes, we have extra logical filters!)
65ccc533
DO
237 - IPV4_TREE_RTR_AS_CELL yes => no (display routers as simple text, not
238 cell)
d1a9e5cf
AA
239
240Also please note that variable IPV4_TREE_RTR_AS_CELL now has third special value
65ccc533
DO
241besides 'yes' and 'no': 'none'. Use 'none' value if you are experiencing low
242performance on IP tree page. It will completely disable IP ranges scan for
243used/spare IPs and the speed of IP tree will increase radically. The price is
244you will not see the routers in IP tree at all.
7ec03062 245
86ff26ae 246*** Upgrading to 0.19.13 ***
65ccc533
DO
247A new "date" attribute type has been added. Existing date based fields ("HW
248warranty expiration", "support contract expiration" and "SW warranty
86ff26ae
DO
249expiration") will be converted to this new type but must be in the format
250"mm/dd/yyyy" otherwise the conversion will fail.
251
36efe434
DO
252*** Upgrading to 0.19.2 ***
253
65ccc533
DO
254This release is different in filesystem layout. The "gateways" directory has
255been moved from "wwwroot" directory. This improves security a bit. You can also
256separate your local settings and add-ons from the core RackTables code. To do
257that, put a single index.php file into the DocumentRoot of your http server:
4f5aea8a
AA
258
259<?php
65ccc533 260$racktables_confdir='/directory/with/secret.php/and/local.php/';
4f5aea8a
AA
261require '/directory_where_you_extracted_racktables_distro/wwwroot/index.php';
262?>
263
65ccc533
DO
264No more files are needed to be available directly over the HTTP. Full list of
265filesystem paths which could be specified in custom index.php or secret.php:
4f5aea8a 266 $racktables_gwdir: path to the gateways directory;
65ccc533
DO
267 $racktables_staticdir: path to the directory containing 'pix', 'js', 'css'
268 directories;
269 $racktables_confdir: path where secret.php and local.php are located. It is
270 not recommended to define it in secret.php, cause only
271 the path to local.php will be affected;
272 $path_to_secret_php: Ignore $racktables_confdir when locating secret.php and
273 use the specified path;
4f5aea8a 274 $path_to_local_php: idem for local.php.
36efe434 275
841a5b54 276*** Upgrading to 0.19.0 ***
6f542dde 277
65ccc533
DO
278The files, which are intended for the httpd (web-server) directory, are now in
279the "wwwroot" directory of the tar.gz archive. Files outside of that directory
280are not directly intended for httpd environment and should not be copied to the
281server.
65e557dd 282
65ccc533
DO
283This release incorporates ObjectLog functionality, which used to be available as
284a separate plugin. For the best results it is advised to disable (through
285local.php) external ObjectLog plugin permanently before the new version is
286installed. All previously accumulated ObjectLog records will be available
287through the updated standard interface.
8489d2af 288
65ccc533
DO
289RackTables is now using PHP JSON extension which is included in the PHP core
290since 5.2.0.
841a5b54 291
65ccc533
DO
292The barcode attribute was removed. The upgrade script attempts to preserve the
293data by moving it to either the 'OEM S/N 1' attribute or to a Log entry. You
294should backup your database beforehand anyway.
81659c05 295
1679ddbd
DO
296*** Upgrading to 0.18.x ***
297
65ccc533
DO
298RackTables from its version 0.18.0 and later is not compatible with RHEL/CentOS
299(at least with versions up to 5.5) Linux distributions in their default
300installation. There are yet options to work around that:
1679ddbd
DO
3011. Install RackTables on a server with a different distribution/OS.
3022. Request Linux distribution vendor to fix the bug with PCRE.
3033. Repair your RHEL/CentOS installation yourself by fixing its PCRE
65ccc533 304 RPM as explained here: http://bugs.centos.org/view.php?id=3252
30d0a2a3
DO
305
306*** Upgrading to 0.17.0 ***
307
65ccc533
DO
308One can always install RackTables 0.17.0 from scratch. However, upgrading an
309existing installation to 0.17.0 implies a certain upgrade path. If the existing
310database version is less, than 0.16.4, it must first be upgraded to version
3110.16.4, 0.16.5 or 0.16.6 (at one's choice) using appropriate tar.gz
312distribution. The resulting 0.16.4+ database can be upgraded to 0.17.0 (or later
313version) in a normal way (with tar.gz of the desired 0.17.x release).
d74ae24c 314
2c9fde3a
DO
315LDAP options have been moved to LDAP_options array. This means, that if you were
316using LDAP authentication for users in version 0.16.x, it will break right after
aca5a846 317upgrade to 0.17.0. To get things working again, adjust existing secret.php file
2c9fde3a
DO
318according to secret-sample.php file provided with 0.17.0 release.
319
65ccc533
DO
320This release is the first to take advantage of the foreign key support provided
321by the InnoDB storage engine in MySQL. The installer and upgrader scripts check
322for InnoDB support and cannot complete without it. If you have trouble, the
323first step is to make sure the 'skip-innodb' option in my.cnf is commented out.
e1ae3fb4 324
65ccc533
DO
325Another change is the addition of support for file uploads. Files are stored in
326the database. There are several settings in php.ini which you may need to
327modify:
e1ae3fb4
AD
328 file_uploads - needs to be On
329 upload_max_filesize - max size for uploaded files
65ccc533
DO
330 post_max_size - max size of all form data submitted via POST
331 (including files)
3e1c9c67 332
79b8ad1e 333User accounts used to have 'enabled' flag, which allowed individual blocking and
a476909e 334unblocking of each. This flag was dropped in favor of existing mean of access
65ccc533
DO
335setup (RackCode). An unconditional denying rule is automatically added into
336RackCode for such blocked account, so the effective security policy remains the
337same.