Horizon Security Documentation

Overview

Welcome to the Horizon Security Documentation repository! This is the centralized documentation hub for the Horizon Security Framework, providing comprehensive documentation for all modules and components.

The Horizon Security Framework consists of four core modules:

• GAIA Framework - Security orchestration and management
• DEMETER Infrastructure Scan - Infrastructure security assessment
• HADES Endpoint Security - Endpoint detection and response
• ARTEMIS Static Code Analysis - Application security testing

Documentation Site

The documentation is built with MkDocs and Material for MkDocs.

Visit the live documentation at: https://horizonsec.github.io/horizon-documentation

Installation

The Horizon Security Documentation can be set up locally for development and contribution purposes.

Prerequisites

• Python 3.8 or higher
• pip (Python package manager)
• Git

Quick Setup

1. Clone the repository:

   git clone https://github.com/HorizonSec/horizon-documentation.git
   cd horizon-documentation

2. Install dependencies:

   pip install -r requirements.txt

3. Serve locally:

   mkdocs serve

The documentation will be available at http://127.0.0.1:8000

Getting Started

Using Hatch (Recommended)

This project uses Hatch for project management.

1. Install Hatch:

   pip install hatch

2. Clone the repository:

   git clone https://github.com/HorizonSec/horizon-documentation.git
   cd horizon-documentation

3. Serve the documentation locally:

   hatch run serve

   The documentation will be available at http://127.0.0.1:8000

Manual Setup

If you prefer not to use Hatch:

1. Install dependencies:

   pip install mkdocs mkdocs-material

2. Serve locally:

   mkdocs serve

Available Commands

Using Hatch

# Serve documentation locally (with live reload)
hatch run serve

# Build documentation
hatch run build

# Deploy to GitHub Pages
hatch run deploy

# Clean build artifacts
hatch run clean

Using MkDocs directly

# Serve documentation locally
mkdocs serve

# Build documentation
mkdocs build

# Deploy to GitHub Pages
mkdocs gh-deploy

Documentation Structure

docs/
├── index.md                    # Home page
├── getting-started.md          # Getting started guide
└── modules/                    # Module documentation
    ├── index.md                # Modules overview
    ├── gaia-framework.md       # GAIA Framework
    ├── demeter-infra-scan.md   # DEMETER Infrastructure Scan
    ├── hades-endpoint.md       # HADES Endpoint Security
    └── artemis-static-code.md  # ARTEMIS Static Code Analysis

Contributing

We welcome contributions from the community! Please read our CONTRIBUTING.md for details on:

• How to submit issues
• How to create pull requests
• Documentation standards and best practices
• Development workflow

Code of Conduct

This project adheres to a Code of Conduct that all contributors are expected to follow. Please read CODE_OF_CONDUCT.md to understand the expected behavior when participating in this project.

Security

If you discover a security vulnerability, please follow the guidelines in SECURITY.md to report it responsibly.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Support

For questions, issues, or feature requests:

• Open an issue using the appropriate template
• Contact the HorizonSec team
• Check existing documentation and issues

Acknowledgments

• Thanks to all contributors who help improve this template
• Built with ❤️ by the HorizonSec team