Getting Started

Welcome to the Horizon Security Framework! Follow these steps to get started:

Prerequisites

Before you begin, ensure you have:

• Python 3.8 or higher
• Git installed on your system
• Basic understanding of security concepts
• Access to the HorizonSec repositories

Installation

Using Hatch (Recommended)

The Horizon documentation is managed using Hatch, a modern Python project manager.

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 Installation

If you prefer not to use Hatch:

1. Clone the repository:

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

2. Install dependencies:

   pip install mkdocs mkdocs-material
   

3. Serve the documentation:

   mkdocs serve
   

Explore the Modules

The Horizon Security Framework consists of four main modules:

1. GAIA Framework - Start here for the core framework
2. DEMETER Infrastructure Scan - Infrastructure security assessment
3. HADES Endpoint Security - Endpoint protection and monitoring
4. ARTEMIS Static Code Analysis - Application security testing

Next Steps

• Read the Modules Overview to understand the framework architecture
• Check the individual module documentation for detailed setup instructions
• Join our community and contribute to the project

Build and Deploy

Build the Documentation

hatch run build

or with MkDocs directly:

mkdocs build

Deploy to GitHub Pages

hatch run deploy

or with MkDocs directly:

mkdocs gh-deploy

Getting Help

If you encounter any issues:

• Check the GitHub Issues
• Review the module-specific documentation
• Reach out to the HorizonSec team