Skip to content

docs

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

docs

README.md

Rivendell Documentation

Rivendell DF Acceleration Suite - Complete Documentation Index

Core Documentation

📘 Essential Reading

  • QUICKSTART.md - Get up and running in 5 minutes
  • USAGE.md - Common tasks and workflows quick reference
  • CONFIG.md - Configuration, setup, and troubleshooting

🔧 Technical References

  • API.md ⭐ - Complete REST API documentation with examples
  • CLI.md ⭐ - Command-line tools reference (gandalf, elrond, MITRE, cloud, AI, SIEM)
  • SECURITY.md - Security features, MFA, authentication, best practices

📐 Architecture

Quick Navigation

For New Users

  1. Start with QUICKSTART.md
  2. Read USAGE.md for common tasks
  3. Configure following CONFIG.md

For Developers

  1. Review ARCHITECTURE.md
  2. Study API.md for REST endpoints
  3. Read SECURITY.md for implementation details

For API Users

API.md - Everything you need:

  • Authentication (JWT, MFA, sessions)
  • Job management endpoints
  • Admin operations
  • Request/response examples in Python, JavaScript, cURL

For CLI Users

CLI.md - Complete command reference:

  • Gandalf acquisition (local & remote)
  • Elrond analysis (all modes)
  • MITRE ATT&CK tools
  • Cloud forensics (AWS, Azure, GCP)
  • AI agent commands
  • SIEM integration

For Administrators

  1. CONFIG.md - Configuration and tuning
  2. SECURITY.md - Security hardening
  3. REQUIREMENTS.md - System setup

Documentation Structure

docs/
├── README.md              # This file - documentation index
├── QUICKSTART.md          # 5-minute getting started guide
├── USAGE.md               # Common tasks quick reference
├── CONFIG.md              # Configuration and troubleshooting
│
├── API.md                 # ⭐ REST API complete reference
├── CLI.md                 # ⭐ Command-line tools reference
├── SECURITY.md            # Security features and implementation
│
├── ARCHITECTURE.md        # System architecture and design
├── REQUIREMENTS.md        # System requirements
│
└── diagrams/              # Architecture diagrams

Common Tasks

Getting Started

# Access web interface
http://localhost:5687

# Default login
Email: admin@rivendell.app
Password: IWasThere3000YearsAgo!

Creating an Analysis Job

# Via API
curl -X POST http://localhost:5688/api/jobs \
  -H "Authorization: Bearer $TOKEN" \
  -d '{"case_number": "CASE-001", "source_paths": ["/evidence/disk.E01"]}'

# Via CLI
elrond -C -P -A CASE-001 /evidence/disk.E01 /output/CASE-001

See USAGE.md for more examples.

Getting Help

Documentation Issues:

Technical Support:

  1. Check CONFIG.md troubleshooting section
  2. Review relevant documentation
  3. Search GitHub issues

Documentation Version: 2.1.0 Last Updated: 2025-01-15