How fightandsurvive/filenimbus works
FileNimbus is a scanned-case-file ingestion, retrieval, and audit platform. The principal workflow is workstation or network scanning (and share-based ingestion), server-side metadata and OCR processing, PostgreSQL indexing, then authenticated search and file access with audit events. Separate branches cover duplicate review, alerts/remediation, operational analytics, and admin reports. The README establishes several subsystem capabilities whose implementation was not sampled; those relationships are shown as documented rather than inferred from module names.
Main entry points: db.py Database access · app.py API application · routes.py Scan staging · search.py Search endpoints
Components 22
Client experience
- Web interface
web/api.js - Search interface
web/search.js
Ingestion and OCR
- Scan agent
ocr/scan_agent/agent.py - Scanner drivers
ocr/scan_agent/escl.py - Scan staging
ocr/backend/routes.py - Page analysis
ocr/backend/analyze.py - Share ingestion
scripts/watcher.py - OCR enrichment
scripts/ocr_worker.py
Application core
- API application
api/app.py - Authentication
api/routes/auth.py - Role enforcement
api/security.py - Search endpoints
api/routes/search.py - Search engine
api/search/search.py - File access
api/routes/files.py
Operations and review
- Duplicate review
api/routes/duplicates.py - Alerts and remediation
api/routes/alerts.py - Reports and analytics
api/routes/reports.py - Admin reports
api/routes/reports_builder.py - Activity and audit
api/routes/activity.py
Persistence
- Database access
api/db.py - Platform database
Other components
- Staff and scanners
Connections 26
- Staff and scanners → Web interface: uses
- Staff and scanners → Scan agent: scans with
- Scanner drivers → Scan agent: provides scans
ocr/scan_agent/agent.py - Scan agent → Scan staging: submits PDFs
- Scan staging → Page analysis: analyzes scans
- Share ingestion → Database access: ingests files
- OCR enrichment → Database access: updates OCR
scripts/ocr_worker.py - Web interface → API application: requests API
- API application → Authentication: routes to
api/app.py - API application → Search endpoints: routes to
api/app.py - API application → File access: routes to
api/app.py - API application → Scan staging: mounts routes
api/app.py - Authentication → Role enforcement: authenticates via
api/routes/auth.py - Search interface → Search endpoints: submits queries
- Search endpoints → Search engine: searches with
api/routes/search.py - Search endpoints → Database access: logs events
api/routes/search.py - Search engine → Platform database: queries index
api/search/search.py - File access → Search engine: uses search
api/routes/files.py - File access → Database access: reads file records
api/routes/files.py - Scan staging → Database access: records scans
ocr/backend/routes.py - Database access → Platform database: queries and writes
api/db.py - Duplicate review → Platform database: reviews duplicates
- Alerts and remediation → Platform database: reads and updates
api/routes/alerts.py - Reports and analytics → Platform database: queries metrics
api/routes/reports.py - Admin reports → Platform database: runs reports
- Activity and audit → Platform database: reads audit data