OMNI-GRC

OMNI-GRC Documentation

Welcome to the OMNI-GRC documentation! This folder contains comprehensive guides for installation, configuration, usage, and troubleshooting.

📚 Documentation Index

Getting Started

• Installation Guide - Complete installation instructions for all platforms
  • Prerequisites and system requirements
  • Local, Docker, and cloud deployment options
  • Database setup and seeding
  • Post-installation configuration
  • Verification and troubleshooting
• Configuration Guide - Detailed configuration reference
  • Environment variables
  • Database and authentication settings
  • AI provider configuration
  • Scanner setup
  • Notification channels
  • Security settings
• Feature Gallery - Visual walkthrough with screenshots
  • All platform features with screenshots
  • UI element descriptions
  • Feature capabilities
  • Quick reference

User Guides

• CLI Guide - Command-Line Interface reference
  • All CLI commands with examples
  • Automation and scripting
  • CI/CD integration
  • JSON output for parsing
  • Best practices
• TUI Guide - Terminal User Interface guide
  • Interactive terminal interface
  • Navigation and keyboard shortcuts
  • All 8 views (Dashboard, Findings, Compliance, etc.)
  • Tips and tricks for power users
• Web UI Guide - Web Interface walkthrough
  • Dashboard and all features
  • User management
  • Compliance tracking
  • Report generation
  • Settings configuration

Technical Documentation

• API Reference - REST API documentation
  • All API endpoints
  • Request/response formats
  • Authentication
  • Rate limiting
  • Examples with curl and JavaScript
• Scanner Integration - Security scanner setup
  • 25+ supported scanners
  • Installation and configuration
  • Custom scanner development
  • Scanner mappings to controls
• Compliance Frameworks - Framework details
  • 36+ compliance frameworks across all industries
  • Healthcare: HIPAA, HITRUST, FDA 21 CFR Part 11
  • Finance: PCI-DSS, SOX, GLBA, Basel, MAS TRM, FFIEC
  • Government: FedRAMP, CMMC, FISMA, NIST 800-53/171
  • Privacy: GDPR, CCPA, LGPD, PDPA, PIPEDA, APPI
  • Cloud: CSA CCM, ISO 27017/27018
  • Emerging: NIST AI RMF, EU AI Act, ISO 42001
  • Cross-framework control mappings
• Mitigations Library - Best practices reference
  • 55 security best practices
  • Cross-framework mappings
  • Industry applicability
  • Implementation guidance
  • Evidence requirements
• Architecture - System architecture
  • Technology stack
  • Data models
  • Service architecture
  • Security design
  • Scalability considerations

Operations

• Troubleshooting - Common issues and solutions
  • Installation problems
  • Configuration errors
  • Runtime issues
  • Performance troubleshooting
  • FAQs

🚀 Quick Links

For New Users

1. Start with Installation Guide
2. Read Configuration Guide
3. Try the CLI Guide or Web UI Guide

For Administrators

1. Configuration Guide - System setup
2. Scanner Integration - Configure security tools
3. API Reference - Automation and integration

For Developers

1. Architecture - System design
2. API Reference - API integration
3. Scanner Integration - Custom scanners

For Auditors

1. Compliance Frameworks - Framework details
2. Web UI Guide - Evidence collection
3. API Reference - Data extraction

📖 Documentation by Topic

Security Scanning

• Scanner Integration - Configure scanners
• CLI Guide - Scan Commands - Run scans from CLI
• API Reference - Scans - Scan API endpoints

Compliance Management

• Compliance Frameworks - Framework overview
• CLI Guide - Compliance - CLI compliance commands
• Web UI Guide - Compliance - UI compliance tracking

Risk Management

• CLI Guide - Risks - Risk CLI commands
• Web UI Guide - Risks - Risk register UI
• TUI Guide - Risks - Risk matrix visualization

Reporting

• CLI Guide - Reports - Generate reports via CLI
• Web UI Guide - Reports - Report templates
• API Reference - Reports - Report API

Alerts & Notifications

• Configuration Guide - Notifications - Setup channels
• CLI Guide - Alerts - Manage alerts via CLI
• Web UI Guide - Alerts - Configure alerts in UI

🔍 Search Tips

Use your text editor or IDE to search across all documentation:

Common searches:

• "install" - Installation instructions
• "config" or "environment" - Configuration options
• "API" - API endpoints and examples
• "scanner" - Scanner-specific information
• "framework" - Compliance framework details
• "troubleshoot" or "error" - Problem solving

💡 Contributing to Documentation

Found an error or want to improve the docs?

1. Fork the repository
2. Edit the markdown files in docs/
3. Submit a pull request

Documentation standards:

• Use clear, concise language
• Include code examples
• Add screenshots where helpful
• Keep table of contents updated
• Test all commands and examples

📝 Documentation Format

All documentation is written in Markdown format with:

• Clear headings and structure
• Code blocks with syntax highlighting
• Tables for reference data
• Examples with explanations
• Cross-references between documents

🆘 Getting Help

Can’t find what you’re looking for?

1. Search the docs: Use Ctrl+F or your editor’s search
2. Check troubleshooting: Troubleshooting Guide
3. GitHub Issues: Report a bug or request a feature
4. GitHub Discussions: Ask questions

📅 Documentation Version

Version: 0.1.0
Last Updated: January 2026
Applies to: OMNI-GRC v0.1.0+

📄 License

Documentation is licensed under MIT License, same as the project.

---

Happy Reading! 📚 If you find these docs helpful, please star the project on GitHub!