OSIR documentation

Add your content using reStructuredText syntax. See the reStructuredText documentation for details.

First steps:

• OSIR basics
  • Overview
  • Features
  • Components & Terminology
  • Architectures
  • Network flows
  • Getting Started
• Supported Modules
• Web Usage
  • Orchestrator Actions
  • Status Monitoring Actions
• API & Client Usage
  • API Base URL
  • Authentication
  • OsirClient Class Reference
  • Command-Line Interface
  • Complete Workflow Examples
  • Advanced Usage
• Processing safety
  • File stability safety
  • Agent-side stability check
  • Directory idle detection
  • Parent directory protection
  • Input in-use check
  • hold_consumers barrier
  • Task batching and delayed flush

Setup in details:

• Master setup in details
  • Interactive setup (recommended)
  • Options Explained
  • Using a Configuration File
  • Example Usage
• Agent setup in details
  • Interactive setup (recommended)
  • Options Explained
  • Using a Configuration File
  • Example Usage
• Developer mode (Module development)
  • Terminal 1: MASTER
  • Terminal 2: AGENT
• Air Gap setup
  • Overview
  • Step 1 — Prepare OSIR on an online host
  • Step 2 — Export Docker images
  • Optional components
  • Step 3 — Transfer offline release
  • Step 4 — Load images on the air-gapped host
  • Step 5 — Start OSIR in offline mode
  • Verification

Profiles and modules:

• Profiles
  • Example Profile
  • Create a new profile
• Modules
  • Example Module
  • Parameters
  • Create a new module
• Exposed variables

API:

• API Documentation
  • OSIR module
  • src.osir_lib package
    • Subpackages
      • src.osir_lib.osir_lib package
        • Subpackages
        • Module contents
    • Module contents
  • src.osir_service package
    • Subpackages
      • src.osir_service.osir_service package
        • Subpackages
        • Module contents
    • Module contents
  • src.osir_web package
    • Subpackages
      • src.osir_web.osir_web package
        • Subpackages
        • Submodules
        • src.osir_web.osir_web.OsirWeb module
        • Module contents
    • Module contents
  • src.osir_client package
    • Subpackages
      • src.osir_client.osir_client package
        • Subpackages
        • Submodules
        • src.osir_client.osir_client.OsirClient module
        • Module contents
    • Module contents
  • src.osir_api package
    • Subpackages
      • src.osir_api.osir_api package
        • Subpackages
        • Submodules
        • src.osir_api.osir_api.OsirApi module
        • Module contents
    • Module contents