Update README with nginx and php5-fpm conf
[racktables-incomplete-works] / 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 13RackTables requires a MySQL server version 5.x built with InnoDB and
cd183ce0
MS
14Unicode support and configured appropriately. By default RackTables is
15developed on Apache httpd with PHP 5 module and several PHP extensions.
16Below is a list of known-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
cd183ce0
MS
31*** Debian 7 with nginx
32* MySQL: aptitude install mysql-server-5.1
33* nginx: aptitude install nginx php5-fpm
34* Remember to adjust server_name in server {} section, otherwise your logout link
35* will point to localhost (and thus fail).
36* Notice, that fpm.sock is advised, keep the rest on default configuration, or
37* tweak to your needs. You may need to set fastcgi_read_timeout 600; if you use
38* some external addons like fping, which may take some time in certain situations.
39* Please note that setting aggresive caching for php scripts may result in stale
40* content - so maximum of 60 seconds is advised, but by default it is not enabled.
41* To enable Unicode, add "character-set-server=utf8" line to "[mysqld]"
42section of "/etc/mysql/my.cnf" file and restart mysqld.
43
fedf925b
DO
44*** ALTLinux 4.0
45* MySQL: apt-get install MySQL-server
46* Apache/PHP: apt-get install apache2-httpd-prefork php5-gd2 \
9ddee5ea 47php5-pdo_mysql php5-pdo apache2-mod_php5 php5-mbstring
fedf925b
DO
48* To enable Unicode, add "CHSET=utf8" line to "/etc/sysconfig/mysqld" file
49and restart mysqld.
50
51*** openSUSE 11.0
52* MySQL: YaST -> Software -> software management -> Web and LAMP server -> mysql
53* Apache/PHP: use YaST to install apache2-mod_php5, php5-gd, php5-mbstring,
9dedb20f 54php5-mysql, php5-bcmath, php5-snmp and php5-ldap
fedf925b
DO
55* To enable Unicode, add "default-character-set=utf8" line to "[mysql]"
56section of "/etc/my.cnf" file and restart mysqld.
57
1c433d1e
DO
58*** Scientific Linux 6
59* MySQL: yum install mysql-server mysql
9dedb20f 60* Apache/PHP: httpd php php-mysql php-pdo php-gd php-mbstring php-bcmath
36492caa
DO
61* To enable Unicode, add "character-set-server=utf8" line to "[mysqld]"
62section of "/etc/my.cnf" file and restart mysqld.
63
64*** CentOS 5
65* MySQL: yum install mysql-server mysql
66* Apache/PHP: httpd php53 php53-mysql php53-pdo php53-gd php53-mbstring \
67 php53-bcmath
1c433d1e
DO
68* To enable Unicode, add "character-set-server=utf8" line to "[mysqld]"
69section of "/etc/my.cnf" file and restart mysqld.
70
fedf925b
DO
71*** FreeBSD 8
72* Apache/PHP:
a3bce64d
DO
73# make -C /usr/ports/www/apache13-modssl install
74# make -C /usr/ports/www/php5-session install
75[X] CLI Build CLI version
76[X] APACHE Build Apache module
77[X] MULTIBYTE Enable zend multibyte support
78# make -C /usr/ports/graphics/php5-gd install
79# make -C /usr/ports/databases/php5-pdo_mysql install
c20f01f4
DO
80# make -C /usr/ports/devel/pcre install
81!!! Enable UTF-8 support ............ : yes
82!!! Unicode properties .............. : yes
a3bce64d
DO
83# make -C /usr/ports/devel/php5-pcre install
84# make -C /usr/ports/converters/php5-mbstring install
85[X] REGEX Enable multibyte regex support
86
87# make -C /usr/ports/net-mgmt/php5-snmp install
88# make -C /usr/ports/net/php5-ldap install
d3372430 89
fedf925b 90*** II. FILES ***
b8433971
DO
91Unpack the tar.gz/zip archive to a directory of your choice and configure Apache
92httpd to use "wwwroot" subdirectory as a new DocumentRoot. Alternatively,
93symlinks to "wwwroot" or even to "index.php" from an existing DocumentRoot are
94also possible and often adisable (see README.Fedora).
c2d46542 95
fedf925b 96*** III. INSTALLER ***
b8433971 97Open the configured RackTables URL and you will be prompted to configure
fedf925b 98and initialize the application.
c2d46542 99
de8695b2
DO
100*******************************************************
101* *
102* UPGRADING RACKTABLES *
103* *
104*******************************************************
b8433971
DO
105
1060. BACKUP YOUR DATABASE and check the release notes below before actually
107 starting the upgrade.
1081. Remove all existing files except configuration (the "inc/secret.php" file)
109 and local plugins (in the "plugins" directory).
1102. Put the contents of the new tar.gz/zip archive into the place.
1113. Open the RackTables page in a browser. The software will detect version
112 mismatch and display a message telling to log in as admin to finish
d3372430 113 the upgrade.
b8433971 1144. Do that and report any errors to the bug tracker or the mailing list.
7fc5565c 115
c2d46542
DO
116*******************************************************
117* *
118* RELEASE NOTES *
119* *
120*******************************************************
121
25355e1d
AD
122*** Upgrading to 0.20.7 ***
123
ae9ada40
DO
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).
128
7740234b
AD
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.
132
25355e1d
AD
133The IPV4OBJ_LISTSRC configuration option is reset to an expression which enables
134the IP addressing feature for all object types except those listed.
135
23e52760
AA
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:
140 deny {$tab_tags} # this hides 'Tags' tab
141
b4bc5582
TU
142This release converts collation of all DB fields to the utf8_unicode_ci. This
143procedure may take some time, and could fail if there are rows that differ only
144by letter case. If this happen, you'll see the failed SQL query in upgrade report
145with the "Duplicate entry" error message. Feel free to continue using your
146installation. If desired so, you could eliminate the case-duplicating rows
147and re-apply the failed query.
148
ceebebb9 149*** Upgrading to 0.20.6 ***
a7390942 150
b8433971
DO
151New MGMT_PROTOS configuration option replaces the TELNET_OBJS_LISTSRC,
152SSH_OBJS_LISTSRC and RDP_OBJS_LISTSRC options (converting existing settings as
153necessary). MGMT_PROTOS allows to specify any management protocol for a
154particular device list using a RackCode filter. The default value
155("ssh: {$typeid_4}, telnet: {$typeid_8}") produces "ssh://server.fqdn" for
156servers and "telnet://switch.fqdn" for network switches.
fd3ef4e7 157
eacc0983
AA
158*** Upgrading to 0.20.5 ***
159
160This release introduces the VS groups feature. VS groups is a new way to store
b8433971
DO
161and display virtual services configuration. There is a new "ipvs" (VS group)
162realm. All previously existing VS configuration remains functional and user
163is free to convert it to the new format, which displays it in a more natural way
164and allows to generate virtual_server_group keepalived configs. To convert a
165virtual service to the new format, it is necessary to manually create a VS group
166object and assign IP addresses to it. The VS group will display a "Migrate" tab
167to convert the old-style VS objects, which can be removed after a successful
168conversion.
169
170The old-style VS configuration becomes DEPRECATED. Its support will be removed
171in a future major release. So it is strongly recommended to convert it to the
172new format.
eacc0983 173
ef550f27
AA
174*** Upgrading to 0.20.4 ***
175
65ccc533
DO
176Please note that some dictionary items of Cisco Catalyst 2960 series switches
177were renamed to meet official Cisco classification:
ef550f27
AA
178 2960-48TT => 2960-48TT-L
179 2960-24TC => 2960-24TC-L
180 2960-24TT => 2960-24TT-L
181 2960-8TC => 2960-8TC-L
182 2960G-48TC => 2960G-48TC-L
183 2960G-24TC => 2960G-24TC-L
184 2960G-8TC => 2960G-8TC-L
185 C2960-24 => C2960-24-S
186 C2960G-24PC => C2960-24PC-L
187
2a943f85
DO
188The DATETIME_FORMAT configuration option used in setting date and time output
189format now uses a different [1] syntax. During upgrade the option is reset to
190the default value, which is now %Y-%m-%d (YYYY-MM-DD) per ISO 8601.
191
a7192a34
AA
192This release intoduces two new configuration options:
193REVERSED_RACKS_LISTSRC and NEAREST_RACKS_CHECKBOX.
194
2a943f85 195[1] http://php.net/manual/en/function.strftime.php
ef550f27 196
038739ac
AA
197*** Upgrading to 0.20.1 ***
198
65ccc533
DO
199The 0.20.0 release includes bug which breaks IP networks' capacity displaying on
20032-bit architecture machines. To fix this, this release makes use of PHP's BC
201Math module. It is a new reqiurement. Most PHP distributions have this module
202already enabled, but if yours does not - you need yo recompile PHP.
d76549bc 203
65ccc533
DO
204Security context of 'ipaddress' page now includes tags from the network
205containing an IP address. This means that you should audit your permission rules
206to check there is no unintended allows of changing IPs based on network's
207tagset. Example:
038739ac 208 allow {client network} and {New York}
65ccc533
DO
209This rule now not only allows any operation on NY client networks, but also any
210operation with IP addresses included in those networks. To fix this, you should
211change the rule this way:
038739ac
AA
212 allow {client network} and {New York} and not {$page_ipaddress}
213
9b8174d7
AD
214*** Upgrading to 0.20.0 ***
215
65ccc533
DO
216WARNING: This release have too many internal changes, some of them were waiting
217more than a year to be released. So this release is considered "BETA" and is
218recommended only to curiuos users, who agree to sacrifice the stability to the
219progress.
d1a9e5cf
AA
220
221Racks and Rows are now stored in the database as Objects. The RackObject table
222was renamed to Object. SQL views were created to ease the migration of custom
9b8174d7
AD
223reports and scripts.
224
65ccc533
DO
225New plugins engine instead of local.php file. To make your own code stored in
226local.php work, you must move the local.php file into the plugins/ directory.
227The name of this file does not matter any more. You also can store multiple
228files in that dir, separate your plugins by features, share them and try the
229plugins from other people just placing them into plugins/ dir, no more merging.
230
d1a9e5cf 231$path_to_local_php variable has no special meaning any more.
dd14756b 232$racktables_confdir variable is now used only to search for secret.php file.
65ccc533
DO
233$racktables_plugins_dir is a new overridable special variable pointing to
234 plugins/ directory.
dd14756b 235
65ccc533
DO
236Beginning with this version it is possible to delete IP prefixes, VLANs, Virtual
237services and RS pools from within theirs properties tab. So please inspect your
238permissions rules to assure there are no undesired allows for deletion of these
239objects. To ensure this, you could try this code in the beginning of permissions
240script:
d1a9e5cf
AA
241
242 allow {userid_1} and {$op_del}
243 deny {$op_del} and ({$tab_edit} or {$tab_properties})
244
65ccc533
DO
245Hardware gateways engine was rewritten in this version of RackTables. This means
246that the file gateways/deviceconfig/switch.secrets.php is not used any more. To
247get information about configuring connection properties and credentials in a new
248way please visit http://wiki.racktables.org/index.php/Gateways
d1a9e5cf 249
65ccc533
DO
250This also means that recently added features based on old API (D-Link switches
251and Linux gateway support contributed by Ilya Evseev) are not working any more
252and waiting to be forward-ported to new gateways API. Sorry for that.
d1a9e5cf
AA
253
254Two new config variables appeared in this version:
65ccc533
DO
255 - SEARCH_DOMAINS. Comma-separated list of DNS domains which are considered
256 "base" for your network. If RackTables search engine finds multiple objects
257 based on your search input, but there is only one which FQDN consists of
258 your input and one of these search domains, you will be redirected to this
259 object and other results will be discarded. Such behavior was unconditional
260 since 0.19.3, which caused many objections from users. So welcome this
261 config var.
262 - QUICK_LINK_PAGES. Comma-separated list of RackTables pages to display links
263 to them on top. Each user could have his own list.
d1a9e5cf
AA
264
265Also some of config variables have changed their default values in this version.
65ccc533
DO
266This means that upgrade script will change their values if you have them in
267previous default state. This could be inconvenient, but it is the most effective
268way to encourage users to use new features. If this behavior is not what you
269want, simply revert these variables' values:
d1a9e5cf 270 - SHOW_LAST_TAB no => yes
65ccc533
DO
271 - IPV4_TREE_SHOW_USAGE yes =>no (networks' usage is still available
272 by click)
d1a9e5cf 273 - IPV4LB_LISTSRC {$typeid_4} => false
65ccc533
DO
274 - FILTER_DEFAULT_ANDOR or => and (this implicitly enables the feature
275 of dynamic tree shrinking)
d1a9e5cf 276 - FILTER_SUGGEST_EXTRA no => yes (yes, we have extra logical filters!)
65ccc533
DO
277 - IPV4_TREE_RTR_AS_CELL yes => no (display routers as simple text, not
278 cell)
d1a9e5cf
AA
279
280Also please note that variable IPV4_TREE_RTR_AS_CELL now has third special value
65ccc533
DO
281besides 'yes' and 'no': 'none'. Use 'none' value if you are experiencing low
282performance on IP tree page. It will completely disable IP ranges scan for
283used/spare IPs and the speed of IP tree will increase radically. The price is
284you will not see the routers in IP tree at all.
7ec03062 285
86ff26ae 286*** Upgrading to 0.19.13 ***
65ccc533
DO
287A new "date" attribute type has been added. Existing date based fields ("HW
288warranty expiration", "support contract expiration" and "SW warranty
86ff26ae
DO
289expiration") will be converted to this new type but must be in the format
290"mm/dd/yyyy" otherwise the conversion will fail.
291
36efe434
DO
292*** Upgrading to 0.19.2 ***
293
65ccc533
DO
294This release is different in filesystem layout. The "gateways" directory has
295been moved from "wwwroot" directory. This improves security a bit. You can also
296separate your local settings and add-ons from the core RackTables code. To do
297that, put a single index.php file into the DocumentRoot of your http server:
4f5aea8a
AA
298
299<?php
65ccc533 300$racktables_confdir='/directory/with/secret.php/and/local.php/';
4f5aea8a
AA
301require '/directory_where_you_extracted_racktables_distro/wwwroot/index.php';
302?>
303
65ccc533
DO
304No more files are needed to be available directly over the HTTP. Full list of
305filesystem paths which could be specified in custom index.php or secret.php:
4f5aea8a 306 $racktables_gwdir: path to the gateways directory;
65ccc533
DO
307 $racktables_staticdir: path to the directory containing 'pix', 'js', 'css'
308 directories;
309 $racktables_confdir: path where secret.php and local.php are located. It is
310 not recommended to define it in secret.php, cause only
311 the path to local.php will be affected;
312 $path_to_secret_php: Ignore $racktables_confdir when locating secret.php and
313 use the specified path;
4f5aea8a 314 $path_to_local_php: idem for local.php.
36efe434 315
841a5b54 316*** Upgrading to 0.19.0 ***
6f542dde 317
65ccc533
DO
318The files, which are intended for the httpd (web-server) directory, are now in
319the "wwwroot" directory of the tar.gz archive. Files outside of that directory
320are not directly intended for httpd environment and should not be copied to the
321server.
65e557dd 322
65ccc533
DO
323This release incorporates ObjectLog functionality, which used to be available as
324a separate plugin. For the best results it is advised to disable (through
325local.php) external ObjectLog plugin permanently before the new version is
326installed. All previously accumulated ObjectLog records will be available
327through the updated standard interface.
8489d2af 328
65ccc533
DO
329RackTables is now using PHP JSON extension which is included in the PHP core
330since 5.2.0.
841a5b54 331
65ccc533
DO
332The barcode attribute was removed. The upgrade script attempts to preserve the
333data by moving it to either the 'OEM S/N 1' attribute or to a Log entry. You
334should backup your database beforehand anyway.
81659c05 335
1679ddbd
DO
336*** Upgrading to 0.18.x ***
337
65ccc533
DO
338RackTables from its version 0.18.0 and later is not compatible with RHEL/CentOS
339(at least with versions up to 5.5) Linux distributions in their default
340installation. There are yet options to work around that:
1679ddbd
DO
3411. Install RackTables on a server with a different distribution/OS.
3422. Request Linux distribution vendor to fix the bug with PCRE.
3433. Repair your RHEL/CentOS installation yourself by fixing its PCRE
65ccc533 344 RPM as explained here: http://bugs.centos.org/view.php?id=3252