Skip to content

osintukraine/osint-platform-docs

Repository files navigation

OSINT Intelligence Platform Documentation

Comprehensive documentation for the OSINT Intelligence Platform - a self-hosted system for archiving, enriching, and analyzing Telegram channels with AI-powered classification, semantic search, and configurable intelligence rules.

Key Features

  • Telegram Archiving - Real-time monitoring with folder-based channel management
  • AI Classification - Self-hosted LLM (Ollama) for importance scoring and topic classification
  • Semantic Search - pgvector embeddings for "find similar content" queries
  • Entity Matching - Automatic linking to curated military/political entities
  • RSS Distribution - "Subscribe to any search" with authenticated feeds
  • Social Graph - Forward chain tracking and influence analysis
  • Fully Self-Hosted - No cloud dependencies, complete data sovereignty

Documentation Sections

Section Audience Description
Getting Started Everyone Platform overview, quick start, core concepts
User Guide Analysts Searching, RSS feeds, entities, notifications
Operator Guide Admins Installation, configuration, monitoring, backups
Developer Guide Developers Architecture, services, contributing
Security Guide Security Authentication (Ory Kratos), CrowdSec, hardening
Tutorials Everyone Step-by-step guides (5-30 minutes each)
Reference Everyone API endpoints, env vars, database schema, Docker

Quick Links

Source Code

Platform repository: osintukraine/osint-intelligence-platform

Serving Docs Locally

pip install -r requirements.txt
mkdocs serve

License

Same as the main OSINT Intelligence Platform repository.

About

documentation for osint-intelligence-platform

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors