Guide Overview

Welcome to the KafkaGuard guide. This comprehensive documentation will help you get started with KafkaGuard, configure it for your environment, and use it effectively for Kafka security and compliance scanning.

Getting Started

New to KafkaGuard? Start here:

• Installation - Install KafkaGuard on Linux, macOS, or Docker
• Quick Start - Run your first scan in 5 minutes

Core Topics

• Configuration - Configure KafkaGuard using config files, environment variables, and CLI flags
• Scanning - Learn how to scan Kafka clusters and use scan commands effectively
• Policy Tiers - Understand the three policy tiers and choose the right one for your environment
• Reports - Generate and understand reports in JSON, HTML, PDF, and CSV formats

Advanced Topics

• Advanced Usage - Custom policies, integrations, automation, and production best practices

Quick Links

Installation & Setup

• Installation Guide - Detailed installation instructions for all platforms
• Quick Start Guide - Get up and running in 5 minutes
• Configuration Guide - Configure KafkaGuard for your environment

Usage

• Scanning Guide - Learn how to scan Kafka clusters
• Policy Tiers - Choose the right policy tier
• Reports Guide - Understand report formats and usage

Advanced

• Advanced Usage - Custom policies, integrations, and automation

Need Help?

• Check the Troubleshooting Guide for common issues
• Review the CLI Reference for command details
• Open an issue on GitHub for bugs or feature requests

Ready to Get Started?

Book a demo to see KafkaGuard in action and learn how it can help secure your Kafka clusters.

📅 Book a Demo