Skip to content

README.md

Latest commit

 

History

History
81 lines (58 loc) · 2.62 KB

README.md

File metadata and controls

81 lines (58 loc) · 2.62 KB

Osmedeus Base

Osmedeus
Default Workflows & Configuration for Osmedeus Engine

Overview

This repository contains the default ready-to-use workflows, configurations, and data files for the Osmedeus Engine.

Use this as a starting point to run reconnaissance scans or as a reference for building your own custom environments setup.

Quick Start

  1. Install Osmedeus Engine:

    curl -sSL http://www.osmedeus.org/install.sh | bash

  2. Clone this base repository:

    osmedeus install base https://github.com/osmedeus/osmedeus-base.git

  3. Run a scan:

    # Full reconnaissance
osmedeus run -f general -t example.com

# Fast scan
osmedeus run -f fast -t example.com

# Individual module
osmedeus run -m subdomain -t example.com

Repository Structure

├── external-configs/             # Tool configuration files
├── external-data/                # Supporting data files
│   ├── wordlists/                # DNS, content, params wordlists
│   ├── rules/                    # Fingerprints & detection rules
│   └── mics/                     # Miscellaneous data
├── external-scripts/             # Custom scripts
├── external-agent-configs/       # LLM agent configurations
└── markdown-report-templates/    # Report templates

Customization

Adding API Keys

Edit the provider configuration files in external-configs/:

# external-configs/subfinder-provider-config.yaml
securitytrails:
  - YOUR_API_KEY
shodan:
  - YOUR_API_KEY

Documentation

License

Osmedeus is made with ♥ by @j3ssie and it is released under the MIT license.