New version 0.4.0 of the reports plugin
[racktables-contribs] / reports / README.md
1 # racktables-reports
2
3 This is an additional plugin for RackTables, that creates Custom Reports Tabs right in the Reports page. It's based on the work of
4
5 Sebastian Mogilowski <sebastian@mogilowski.net> (Website and HowTo: http://www.mogilowski.net/projects/racktables )
6
7 The original plugin was rewritten to follow the new [plugin standards](https://wiki.racktables.org/index.php/Plugins) for RackTables.
8
9 ## Other changes for version 0.4.0:
10 * Unify Server, Switch and Virtual Machine Reports (maintaining only one function for all)
11 * allow users to customize the path to the CSS and JS files via config variables ('Configuration' => 'User interface')
12 * always show: Name, MAC(s), IPv4 and IPv6 addresses, comment and contact information
13 * additionally show:
14 * Type, asset no., location, OEM S/N, HW expire date and OS for servers
15 * Type, asset no., location, OEM S/N, HW expire date and OS version for switches
16 * OS and Hypervisor (container) for virtual machines
17 * show MAC addresses also for switches (configurable via config variable 'REPORTS_SHOW_MAC_FOR_SWITCHES')
18 * enhance CSV filename with the short form of the export (server,switches,vm or custom => export_server_$date.csv)
19 * create 'mailto' links, if the contact is an Email address
20
21 ## INSTALL
22
23 1) Copy the files in the /reports/ folder to your RackTables plugins installation ( _/path/to/racktables/plugins/_ ).
24
25 2) Copy the CSS and JS and image files to the corresponding folders:
26 ```
27 mkdir -p '/path/to/racktables/wwwroot/{css,js,pix}/report/'
28 cp -v 'css/style.css' '/path/to/racktables/wwwroot/css/report/style.css'
29 cp -v "js/*" '/path/to/racktables/wwwroot/js/report/'
30 cp -v "pix/*" '/path/to/racktables/wwwroot/pix/report/'
31 ```
32
33 3) Activate the plugin via the _Configuration_ => _Plugins_ menu.
34
35 4) Depending on where you copied the CSS and JS files in step 2, you might want to adjust the configuration variables in _'Configuration'_ => _'User interface'_:
36 ```
37 REPORTS_CSS_PATH => defaults to 'css/report' (NO trailing slashes)
38 REPORTS_JS_PATH => defaults to 'js/report' (NO trailing slashes)
39 ```
40
41 5) You might also want to enable/disable the MAC(s) column for your switch report via _'Configuration'_ => _'User interface'_:
42 ```
43 REPORTS_SHOW_MAC_FOR_SWITCHES => defaults to 'yes'
44 ```
45
46 ## USAGE
47
48 Login into RackTables and go to "Reports".
49
50 Now you find "Custom", "Server", "Switches" and "Virtual machines" in the report menu.
51
52 Sort multiple columns simultaneously by holding down the shift key and clicking a second, third or even fourth column header!
53
54 Save your custom report by supplying a name in the "Save:" field and click on the "Ok" button. Restoring your custom report criteria: simply click on the link in the form with the name you provided.
55