AuditConsole - User Guide


Table of Contents

AuditConsole - User Guide
1. About this Guide
2. Latest Version of this Guide
1. Introduction
1.1. About the AuditConsole
1.1.1. Why another Console for ModSecurity?
1.1.2. What can I do with it?
1.1.3. Where do I get Help?
1.1.4. Terms of Use
1.2. Overview & Concepts
1.2.1. Sensors, Views & Filters
1.2.2. Event - Tagging
2. Quick-Start Guide
2.1. Download the AuditConsole
2.2. Start the Console and run the Setup
3. Installation
3.1. Overview
3.1.1. Download the AuditConsole
3.1.2. Layout of an AuditConsole Setup
3.1.3. Recommended Preparations (optional)
3.2. Installing AuditConsole
3.2.1. Ubuntu/Debian Installation
3.2.2. CentOS/RedHat Installation
3.2.3. Installing the Standalone AuditConsole (Unix)
3.2.4. Installing the Standalone AuditConsole (Windows)
3.2.5. Deploying to existing Servlet-Containers (WAR archive)
3.2.6. Setting up an external Database
3.3. First Time Setup
3.3.1. Starting the AuditConsole
3.3.2. Setting up up the Console
3.3.3. Setting up HTTPS with a real certificate
3.3.4. What's next?
3.4. Upgrading the AuditConsole
3.4.1. Upgrading the AuditConsole standalone Version
3.4.2. Upgrading the AuditConsole web-app
4. Console Administration
4.1. Overview
4.2. Creating/Managing Sensors
4.2.1. Creating Sensors
4.2.2. Configuring Apache for sending Events
4.3. User Management
4.3.1. Adding a new User
4.3.2. Changing the User-Details
4.3.3. Adding a Users' View
4.4. Importing Log-Files
5. Using the AuditConsole
5.1. Event Management
5.1.1. Events & Filters
6. Reporting
6.1. How does it work?
6.2. How does the result look like?
6.3. I want this! How does is work?
6.4. A more complete Example
6.5. That's cool, but I'm missing feature X
7. AuditConsole Maintenance
7.1. The AuditConsole Task Scheduler
7.2. Maintenance Tasks
7.2.1. Archiving old Events
8. Tuning the AuditConsole
8.1. Tuning the Apache Tomcat
8.2. Tuning MySQL
9. Advanced Setup options
9.1. Using External Authentication
9.1.1. How External Authentication works
9.1.2. Important: The AuditConsole User Database
9.2. Authentication with OpenID and Google Accounts
9.2.1. Enabling OpenID/Google SSO in the AuditConsole
9.2.2. Setting the OpenID/Google ID for a User
9.3. Setup Single-Sign-ON with CAS
9.3.1. How CAS works
9.3.2. Preparing the CAS Setup
9.3.3. Setting up the AuditConsole with CAS
A. Appendix
A.1. The JWall Tool-Box
A.1.1. Installation & Setup
A.1.2. ToolBox Commands
A.2. Reporting Variables
A.3. The AuditConsole API
A.3.1. API Authentication & Views
A.3.2. Standard parameters
A.3.3. API Commands

List of Tables

3.1. Database Connection Settings
3.2. E-Mail Settings
6.1.
7.1. Example Parameters for the Archive Task