INSTALLATION AND CONFIGURATION GUIDE

Transcription

1 INSTALLATION AND CONFIGURATION GUIDE Webwasher Content Reporter Version

2 Part Number: B All Rights Reserved, Published and Printed in Germany 2007 Secure Computing Corporation. This document may not, in whole or in part, be copied, photocopied, reproduced, translated, or reduced to any electronic medium or machine-readable form without prior consent in writing from Secure Computing Corporation. Every effort has been made to ensure the accuracy of this manual. However, Secure Computing Corporation makes no warranties with respect to this documentation and disclaims any implied warranties of merchantability and fitness for a particular purpose. Secure Computing Corporation shall not be liable for any error or for incidental or consequential damages in connection with the furnishing, performance, or use of this manual or the examples herein. The information in this document is subject to change without notice. Webwasher, MethodMix, AV PreScan, Live Reporting, Content Reporter, Real-Time Classifier are all trademarks or registered trademarks of Secure Computing Corporation in Germany and/or other countries. This product includes software developed by the Apache Software Foundation < Microsoft, Windows NT, Windows 2000 are registered trademarks of Microsoft Corporation in the United States and/or other countries. McAfee is a business unit of Network Associates, Inc. CheckPoint, OPSEC, and FireWall-1 are trademarks or registered trademarks of CheckPoint Software Technologies Ltd. or its affiliates. Sun and Solaris are trademarks or registered trademarks of Sun Microsystems, Inc. in the United States and other countries. Squid is copyrighted by the University of California, San Diego. Squid uses some code developed by others. Squid is Free Software, licensed under the terms of the GNU General Public License. NetCache is a registered trademark of Network Appliances, Inc. in the United States and other countries. Linux is a registered trademark of Linus Torvalds. The installer is created with EPM by Easy Software Products. EPM is licensed under the GNU General Public License. Other product names mentioned in this guide may be trademarks or registered trademarks of their respective companies and are the sole property of their respective manufacturers. Secure Computing Corporation Webwasher A Secure Computing Brand Vattmannstrasse 3, Paderborn, Germany Phone: Fax: info@webwasher.com European Hotline Phone: +49 (0) US Hotline Phone: ,

3 Contents Chapter 1 Introduction Target Group Special Conventions Chapter 2 Installing Content Reporter Planning the Installation Minimum System Requirements Further Requirements Guidelines Disk Space Requirements Installing Content Reporter on Windows Installation Steps Licensing Procedure Setting up the Database Logging in Uninstalling Content Reporter on Windows Uninstalling MaxDB Uninstalling Content Reporter Repairing/Upgrading Content Reporter on Windows Installing Content Reporter on Linux or Solaris Prerequisites for the MaxDB Database Linux Prerequisites for the MaxDB Database Solaris Prerequisites for the MS SQL Server Installation Steps Starting and Stopping the Content Reporter Server Configuration Uninstalling Content Reporter on Linux or Solaris Repairing/Upgrading Content Reporter on Linux or Solaris Chapter 3 Initial Configuration Tasks First Login Installing the Java Runtime Environment The Embedded Database The DB Admin Tab With MaxDB Settings List of MaxDB Database Settings Configuring Your Enterprise Database Configuring an MS SQL Database Configuring an Oracle Database Configuring Multiple Content Reporter Servers When to Use Multiple Content Reporter Servers Software Upgrades Using Multiple Content Reporter Servers Chapter 4 Navigating the Content Reporter User Interface i

4 Installation and Configuration Guide 4.1 Content Reporter Home Page Administration Page Administration Button Manual Import Button License Information Button Exec SQL Button Log Sources Tab Browse Time Tab URL Categorization Tab Billing Tab Authentication Tab User Groups Tab Group Reporting Tab DB Admin Tab Rollup Tab Notifications Tab Logging Tab Performance Tab Mapped Columns Tab Query Definitions Page Report Definitions Page Scheduler and Events Page Details Tab Schedule Tab Access Control Tab Checking Event Results Report Results Page Chapter 5 Configuring Log Sources and Files Step One: Defining A Log Source Group Where You Access Log Source Group Information The Log Sources Tab Log Source Group Information You Can Define Definition Steps Step Two: Adding Log Sources To The Log Source Group Rules For Adding Log Sources The Auto Discovery Windows Log Source Properties Adding a Log Source to Collect From a Directory Adding a Log Source To Collect From A Network Appliance NetCache Adding a Log Source to Collect From an FTP Server Adding a Log Source to Collect From a Webwasher Server Adding a Log Source to Collect From a Cisco Content Engine Excluding Log File Content Step Three: Scheduling Log File Collection Scheduling Log File Collection and Processing Progress Indication Examining Information About Scheduler and Events Modifying Log Source Groups and Log Sources Modifying a Log Source Group Deleting a Log Source Group Modifying a Log Source s Settings Removing a Log Source From a Log Source Group Importing Saved Log Files Import Log Files Page Components ii

5 Contents Importing Log Files Chapter 6 Setting Access Control Learning About Authentication, Permissions, and Security Authentication in Content Reporter Page Permissions in Content Reporter Web Site Name Restrictions Security in Content Reporter Configuring LDAP and NTLM Authentication Configuring Content Reporter for LDAP Authentication Configuring Content Reporter for NTLM Authentication Adding User Groups and Setting User Group Permissions Adding a New LDAP or NTLM User Group and Configuring Its Permissions Adding Local Users and Setting Local User Permissions Adding a Local User and Setting the User s Permissions Modifying User and User Group Permissions Modifying a User Group s Permissions Deleting an LDAP or NTLM User Group Modifying a Local User s Information and Permissions Deleting a Local User Chapter 7 Additional Configuration Configuring Content Reporter Server Logging The Logging Tab Logging Levels Logging Level Descriptions Configuring Content Reporter Server Logging Examining the Content Reporter Server Log File Configuring Database Rollups How Database Rollups Work Configuring Database Rollups Configuring Database Rollups with Multiple Content Reporter Instances Configuring Billing Aggregation The Report Definitions Style Tab Billing Report Characteristics Billing Aggregation Example The Relationship Between Billing Tab Settings and Available Billing Query Statistics The Billing Tab The Query Definition Tab Configuring Billing Aggregation Adding Logo Images to Content Reporter for HTML Reports Adding Logo Images Configuring Database Backups How Database Backups Work The DB Backup Tab Recovering a Content Reporter Database Chapter 8 Performance Tuning General Procedure Import Tuning Import Stages Tuning Measures and Their Effects iii

6 Installation and Configuration Guide The Parsing Process Measurement Tuning Measures Report Tuning Things to Avoid When Defining Queries and Reports Some Hints on Database Tuning Special Measures Hash Partitioning on ag_url Table Range Partitioning on Master Tables Appendix A Quick Start Instructions... A 1 A.1 Quick Start: Setting Up Log File Collection... A 1 A.1.1 Defining a Log Source Group and Processing Its Log Files... A 1 A.2 Quick Start: Adding a Local User and Setting the User s Permissions... A 3 Appendix B Assigning a Login to Content Reporter Service... B 1 B.1 The Login User Account... B 1 B.1.1 Account Requirements... B 1 B.2 Configuring a Windows NT System... B 2 B.3 Configuring a Windows 2000 System... B 2 Appendix C Configuring NetCaches for Content Reporter... C 1 C.1 Enabling NetCache Appliance Web Access Logging... C 1 C.2 Enabling NetCache Appliance Streaming Access Logging... C 2 C.3 Configuring a NetCache Appliance for URL Categorization Database Reports... C 2 C.3.1 URL Categorization Database Query Columns... C 3 C.3.2 Configuring a NetCache for URL Categorization Database Reports... C 3 C.4 Configuring NetCache Appliance Log File Collection... C 3 C.4.1 Gathering NetCache Appliance Information... C 4 C.4.2 Enabling SNMP and Using Auto Discovery... C 7 Glossary... GL 1 iv

7 Introduction Chapter 1 WelcometotheWebwasher Content Reporter Installation and Configuration Guide. This guide provides the information you need to install and configure Content Reporter: It describes the installation and initial configuration steps, see Chapters 2 and 3. It explains the meaning and usage of the features that can be accessed over the user interface, see Chapter 4. It tells you how to configure your log sources and files, as well as access control and a number of additional settings that are useful when running Content Reporter, see Chapters 5, 6 and 7. After installing and configuring Content Reporter and setting up log file collection and processing, you can create and generate reports based on log files imported from the previously configured log sources. Furthermore, this guide provides you with information on performance tuning, see Chapter 8. See the Webwasher Content Reporter User s Guide for Reporting for instructions on creating, scheduling, and generating reports on caching appliances, proxy servers, Web servers, and streaming media servers. 1.1 Target Group This guide has been written for system administrators and others who will install, configure, and use Content Reporter to collect and process log files with an enterprise database. It assumes you are familiar with your operating system, database, network, caches, proxies and servers. 1 1

8 Introduction This guide does not cover basic system or network administration topics, nor installation of your enterprise database software. 1.2 Special Conventions This guide refers to Webwasher servers, NetCaches, Content Engines, and all other types of proxies or log file sources as Log Sources. This guide contains special messages that are described as follows: Note: A note contains important information that helps you install or operate the system efficiently. CAUTION! A caution contains instructions that you must follow to avoid loss of data. 1 2

9 Chapter 2 Installing Content Reporter This chapter gives you the information you need to install, uninstall, and repair the Content Reporter server. 2.1 Planning the Installation The Content Reporter application enables you to analyze content usage, performance, and infrastructure load across your entire content delivery network. The Content Reporter server collects and processes log files from Webwasher servers, NetCache appliances, Content Engines, directories, and FTP servers throughout a network, and imports the results of the log file processing to your enterprise database. You log into Content Reporter with a Web browser (the Content Reporter user interface) on your network, and schedule and generate customized reports on the log file data in your database. The following table describes the major components of Content Reporter. Component Content Reporter Server Content Reporter Web-based user interface Description The Content Reporter server is the program that receives and fulfills HTTP requests from client browsers on the same or other computers. The computer on which you install Content Reporter is the Content Reporter server machine. The Content Reporter user interface is a Web browser with HTTP access to the Content Reporter server. You make requests to, and receive fulfilled requests from, the Content Reporter server through a Web browser. 2 1

10 Installing Content Reporter Database Log Source Your enterprise database is a crucial part of the Content Reporter application. The Content Reporter server stores its settings and all aggregated log file records for each Log Source in the database. All reports in Content Reporter are based on the records for each Log Source in the database. In Content Reporter, a Log Source represents a particular device that generates the log files that the Content Reporter server collects and processes. Content Reporter can collect and process Webwasher server log files, NetCache appliance log files, Content Engine log files, Web server log files, and streaming server log files. The following diagram illustrates the major components of Content Reporter. 2 2

11 Installing Content Reporter 2.2 Minimum System Requirements The following table lists the minimum system requirements for a Content Reporter configuration. To learn more about specific sizing requirements and recommendations for your environment, contact Webwasher support at cr-support@webwasher.com. Compo- Minimum Minimum Minimum nent Requirements on Windows Requirements on Solaris Requirements on x86 Linux 1 System for the Content Reporter Server Please refer to the sizing guide (available from your sales rep) 2 Operating System Platforms Windows 2000 (Server, Advanced Solaris 2.8 and 2.9 (64 bit version required for Suse Linux Enterprise Server 9 (32 bit only) Server) MaxDB) Red Hat Windows 2003 (Server and Enterprise Linux 4 (32 bit only) Enterprise Edition) 3 Supported Databases Oracle 8.1.7, Oracle 9i, Oracle 10g Microsoft SQL Server 2000 and 2005 MaxDB 7.5 (packaged) Oracle 8.1.7, Oracle 9i, Oracle 10g Microsoft SQL Server 2000 and 2005 (via Free TDS) MaxDB 7.5 (packaged) 4 Supported Log Sources Webwasher Server (version 4.1 or later) Cisco ContentEngine (ACNS 4.2 or later) NetCache appliance (NetCache 5.x or later) Various proxies (see "Supported Log Formats" below) Streaming server (Realserver, Windows Media Server) 2 3

12 Installing Content Reporter Compo- Minimum Minimum Minimum nent Requirements on Windows Requirements on Solaris Requirements on x86 Linux 5 Supported Log Formats HTTP: Web Access, Common, Netscape Extended, Squid, Web Access Custom, W3C, Webwasher Streaming: Streaming Access, Custom, Real, WMS, QuickTime Firewall: CyberGuard TSP Applicance Audit Log Files 6 Content Reporter User Interface Internet Explorer >= 5.0, Netscape >= 6.0, Mozilla >= 1.0 or Firefox >= 1.0 Java2Runtime Environment 1.4 (included) Plug-in enabled (Internet Explorer Security Settings: Enable Run ActiveX controls and plug-ins ) Cookies, JavaScript and Java Applet enabled Browser set to check for new content each visit to a stored page Not available (not supported). Please use Windows machine for Content Reporter user interface. 2 4

13 Installing Content Reporter 2.3 Further Requirements When installing Content Reporter, you will have to follow some guidelines. Furthermore, you must ensure that the space requirements for the installation are met Guidelines Follow these guidelines when installing Content Reporter: The user who installs Content Reporter must have administrator root privileges on the machine in order for the installation program to make the necessary system changes. Otherwise, Content Reporter does not function properly. If you are setting up a multiple Content Reporter server environment, see Configuring Multiple Content Reporter Servers (3.5). If you want to access network resources, you can assign a login user account to the Content Reporter service. See Assigning a Login to Content Reporter Service (Appendix B). For an installation under Solaris, the installer is created with EPM by Easy Software Products. EPM is licensed under the GNU General Public License Disk Space Requirements The Content Reporter server installation has the following disk space requirements: 130 MB of space during the installation on the drive with the Temp directory for temporary installation files 130 MB of space on the drive with the operating system for the permanent InstallShield information files 220 MB of space on the drive on which you install the Content Reporter server 4 to 9 times the space of the daily log file volume. If you do not have figures for this volume yet, you can estimate it at 1 GB for every 10,000 users per day. The factor varies, depending on whether you plan to conduct an exact access tracing or not. 2 5

14 Installing Content Reporter If you are using MaxDB, you need additional space on the drive where the database files are to reside. The database size minimum for MaxDB is 10 GB. Note: This drive should not be physically the same as the one that Content Reporter has been installed on. 2.4 Installing Content Reporter on Windows The process of installing Content Reporter on Windows consists of a number of steps, see After completing these, you continue with the licensing procedure, see 2.4.2, and the setting up of the database, see At the end, you can log into Content Reporter and start using it, see Installation Steps To install Content Reporter on Windows, complete the following steps: 1. Ensure that your configuration meets the minimum requirements. 2. Log into the system with a user account that has administrator privileges. 3. From the Windows interface, click Start > Settings > Control Panel. 4. Double-click Add/Remove Programs. 5. Click Add New Programs. 6. Click CD or Floppy, then click Next. 7. Click Browse, and browse to and select the ContentReporter.exe file, then click Open. 8. In the Run Installation Program window, click Finish. 2 6

15 Installing Content Reporter 9. In the Welcome window of the InstallShield wizard, click Next : The InstallShield wizard extracts the files needed to install Content Reporter: 2 7

16 Installing Content Reporter The wizard is then preparing to guide you through the rest of the installation procedure: Finally, another Welcome window appears. 10. In this Welcome window, click Next : 2 8

17 Installing Content Reporter 11. Read the license agreement carefully, and click Yes if you wish to accept it: 12. In the Customer Information window, enter your user name and your company name, and then click Next: 2 9

18 Installing Content Reporter 13. In the Choose Destination Location window, accept the default location or select a different location by clicking Browse, and then click Next : 14. In the Select Program Folder window, accept the default name of the program folder, enter a new name in the Program Folders field, or select an existing name from the Existing Folders list, and then click Next : 2 10

19 Installing Content Reporter 15. Review the settings in the Start Copying Files window, clicking Back to change any of them, and then click Next : The InstallShield wizard now installs Content Reporter: When the installation is almost complete, the Content Reporter service ( Content Reporter ) begins initializing, and the Setup Almost Complete window appears. 2 11

20 Installing Content Reporter 16. In this window, select the Readme checkbox, if you would like to have the corresponding information displayed. Then click Finish to exit the installation program: 2 12

21 Installing Content Reporter 17. The installation is now complete, and the Content Reporter server is running. If you have selected the corresponding checkbox, the Release Notes will appear in your browser: The program now connects to the Content Reporter server to present a configuration wizard in your browser. This wizard will guide you through the licensing procedure and the setting up of the database: 2 13

22 Installing Content Reporter Licensing Procedure The configuration wizard that has been evoked at the end of the installation steps will guide you through the licensing procedure. 1. First, a Standard Terms and Conditions window is displayed. If you want to accept these terms, check the Accepting Terms checkbox, then click Next. To view these terms, click on the highlighted terms phrase included within the text: 2 14

23 Installing Content Reporter 2. In the Choose Location window, select the location of your license file, e. g. the local file system, then click Next : 3. In the Choose License File window, browse to your license file, e. g. license.txt, then click Next : 2 15

24 Installing Content Reporter 4. The license information is displayed. Click Next to import the license file, or click Back to select a different file: By importing the license file, you have completed the licensing procedure. 2 16

25 Installing Content Reporter Setting up the Database After the licensing information has been provided, the configuration wizard continues with the database setup. Depending on the license provided, you have the option to configure the embedded MaxDB software or to set up Content Reporter to use an external database (Microsoft SQL Server or Oracle). 1. Read the information in the window announcing the setting up of the database, then click Next : 2 17

26 Installing Content Reporter 2. If you have already installed instances of MaxDB or SAPDB on the Content Reporter server, uninstall them first, then click Next : 3. In the Choose Database Path window, browse to the directory where you want to install the data files for the Content Reporter database, then click Next : 2 18

27 Installing Content Reporter 4. In the Choose Memory and Disk Space Settings window, accept the default settings, or enter different settings, then click Next. For an estimate on the amount of disk space needed to store your Content Reporter database please refer to the Content Reporter Sizing Guide. 5. The database is now installed and configured on the Content Reporter server machine: Depending on the parameters that you have provided and the speed of your hardware, this process may take a couple of minutes. 2 19

28 Installing Content Reporter 6. When installation and configuration are complete, Content Reporter is ready for use. The default password for the initial admin user is disclosed to you. Click Next : Content Reporter now performs several tasks required to initialize the database connection. During this process, corresponding messages are displayed: When the initialization is completed, Content Reporter is ready for login. 2 20

29 Installing Content Reporter Logging in After setting up and initializing the database, a login window is displayed. 1. Enter your username and a password, and click Login : Note that alphabetic characters contained in these credentials are interpreted in a case-insensitive manner by Content Reporter. This means that you could enter, e. g. bob smith or Bob Smith asausernamewith the same result. 2. If your login was successful, you can start using Content Reporter. After a grace period of 30 days has expired, you are also asked to register the database, e. g. the MaxDB database. You should register the database if you are going to use it permanently, and not just for a limited period of evaluation. There are several registration methods. Select one of them, or select the option to register at a later date, and then click Next : 2 21

30 Installing Content Reporter 3. If the registration has been successful, this is indicated to you by a further window. Click Next : 4. After this last part of the installation procedure, the Content Reporter Home page appears: For more information about this page, see

31 Installing Content Reporter 2.5 Uninstalling Content Reporter on Windows When Content Reporter is to be uninstalled, the MaxDB database must be uninstalled before Uninstalling MaxDB To uninstall the MaxDB database, use the uninstall_maxdb.cmd script delivered with the database files. It is located in the Content Reporter folder after the installation, e. g. in Program Files\Webwasher\ContentReporter. 1. Double-click uninstall_maxdb.cmd. 2. Enter y ( yes ) to confirm the uninstallation. The uninstall script then begins to uninstall MaxDB. 3. When the uninstallation procedure has been completed, MaxDB uninstall finished is displayed: You have now successfully uninstalled the MaxDB database Uninstalling Content Reporter 1. From the Windows user interface, click Start > Settings > Control Panel. 2. Double-click Add/Remove Programs. 3. Select Webwasher Content Reporter from the list of installed programs, and click Change/Remove. 2 23

32 Installing Content Reporter The setup program is now preparing to uninstall Content Reporter: 4. In the Maintenance Program welcome screen, select Remove, and click Next : 5. Confirm that you want to uninstall Content Reporter by clicking OK : 2 24

33 Installing Content Reporter The maintenance program now stops all services: Then it begins to remove the Content Reporter files: 2 25

34 Installing Content Reporter 6. When the maintenance program has performed the remove operation, click Finish to complete the uninstallation process: 2.6 Repairing/Upgrading Content Reporter on Windows If you accidently delete a Content Reporter program file, you can repair the Content Reporter installation. Repairing Content Reporter does not repair a partially uninstalled copy of Content Reporter, nor restore enterprise database settings. To repair a Content Reporter installation, complete the following steps. 1. From the Windows user interface, click Start > Settings > Control Panel. 2. Double-click the Add/Remove Programs icon. 3. Select Webwasher Content Reporter from the list of installed programs, and click Change/Remove. 4. Select the Repair/Upgrade button, and click Next. The InstallShield Wizard repairs your Content Reporter installation. 5. Click Finish to complete the repair process. 2 26

35 Installing Content Reporter 2.7 Installing Content Reporter on Linux or Solaris The procedure for installing Content Reporter on a Linux or Solaris operating system is nearly the same. The description given in the upcoming sections therefore applies to both systems, unless stated otherwise. Note that the following Linux versions are supported by Content Reporter: SUSE Linux Enterprise 9 or a later version Red Hat Enterprise 4 or a later version Content Reporter comes with an easy-to-use installer. By default, it installs almost all necessary components in /opt/contentreporter. The script that is required to uninstall Content Reporter is by default stored in /etc/software for Linux, i. e. for both SUSE and Red Hat, and for Solaris. Its name is ContentReporter.remove. During the installation, the installer creates symbolic links in your system s startup directories, e. g. /etc/init.d. After a successful installation, Content Reporter is started automatically. Note: When installing on SUSE, do not use the default ReiserFS on the file system that holds the database files since this will degrade performance significantly (especially with MaxDB) Prerequisites for the MaxDB Database Linux This section is intended only for those who are installing Content Reporter on Linux. You can install and use Content Reporter based on the MaxDB database delivered with it. If you plan to do so, you should make sure the packages mentioned below are already installed on your Linux machine. For SUSE Linux Enterprise, please install compat-libstdc++, at least version A full SUSE installation will already include this package. For Redhat Enterprise 4, please make sure the Legacy Software Development package is installed, using the Package Management System. 2 27

36 Installing Content Reporter Prerequisites for the MaxDB Database Solaris This section is intended only for those who are installing Content Reporter on Solaris. You can install and use Content Reporter based on the MaxDB database delivered with it. If you plan to do so, you should make sure that the following kernel parameters are applied before you start the installation. Note that the values given below are the minimal values needed if parameters are already set to higher values, no change is required. These kernel parameters can be checked and changed in the /etc/system file. If you have edited this file to change any of these parameters, the machine must be rebooted to activate the changes. By default, none of these parameters is set in a Solaris environment, therefore, you should just add the lines below to your /etc/system file: set shmsys:shminfo_shmmax= set shmsys:shminfo_shmmin=1 set shmsys:shminfo_shmmni=100 set shmsys:shminfo_shmseg=256 set semsys:seminfo_semmns=2000 set semsys:seminfo_semmsl=1000 set semsys:seminfo_semmni=100 set semsys:seminfo_semopm=100 set semsys:seminfo_semvmx= Prerequisites for the MS SQL Server If you want to use MS SQL Server as backend database on a Linux or Solaris system, you need to install freetds on your system prior to the Content Reporter installation. Note that after installing this software, no separate configuration activities are needed for it. The preferred way to install freetds is to get a stable source distribution from:

37 Installing Content Reporter Compile the software and install it on your system. For installation instructions, see the documentation that is provided with the source distribution. There is a file named INSTALL in the root directory. Alternatively, you can use a binary distribution, which we provide for download via our Extranet and Resource Center: Install the software in the following way: 1. Go to the directory where you want to install freetds, e.g./opt. 2. Unpack the archive, using the following gzip command: gzip-dc<tarname> tarxf-. 3. Enter the installation root as database home in the config configuration file of Content Reporter. With the sample directory mentioned above, /opt/freetds-0.63-bin. the entry would be When configuring the SQL Server database connection in Content Reporter, you need to set the database home to the directory that contains the bin, lib and other directories from the freetds package (for the default installation this is /usr/local). Content Reporter then will search for <home>/bin/freepc Installation Steps Follow these steps to install Content Reporter on Linux or Solaris: 1. Locate the archive file in order to install the Content Reporter server: ContentReporter-<Version>.tar.gz In the above line, <Version> is a place holder for the actual version number the complete file name will be similar to: ContentReporter linux.tar.gz or ContentReporter solaris.tar.gz 2. Unpack the Content Reporter archive to your working directory with the following script: gunzip -c ContentReporter-<Version>.tar.gz tar xvf

38 Installing Content Reporter 3. You should now have the following six files in your current directory: Content.Reporter.install Content.Reporter.license Content.Reporter.readme Content.Reporter.remove Content Reporter.ss Content Reporter.sw 4. Run the install script from your current directory as root./contentreporter.install Please answer the questions about the installation and license agreement. Following this there is a series of configuration questions about user and group. Simply press <RETURN> to accept the default values. 5. The installation is now complete, and the Content Reporter server is running Starting and Stopping the Content Reporter Server Content Reporter is automatically started when the system is booted. The start and stop scripts are installed in /etc/software/init.d/webwasher-cr. You can run the script with one of the parameters start or stop. Note: If you perform a restart of the Content Report server, the report and import jobs running at this time will also be restarted Configuration The Content Reporter application can be accessed using a Web browser on port 7777 the following URL will allow you to access Content Reporter: host>:7777/contentreporter. Please replace <CR host> by the name of the machine where you installed the Content Reporter software. For a freshly installed version, Content Reporter will guide you through the licensing and installation wizard to configure your license, database settings and some performance parameters. 2 30

39 Installing Content Reporter 2.8 Uninstalling Content Reporter on Linux or Solaris When Content Reporter is to be uninstalled, the MaxDB database must be uninstalled.before. To uninstall the MaxDB database, execute the uninstall_maxdb.sh script delivered with the database files. It is located in the Content Reporter folder after the installation, e, g, in /opt/contentreporter. To uninstall Content Reporter, execute the /etc/software/contentreporter.remove script for Linux or Solaris and follow the on-screen instructions. 2.9 Repairing/Upgrading Content Reporter on Linux or Solaris Follow the above installation routine and enter the location of the current Content Reporter software. /opt/contentreporter is the default location. Repairing Content Reporter does not repair a partially uninstalled copy of Content Reporter, nor does it restore enterprise database settings. 2 31

40

41 Chapter 3 Initial Configuration Tasks This chapter gives you the information you need to complete initial configuration tasks in Content Reporter. 3.1 First Login To log into Content Reporter the first time, complete the following steps. 1. If you are logging in from the Content Reporter server machine (Windows), double-click the Content Reporter startup icon on your desktop, or click Start > Programs > Webwasher > Content Reporter > Content Reporter Login. 2. If you are logging in from a machine with HTTP access to the Content Reporter server machine, launch your Web browser and browse to the following URL: servername is the server name or IP address of the Content Reporter machine 7777 is the Content Reporter-specific port. 3. In the Content Reporter Login page, enter admin in the Username field, enter admin in the Password field, and then click Enter. You open the Content Reporter home page, and are successfully logged into Content Reporter. Note that alphabetic characters contained in these credentials are interpreted in a case-insensitive manner by Content Reporter. This means that you could enter, e. g. admin or Admin asausernameherewith the same result. If you log into Content Reporter from the Content Reporter server machine, you see an IP address of in the Web browser s URL field. This is the machine s local host IP address. 3 1

42 Initial Configuration Tasks 3.2 Installing the Java Runtime Environment If Content Reporter prompts you to install the Java 2 Runtime Environment 1.4, complete the following steps: 1. In the Security Warning window, click Yes. The Select Java Plug-in Installation window appears. 2. Read and accept the License Agreement. 3. Select typical setup, then next. Setup will proceed. 4. In the Choose Destination Location window, click Next to complete the installation process. You can begin using Content Reporter. 3.3 The Embedded Database The embedded MySQL MaxDB database is provided for evaluation as well as for productive operating in small to medium-size enterprises. It can be used for collecting and processing log data generated by up to users, and for generating reports on the corresponding log files. After logging into Content Reporter for the first time, you can examine the MaxDB database settings on the Administration DB Admin tab. CAUTION! You cannot transfer data from the MaxDB database to another enterprise database once you have started to collect log files using MaxDB. 3 2

43 Initial Configuration Tasks The DB Admin Tab With MaxDB Settings The following graphic shows the Administration DB Admin tab with MaxDB settings List of MaxDB Database Settings The following table describes the embedded MaxDB database settings. CAUTION! Do not modify the Username, Password, Port, or DB Name settings. Otherwise, you cannot log back into Content Reporter after restarting the service. Only modify the Hostname setting if you must connect to a MaxDB database on another machine. MaxDB Setting Value Description Username cr_admin The account user name of the built-in MaxDB crsetting database. Password admin The account password of the built-in MaxDB crsetting database. Hostname machine name The machine name of the system on which you installed the MaxDB database. In most cases, this is the machine on which you installed Content Reporter. Example: If the machine name is smith-nt.domainname.com, the host name is either smith-nt, or smith-nt.domainname.com. 3 3

44 Initial Configuration Tasks Port 7210 The Content Reporter server connection port to the MaxDB database. DB Name crsettings The name of the embedded database. 3.4 Configuring Your Enterprise Database Your enterprise database is a crucial part of the Content Reporter application. Once you connect Content Reporter to your database, all of the Content Reporter server settings are stored in your database. If your database service stops or the Content Reporter server loses network connectivity to your database, you will receive an error message in your Web browser and will not be able to log into Content Reporter. The Content Reporter server also stores all parsed log file records for each Log Source in your database. Finally, all reports in Content Reporter are based on the records for each Log Source in your database. For details about configuring your enterprise database, see the following topics: Configuring an MS SQL Database (3.4.2) Configuring an Oracle Database (3.4.2) Configuring an MS SQL Database You can install an SQL server 2000 database and the Content Reporter server on the same machine or on different machines. If you install them on different machines, you must install an MS SQL client on the Content Reporter server machine Required Configuration Procedures You must perform the following procedures to configure an SQL server 2000 database: Create or identify a database ( crsettings is the default name) and a login (either the sa login or a some other login granted the Server Administrator role) for the Content Reporter server 3 4

45 Initial Configuration Tasks Configure Content Reporter to use the MS SQL database The DB Admin Tab with MS SQL Settings The following graphic shows the DB Admin tab with SQL server 2000 settings Database Settings The following table describes the MS SQL database settings in Content Reporter. Setting User name Description The username of the SQL login that Content Reporter uses to access the database listed in the DB Name field. The default is the sa login. Content Reporter can also use a login that meets the following three requirements: granted only the Server Administrator role has only Public and db_ddladmin privileges for the Content Reporter database (listed in the DB Name field) defaults to the Content Reporter database (listed in the DB Name field) 3 5

46 Initial Configuration Tasks The password of the MS SQL login that Content Reporter uses to access the database listed in the DB Name field. For security reasons, no default password is set. The MS SQL server machine name. Example: If the machine name is bills-nt.domainname.com, the host name is either bills-nt or bills-nt.domainname.com. Port Password Hostname Database Home DB Name The port through which the Content Reporter server connects to an MS SQL database. The default port is For the SQL server 2000, the default installation directory is C:\Program Files\Microsoft SQL Server. This should be changed to a location where sufficient space for data files is available. Alternatively, during creation of the Content Reporter database, alternate locations for data files should be chosen that provide sufficient disk space. Please consult with your MS database administrator. The name of the database you created in MS SQL for Content Reporter. The default database name is crsettings Configuring an MS SQL Server 2000 Database and Login To configure an MS SQL Server 2000 database and a login for Content Reporter, complete the following steps. 1. To create a database for Content Reporter in the MS SQL Enterprise Manager console, expand the database server in the left-hand console tree (under Console Root Microsoft SQL Servers SQL Server Group), right-click Databases, and then click New Database. 2. In the Database Properties window, enter a name (the default name for a Content Reporter database is crsettings. Note: Please make sure the database name does not contain any - characters). 3 6

47 Initial Configuration Tasks 3. From the General tab s data properties window, collation should be set to Latin1_General_CS_AS_KS. 3 7

48 Initial Configuration Tasks 4. For the Data Files and Transaction Log tabs, the actual location of the files does not matter, as long as sufficient disk space is available to hold the expected data volume. For assistance with sizing the database, please contact 5. If you want Content Reporter to use the sa System Administrator SQL login, then first expand Security in the console tree, click Logins, right-click the sa login, and click Properties. Then, identify or enter a password for the sa login, click OK, and go to Step If you want to create a new SQL login for Content Reporter, go to Step To create a new SQL Server Administrator login for Content Reporter, complete the following steps: 1. Expand Security in the console tree, right-click Logins, and click New Login. 2. Enter a name for the login, click the SQL Server Authentication button, enter a password for the login, select the new Content Reporter database from the lower default Database drop-down list, and then click the Server Roles tab. 3. Select only the Bulk Insert Administrator role check box, and click the Database Access tab. 4. Select the Permit box next to the database in the upper list, select only the public and the db_ddladmin check boxes in the lower list, and click OK. 3 8

49 Initial Configuration Tasks 5. Enter the password, and click OK. 8. Make sure the database recovery model is set to "Bulk-Logged". You can check/change this using the database properties dialog on the "Options" tab. 9. If the Content Reporter server and the MS SQL Server database are on different machines, then install an MS SQL client on the Content Reporter server machine. 10. If the Content Reporter server and the MS SQL Server database are on the same machine, go to Step Go to Configuring Content Reporter to use MS SQL Server database Configuring Content Reporter to Use an MS SQL Server Database Usually, the settings for using Content Reporter with a MS SQL Server database are made during the initial configuration, which is guided by the built-in Content Reporter installation wizard. The following steps must only be completed if the database server configuration needs to be adapted after the original installation of Content Reporter: 1. Log into Content Reporter, and click the Administration tab. 2. Click the Administration button. 3. Select the DB Admin tab. At any point, you can click Reset to reset the database settings on this tab to the state currently stored in the configuration settings. 4. Select SQL Server from the Database drop-down list. 5. Enter the SQL login user name (or leave sa ) in the Username field, and then enter the login password in the Password field. 6. If the database instance is a named instance, select the Named Instance check box and enter the name of the instance in the Instance Name field. 7. If the database instance is not a named instance, then enter the port of the MS SQL Server database. 8. Enter the hostname of the database server in the Hostname field. 9. Enter (or click Browse, Browse to, and Select ) the root directory of the SQL server or client installation in the Database Home field. 10. Enter the name of the MS SQL Server database (the default is crsettings ) you created or identified for Content Reporter. 11. Test the Content Reporter server s connection to the database by clicking Test DB Connection. 3 9

50 Initial Configuration Tasks 12. If a successful connection exists between Content Reporter and the database, click OK to close the pop-up window that confirmed a successful connection, then click OK to save the changed settings. 13. If the database connection test failed, click OK, verify the information you entered and check network connectivity between the Content Reporter server and the SQL server. Then go back to Step From the Administration page, log out of Content Reporter. 15. Stop and restart the Content Reporter service. In Windows 2000, rightclick My Computer > Manage > expand Services and Applications > double-click Services. Then stop and start the Content Reporter service. Any time you modify database settings, you must stop and restart the Content Reporter service for the new settings to take affect. You might have to wait a moment for Content Reporter to start running. After this, you have successfully configured Content Reporter to use an MS SQL Server database Configuring an Oracle Database The upcoming sections describe the configuration procedure for an Oracle database Where You Can Install the Database You can install the database and the Content Reporter server on the same machine or on different machines. If you install them on different machines, you must install a client on the Content Reporter server machine. Usually, the settings for using Content Reporter with an Oracle database are made during the initial configuration, which is guided by the built-in Content Reporter installation wizard. The following steps must only be completed if the database server configuration needs to be adapted after the original installation of Content Reporter. 3 10

51 Initial Configuration Tasks Required Configuration Procedures You must perform the following procedures to configure an Oracle database: Configure the database to work with Content Reporter Configure Content Reporter to use the Oracle database TheDBAdminTabwithOracleSettings The following graphic shows the DB Admin tab with Oracle settings Database Settings The following table describes the Oracle database settings in Content Reporter. Database Setting User name Password Hostname Description The Oracle user name of the account that Content Reporter uses to access the database. The password for the Oracle user account that Content Reporter uses to access the database. The Oracle server machine name. Example: If the machine name is bills-nt.domainname.com, the host name is either bills-nt or bills-nt.domainname.com. 3 11

52 Initial Configuration Tasks Port Database Home SID The port through which the Content Reporter server connects to an Oracle database. The default port is The Home directory of the Oracle database server or Oracle client. The Oracle Service Name or SID of the database instance used with Content Reporter Client Requirements The following table lists the Content Reporter server s Oracle client requirements. Characteristic Version Installed utilities Requirement The Oracle client s version (8.1.7, 9i, 10g) must match the Oracle database server s version. JDBC Drivers and SQL Loader utilities installed. These are part of the Typical client installation Configuring the Database To configure the database for Content Reporter, complete the following steps. 1. If you installed the Content Reporter server and Oracle server on different machines, then install an Oracle 8.1.7, 9i or 10g client on the Content Reporter server machine. Ensure that the SQL Loader utilities for the client are installed. These are included in the Typical installation. Ensure that the JDBC Drivers and SQL Loader utilities for the Oracle server are installed. 2. Ensure that the Content Reporter server and Oracle server are running on the same machine 3. Create a user account for Content Reporter. 4. Go to Configuring Content Reporter. 3 12