added README.md

2013-01-26 19:20:45 +01:00 · 2013-01-26 19:20:45 +01:00 · cbc8bcac0f
commit cbc8bcac0f
parent e7f5cb096b
1 changed files with 109 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,109 @@
+TSM Monitor 1
+=============
+  
+== About ==
+  
+TSM monitor is a web application written in php to help TSM administrators to quickly get reports and health status information of their TSM  (IBM Tivoli Storage Manager) servers. It generates it’s content dynamically so one can easily add or modify queries to adapt the application to one’s own needs.
+  
+Features:
+  
+* customizable queries
+* dynamically generated navigation menu
+* overview page with traffic light logic
+* graphical timetable charts for queries with start and end time (like backups and schedules)
+* multiple servers
+* login protection (authentication against default tsm server)
+* result caching for better performance
+* Sorting – you can now sort query result tables by column dynamically, ascending and descending
+* Searching – queries like “show me all backups of node xyz” are now possible with dynamically modified queries through a search field
+  
+Screenshots
+-----------
+
+For Screenshots, look into /screenshots  
+  
+Documentation
+-------------
+
+=== Requirements ===
+
+* PHP5 or newer
+* Apache 2.x or newer
+* dsmadmc with all servers listed in your dsm.opt/sys. Since v0.6 you just need one SERVERNAME entry for every TSM server defined in your server.xml (Linux/Unix: dsm.sys, Windows: dsm.opt)
+
+
+
+=== Installation ===
+
+* download the newest version of TSM monitor
+* extract the package to your htdocs folder
+* chown all files to your apache/www-User
+* edit includes/server.xml
+* make your dsmerror.log file writetable to the www user!
+
+
+=== Configuration ===
+
+There is only one file that needs to be edited: includes/server.xml
+
+Enter here your server(s) like described below. The "defaultserver" is the server that will be displayed by default.
+
+  <config>
+        <serverarray>
+                <defaultserver>TSMSRV1</defaultserver>
+                <server>
+                        <servername>TSMSRV1</servername>
+                        <description>Subnet2</description>
+                        <ip>172.xx.x.xxx</ip>
+                        <port>1500</port>
+                </server>
+                <server>
+                        <servername>TSMSRV2</servername>
+                        <description>Subnet2</description>
+                        <ip>172.xx.xxx.xx</ip>
+                        <port>1500</port>
+                </server>
+        </serverarray>
+  </config>
+
+
+=== Usage ===
+
+Open your favourite browser (Firefox ;-)) and point it to http://yourserver/index.php
+
+
+=== Known Issues ===
+
+none ;)
+
+
+
+== Bugtracker ==
+
+If you find a bug or even have already a solution, please feel free to contribute it to our bugtracker over at sourceforge:
+
+[https://sourceforge.net/apps/mantisbt/tsmmonitor/my_view_page.php Mantis Bugtracker]
+
+== Download ==
+
+[[File:gplv3-127x51.png]]
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program. If not, see [http://www.gnu.org/licenses].
+
+[http://www.gnu.org/licenses/gpl-3.0.txt View the license]
+
+It is highly recommended to use TSM Monitor 1.0 for “productive” use: [http://sourceforge.net/projects/tsmmonitor/files/tsmmonitor/1.0/tsmmonitor-1.0.tar.gz/download DOWNLOAD]
+
+[https://sourceforge.net/project/showfiles.php?group_id=247878 >> Download TSM Monitor at sourceforge.net <<]
+