diff --git a/src/warden-server/doc/CHANGELOG b/src/warden-server/doc/CHANGELOG index 0b5b6725f4eb66785d24242b5dcbd1647b027fe9..0ea82762c84158f7354e3fb036d84a785f991211 100644 --- a/src/warden-server/doc/CHANGELOG +++ b/src/warden-server/doc/CHANGELOG @@ -1,3 +1,12 @@ +2012-07-20 v2.0.0 stable package +-------------------------------- +- MySQL database engine used +- Apache used to support faster multithread processing (communication switched to HTTPs protocol) +- enhanced authentization and authorization +- enhanced support of Alternate Names in SSL certificates +- added automatic reconnect to DB +- other minor bugs and issues fixed + 2012-03-02 v0.1.0 beta version ------------------------------ - initial release of the Warden server diff --git a/src/warden-server/doc/README b/src/warden-server/doc/README index 4f395dccebfcfc7d67da289b37d598825c08091c..6e9ff2e32dfb632a16b766a4e1466d99696f5488 100644 --- a/src/warden-server/doc/README +++ b/src/warden-server/doc/README @@ -1,5 +1,5 @@ +------------------------------+ -| README - Warden Server 0.1.0 | +| README - Warden Server 2.0.0 | +------------------------------+ Content @@ -23,36 +23,37 @@ A. Overall Information 2. Version - 0.1.0 (2012-03-02) + 2.0.0 (2012-07-20) 3. Package structure warden-server/ bin/ - create_tables.sh getClients.pl getStatus.pl + getWebStatus.sh registerReceiver.pl registerSender.pl unregisterClients.pl - warden-alive - wardend - warden-server.pl doc/ + AUTHORS CHANGELOG INSTALL LICENSE README + warden.mysql etc/ + package_version + warden-apache.conf warden-client.conf warden-server.conf - package_version lib/ WardenConf.pm + Warden.pm WardenReg.pm WardenStatus.pm - var/ - warden.db + Warden/ + ApacheDispatch.pm uninstall.sh -------------------------------------------------------------------------------- @@ -61,36 +62,36 @@ B. Installation Dependencies 1. Applications: Perl >= 5.10.1 - SQLite >= 3.7.3 + MySQL >= 5.1.63 + Apache >= 2.2.14 2. Perl modules: SOAP::Lite >= 0.712 - SOAP::Transport::TCP >= 0.712 - File::Pid >= 1.01 - POSIX >= 1.17 + SOAP::Transport::HTTP >= 0.712 DBI >= 1.612 - DBD::SQLite >= 1.29 + DBD::mysql >= 4.016 Format::Human::Bytes >= 0.05 Sys::Syslog >= 0.27 File::Basename >= 2.77 - FindBin >= 1.50 Net::CIDR::Lite >= 0.21 DateTime >= 0.61 Getopt::Std >= 1.06 Switch >= 2.14 - IO::Socket::SSL >= 1.33 + IO::Socket::SSL >= 1.74 + MIME::Base64 >= 3.08 + Crypt::X509 >= 0.40 -------------------------------------------------------------------------------- C. Installation 1. Check SHA1 checksum of the Warden server package archive. - $ sha1sum -c warden-server-0.1.0.tar.gz.sig + $ sha1sum -c warden-server-2.0.0.tar.gz.sig 2. Untar it. - $ tar xzvf warden-server-0.1.0.tar.gz + $ tar xzvf warden-server-2.0.0.tar.gz 3. Run install.sh. @@ -102,8 +103,9 @@ C. Installation 4. Configuration files - You are advised to check configuration file warden-server.conf and - warden-client.conf in warden-server/etc/ directory after installation. + You are advised to check configuration file warden-apache.conf, + warden-server.conf and warden-client.conf in warden-server/etc/ + directory after installation. Although this is the Warden server package it also contains several functions (for administration and maintenance) that are strictly @@ -137,35 +139,48 @@ C. Installation The Warden server configuration file contains: - ADDRESS - IP address/domain name of the Warden server - e.g. warden.server.com - - PORT - used TCP port for the Warden server - e.g. 443 - BASEDIR - base directory of the Warden server e.g. /opt/warden-server/ - VARDIR - var directory - e.g. $BASEDIR/var/ + FACILITY - syslog facility + e.g. local7 - LOGDIR - logging directory - e.g. /var/log/ - - PIDDIR - Process ID directory - e.g. /var/run/ + DB_NAME - MySQL database name of Warden server + e.g. warden - SSL_KEY_FILE - path to the server SSL certificate key file - e.g. /etc/ssl/private/warden.server.com.key + DB_USER - MySQL database user of Warden server + e.g. warden - SSL_CERT_FILE - path to the server SSL certificate file - e.g. /etc/ssl/certs/warden.server.com.pem - - SSL_CA_FILE - path to a CA certificate file - e.g. /etc/ssl/certs/tcs-ca-bundle.pem + DB_PASS - MySQL database password of Warden server + + DB_HOST - MySQL database host + e.g. localhost + + c) warden-apache.conf + + The Apache2 configuration file for Warden server + + SSLEngine on + + SSLVerifyDepth 3 + SSLVerifyClient require + SSLOptions +StdEnvVars +ExportCertData + + SSLCipherSuite ALL:!ADH:!EXPORT56:RC4+RSA:+HIGH:+MEDIUM:+LOW:+SSLv2:+EXP:+eNULL + + SSLCertificateFile <path_to_server_certificate> + SSLCertificateKeyFile <path_to_server_certificate_key> + SSLCACertificateFile <path_to_CA_certificate> + + PerlOptions +Parent + PerlSwitches -I <path_to_warden_server_libs> + + <Location /Warden> + SetHandler perl-script + PerlHandler Warden::ApacheDispatch + SSLOptions +StdEnvVars + </Location> - FACILITY - syslog facility - e.g. local7 5. Usage of install.sh @@ -196,42 +211,21 @@ D. Miscellaneous 1. Error Messages - Error messages of the server functions are sent via Syslog to log file, - default is /var/log/messages. - - During installation, until Syslog reporting is initiated, error - messages may be reported to the standard error output instead. - - 2. Init Script - - Usage: /etc/init.d/wardend [start|stop|status|restart|force-stop] - - The PID of the Warden server process is stored in - /var/run/warden-server.pl.pid. - - The lock file is placed in /var/lock/warden-server. - - To start the Warden server after rebooting, set init script - /etc/init.d/wardend to runlevels configuration system. - - 3. Nagios Integration - - Nagios check is available via Nagios plugin located in - /opt/warden-server/bin/warden-alive. + Error messages of the server functions are sent via Syslog. + Default is local7 facility. - 4. Firewall Settings + 2. Firewall Settings - Make sure that the TCP port listed in warden-server.conf ($PORT variable) + Make sure that the TCP port listed in /etc/apache2/sites-enables/default is allowed on your firewall. - 5. Privileges + 3. Privileges The Warden server runs only under root privileges. - 6. Known Issues + 4. Known Issues - Benchmarking of the Warden system showed that the system is capable of - sending/receiving about 4 events per second. + No issues are known. -------------------------------------------------------------------------------- E. Registration of Clients