WA2L/edrc:report

Package: WA2L/edrc 1.5.57
Section: General Commands (1)
Updated: 16 March 2024
Index Return to Main Contents

 

NAME

WA2L/edrc:report - THE OPERATING SYSTEM REPORT PORTAL

 

SYNOPSIS

http://server.acme.ch:9900

https://server.acme.ch:9901

edrc/lib/thttpd { start | stop | ... } report

edrc/bin/edrcinit { start | stop | ... } thttpd_report

edrc/bin/edrcinit { start | stop | ... } nginx_report

 

AVAILABILITY

WA2L/edrc

 

DESCRIPTION

The main purpose of the WA2L/edrc:report web application is to present operating system reports of one or more customers that are saved in a directory structure on the system where the application is running.

WA2L/edrc:report provides an easy to handle web interface for user administration. To point to customer report directories, create a symbolic link in the /rpt directory, to change the contents of the links displayed in the 'Links' menu, edit the file /etc/links, else no additional configuration is needed.

If you get the web server error '404; Forbidden; You do not have permission to get URL from this server' you are most likely connecting to a non-official URL of the web server. To verify this and to get the correct URL, click to the 'About' control and watch out for a red 'ensure to connect to ...' message that informs if the application is called using a wrong URL.

See application help thru the 'Help' menu in the WA2L/edrc:report web application for more information regarding application usage.

 

OPTIONS

start
start webserver.

stop
stop webserver.

report
web application name of WA2L/edrc:report.

thttpd_report
service name of WA2L/edrc:report.

 

ENVIRONMENT

-

 

EXIT STATUS

-

 

FILES

edrc/etc/thttpd.report.cfg
configuration file for the HTTP server daemon thttpd which serves the application. See also thttpd(3) for more information.

edrc/etc/nginx.report.cfg
configuration file for the HTTPS server daemon thttpd which serves the application. The thttpd_report service is a prerequisite for nginx_report. See also nginx(3) for more information.

edrc/etc/edrcinit.cfg
configuration file of the WA2L/edrc service handler. See also edrcinit(1m) for more information.

edrc/www/report/
base directory of WA2L/edrc:report.

edrc/www/report/.meta/
directory containing meta data for WA2L/edrc:report as application version and description.

edrc/www/report/.htpasswd
this file holds the user password information of the WA2L/edrc:report web application. The content of this file is maintained thru the 'User Administration' menu points in the web application together with the /etc/users file.

When installing the WA2L/edrc package the user admin has the password admin. After the installation a personal user with the role ADM (Admin) should be created (with the Users menu) and the user admin should be removed.

edrc/www/report/cgi/
directory containing all cgi scripts of WA2L/edrc:report.

edrc/www/report/css/
directory containing all cascaded style sheets of WA2L/edrc:report.

edrc/www/report/errors/
error files for the thttpd web server of WA2L/edrc:report.

edrc/www/report/etc/
configuration directory of WA2L/edrc:report.

edrc/www/report/etc/links
configuration file for the 'Links' menu point in the WA2L/edrc:report web application. This configuration file has to be edited directly by hand.

edrc/www/report/etc/users
this file holds the user information of the WA2L/edrc:report web application. The content of this file is maintained thru the 'User Administration' menu points in the web application together with the /.htpasswd file.

edrc/www/report/fonts/
directory containing all additional fonts of WA2L/edrc:report.

edrc/www/report/img/
directory containing all application images of WA2L/edrc:report.

edrc/www/report/js/
directory containing all JavaScripts of WA2L/edrc:report.

edrc/www/report/main/
directory containing the static web pages of WA2L/edrc:report.

edrc/www/report/rpt/
directory containing the symbolic links to the directories containing the operating system reports.

The structure of the target report directories must be <Customer>/<Report_Name>/<Report_File(s)>. To add a more comprehensive description of a report, use the duvi; chown edrc ..du_index command in the related <Report_Name>/ directory (use the en: section of the ..du_index file).

To display and list reports in the web application, the permissions of all directories must be drwxr-xr-x and the permissions of the report files must be -rw-r--r--.

If you run a configuration, where you serve the reports in a customer's environment to a customer, but you don't want to show all reports to him/her, you can set the permissions of the related <Report_Name> directory you want to hide to drwxr-x---, sync all reports to a central reporting portal for system administration personnel (using rsync(1) in a script started thru a cron entry) and change the permissions on your central back to drwxr-xr-x (in the same script).

Example report file structure on a central report portal:

  [ /opt/edrc/var/www/report/rpt ]
  [ root@fc17mzv7t0.acme.ch ][*eshell*/bash]: ll
  lrwxrwxrwx.  1 root edrc   11 Jan 12  2012 001 -> /dat/report_USA/
  lrwxrwxrwx.  1 root edrc   16 Jan 12  2012 002 -> /dat/report_Switzerland/
  lrwxrwxrwx.  1 root edrc   10 Jan 12  2012 003 -> /dat/report_CostaRica/
  lrwxrwxrwx.  1 root edrc   10 Jan 12  2012 004 -> /dat/report_NewZealand/
  -rw-r--r--.  1 root edrc  935 Sep  1  2010 index.html

  [ /opt/edrc/var/www/report/rpt/001 ]
  [ root@fc17mzv7t0.acme.ch ][*eshell*/bash]: ll
  drwxr-xr-x. 2 root root 4096 Dec  2 14:00 RedrockQuarry/
  drwxr-xr-x. 2 root root 4096 Dec  9 16:40 PureWater/
  drwxr-xr-x. 2 root root 4096 Dec  2 15:44 SimpleFurniture/
  drwxr-xr-x. 5 root root 4096 Nov  4 14:38 WA2L/
  drwxr-xr-x. 2 root root 4096 Dec  8 12:54 Xenon/

  [ /opt/edrc/var/www/report/rpt/001/RedrockQuarry ]
  [ root@fc17mzv7t0.acme.ch ][*eshell*/bash]: ll
  drwxr-xr-x. 3 root root 4096 Dec  2 15:35 cfg2html/
  drwxr-xr-x. 3 root root 4096 Nov 18 17:04 fssum/
  drwxr-xr-x. 2 root root 4096 Nov  3 00:40 lots/
  drwxr-xr-x. 3 root root 4096 Nov 16 19:04 performancegraph/

  [ /opt/edrc/var/www/report/rpt/001/RedrockQuarry/cfg2html ]
  [ root@fc17mzv7t0.acme.ch ][*eshell*/bash]: ll
  drwxr-xr-x. 2 root root 4096 Nov  3 00:50 20121103/
  drwxr-xr-x. 2 root root 4096 Nov  4 00:54 20121104/
  drwxr-xr-x. 2 root root 4096 Nov  5 00:52 20121105/
  -rw-r-----. 1 edrc root  126 Dec  2 15:35 ..du_index

  [ /opt/edrc/var/www/report/rpt/001/RedrockQuarry/cfg2html/20121103 ]
  [ root@fc17mzv7t0.acme.ch ][*eshell*/bash]: ll
  -rw-r--r--. 1 root root   8983 Nov  3 00:35 pepples.redrock.com.err
  -rw-r--r--. 1 root root 481265 Nov  3 00:35 pepples.redrock.com.html
  -rw-r--r--. 1 root root    259 Nov  3 00:35 pepples.redrock.com.partitions.save
  -rw-r--r--. 1 root root 448872 Nov  3 00:35 pepples.redrock.com.txt
  -rw-r--r--. 1 root root   8900 Nov  3 00:40 boulder.redrock.com.err
  -rw-r--r--. 1 root root 486465 Nov  3 00:40 boulder.redrock.com.html
  -rw-r--r--. 1 root root    200 Nov  3 00:40 boulder.redrock.com.partitions.save
  -rw-r--r--. 1 root root 446852 Nov  3 00:40 boulder.redrock.com.txt

Example report file structure in the RedrockQuarry environment, where you want to hide the cfg2html reports from the customer's eyes but show all other reports:

  [ /opt/edrc/var/www/report/rpt ]
  [ root@sand.redrock.com ][*eshell*/bash]: ll
  lrwxrwxrwx.  1 root edrc   11 Jan 12  2012 001 -> /dat/report/
  -rw-r--r--.  1 root edrc  935 Sep  1  2010 index.html

  [ /opt/edrc/var/www/report/rpt/001/RedrockQuarry ]
  [ root@sand.redrock.com ][*eshell*/bash]: ll
  drwxr-x---. 3 root root 4096 Dec  2 15:35 cfg2html/
  drwxr-xr-x. 3 root root 4096 Nov 18 17:04 fssum/
  drwxr-xr-x. 2 root root 4096 Nov  3 00:40 lots/
  drwxr-xr-x. 3 root root 4096 Nov 16 19:04 performancegraph/

edrc/www/report/tmp/
directory for temporary files generated by a cgi script. This directory is currently not used.

edrc/www/report/var/
directory containing additional static web content.

edrc/www/report/var/logos/
directory containing the factory logos of customers. The logo must have the name as returned by the server_environment -C command in the customer's environment and the file suffix .png, .jpg, .jpeg or .gif.

edrc/www/report/var/mylogos/
directory containing your own factory logos of customers. Files in this directory have preference over the files in edrc/www/report/var/logos/ Files in this directory are not touched by WA2L/edrc patch updates. The logo must have the name as returned by the server_environment -C command in the customer's environment and the file suffix .png, .jpg, .jpeg or .gif.

 

EXAMPLES

1) port setting in webserver config file edrc/etc/thttpd.report.cfg of WA2L/edrc:report:

#
# thttpd.report.cfg - config file for thttpd of application 'report'
#
# [00] 07.09.2007 CWa  Initial Version
#
:
port=9900
:

2) service definition of WA2L/edrc:report in edrc/etc/edrcinit.cfg:

#
# etc/edrcinit.cfg - configuration file for edrcinit
#
# [00] 26.05.2009 CWa  Initial Version
#
:
#
# Format:
#
#  <sequence>;<activated>;<guarded>;<name>;<description>;<handler>;<handleroptions>;
#
:
150;Y;Y;thttpd_report;tiny HTTP server (WA2L/edrc:report);WA2Ledrc.thttpd;report;
:

 

SEE ALSO

duvi(1), du_index(4), edrcinit(1m), edrcinit.cfg(3), edrcintro(1), nginx(3), nginx.report.cfg(3), thttpd(3), thttpd.report.cfg(3)

 

NOTES

The web application is served using thttpd, because it is a fast, small, secure and simple HTTP server that is available and compilable on many operating systems without problems and therefore predestined for a multi platform framework as WA2L/edrc. See thttpd(3) and http://www.acme.com/software/thttpd for more information.

 

BUGS

-

 

AUTHOR

WA2L/edrc:report was developed by Christian Walther. Send suggestions and bug reports to wa2l@users.sourceforge.net . 

 

COPYRIGHT

Copyright © 2021 Christian Walther

This is free software; see edrc/doc/COPYING for copying conditions. There is ABSOLUTELY NO WARRANTY; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.


 

Index

NAME
SYNOPSIS
AVAILABILITY
DESCRIPTION
OPTIONS
ENVIRONMENT
EXIT STATUS
FILES
EXAMPLES
SEE ALSO
NOTES
BUGS
AUTHOR
COPYRIGHT

This document was created by man2html using the manual pages.
Time: 00:14:34 GMT, March 08, 2025