Compliance Toolkit Documentation

Version: 1.1.0 Last Updated: 2025-01-05

Welcome to the Compliance Toolkit documentation! This guide will help you get started with Windows registry compliance scanning.

---

📚 Documentation Index

🚀 Getting Started

1. Quick Start Guide - Get up and running in 5 minutes
2. Installation Guide - Complete installation instructions
3. User Guide - Interactive mode usage

💻 Command Line Interface

1. CLI Quick Start - 5-minute CLI setup
2. CLI Usage Guide - Complete CLI reference
3. Automation Examples - Scheduled tasks and scripts

📊 Reports & Compliance

1. Available Reports - All compliance reports
2. Evidence Logging - Audit trail documentation
3. Executive Reports - C-level reporting features

🔒 Security (Client-Server Deployment)

1. Client Security Guide - ⚠️ REQUIRED - Secure client submissions
2. Quick Security Setup - 10-minute security hardening

🔧 Advanced Usage

1. Adding New Reports - Create custom reports
2. Template System - HTML template customization
3. Configuration Reference - JSON configuration format

👨‍💻 Developer Resources

1. Architecture Overview - Codebase structure
2. Development Guide - Building and contributing
3. Project Status - Current features and roadmap

---

🎯 Quick Links

For End Users:

• First time? → Quick Start Guide
• Need to install? → Installation Guide
• Want automation? → CLI Quick Start

For IT Administrators:

• Scheduled scans? → CLI Usage Guide
• Need examples? → Automation Examples
• Compliance audit? → Evidence Logging

For Security Teams:

• Client-server deployment? → ⚠️ Client Security Guide (REQUIRED)
• Quick security setup? → Quick Security Setup
• Enable authentication? → Quick Security Setup

For Developers:

• Custom reports? → Adding New Reports
• Customize UI? → Template System
• Understand code? → Architecture Overview

---

📖 What is Compliance Toolkit?

The Compliance Toolkit is a Windows registry compliance scanner that:

• ✅ Scans Windows registry for compliance violations
• ✅ Generates professional HTML reports with charts
• ✅ Supports NIST 800-171 and FIPS 140-2 frameworks
• ✅ Creates JSON evidence logs for audits
• ✅ Runs interactively or via command line
• ✅ Perfect for scheduled compliance scans

---

🏃 Quick Start

Interactive Mode

ComplianceToolkit.exe
# Select [1] Run Reports
# Choose a report
# View results in browser

Command Line Mode

# List available reports
ComplianceToolkit.exe -list

# Run a single report
ComplianceToolkit.exe -report=NIST_800_171_compliance.json

# Run all reports (for scheduled tasks)
ComplianceToolkit.exe -report=all -quiet

---

📁 Documentation Structure

docs/
├── README.md (this file)
├── user-guide/
│   ├── QUICKSTART.md              # 5-minute getting started
│   ├── INSTALLATION.md            # Installation instructions
│   ├── USER_GUIDE.md              # Interactive mode guide
│   ├── CLI_QUICKSTART.md          # CLI quick start
│   ├── CLI_USAGE.md               # Complete CLI reference
│   └── AUTOMATION.md              # Automation examples
├── security/                      # ⚠️ CRITICAL for client-server deployments
│   ├── CLIENT_SECURITY.md         # Complete security guide
│   └── QUICK_SECURITY_SETUP.md    # 10-minute security hardening
├── developer-guide/
│   ├── ARCHITECTURE.md            # Codebase overview
│   ├── DEVELOPMENT.md             # Build and contribute
│   ├── ADDING_REPORTS.md          # Create custom reports
│   └── TEMPLATES.md               # Template system
├── reference/
│   ├── REPORTS.md                 # Available reports
│   ├── EVIDENCE.md                # Evidence logging
│   ├── EXECUTIVE.md               # Executive reports
│   └── CONFIG.md                  # Configuration format
└── PROJECT_STATUS.md              # Project status and roadmap

---

🆘 Getting Help

Common Issues

"configs/reports not found" - Solution: Ensure configs/reports/*.json exists next to the executable - See: Installation Guide

"Access denied" errors - Solution: Run as Administrator - See: Installation Guide

Reports not opening - Solution: Clear browser cache and regenerate report - See: User Guide

Need More Help?

• 📖 Browse the User Guide
• 🔧 Check CLI Usage
• 📊 Review Project Status

---

🔄 Updates & Versions

Current Version: 1.1.0

Recent Updates: - ✅ CLI automation support - ✅ Scheduled task examples - ✅ Smart path resolution - ✅ Dark mode improvements - ✅ Search functionality

See Project Status for complete version history.

---

📝 License

Internal Use - Compliance Toolkit Team

---

Documentation Version: 1.0 Last Updated: 2025-01-05