How omnivore-app/omnivore works
Omnivore is a self-hosted read-it-later product with web, Android, and Apple clients. A typical workflow is to share or add a URL, fetch and parse its content, save it to a library, then read, search, label, highlight, or listen to it; clients synchronize through the API. The repository also includes newsletter ingestion, RSS discovery, PDF reading, and text-to-speech. Several client and service subsystems are represented by paths from the tree rather than inspected implementation excerpts, so only documented or indexed connections are drawn.
Main entry points: server.ts API server · App Apple app · web Web app · request_handler.ts Content fetch
Components 22
Reading clients
- Web app
packages/web - Android app
android/Omnivore/app/src/main/java/app/omnivore/omnivore - Apple app
apple/OmnivoreKit/Sources/App
Capture and discovery
- Share extension
apple/OmnivoreKit/Sources/App/AppExtensions/Share/ShareExtensionViewModel.swift - Content fetch
packages/content-fetch/src/request_handler.ts - Page parser
packages/puppeteer-parse/src/index.ts - Content handlers
packages/content-handler/src/content-handler.ts - RSS discovery
packages/discover/src/lib/inputSources/articles/rss/rssIngestor.ts - Newsletter email
packages/local-mail-watcher/src/index.ts
API services
- API server
packages/api/src/server.ts - Authentication
packages/api/src/routers/auth/auth_router.ts - GraphQL API
packages/api/src
Reading features
- Article reader
android/Omnivore/app/src/main/java/app/omnivore/omnivore/feature/reader - Search and library
packages/web/lib/networking/library_items/useLibraryItems.tsx - Highlights and labels
android/Omnivore/app/src/main/java/app/omnivore/omnivore/core/data/HighlightActionHandlers.kt - Text to speech
apple/OmnivoreKit/Sources/Services/AudioSession/AudioController.swift - PDF reading
apple/OmnivoreKit/Sources/App/PDFSupport/PDFViewer.swift
Persistence and sync
- Android data service
android/Omnivore/app/src/main/java/app/omnivore/omnivore/core/data/DataService.kt - Android local database
android/Omnivore/app/src/main/java/app/omnivore/omnivore/core/database/OmnivoreDatabase.kt - Apple data service
apple/OmnivoreKit/Sources/Services/DataService/DataService.swift - PostgreSQL
Other components
- Reader
Connections 21
- Reader → Web app: uses
README.md - Reader → Android app: uses
README.md - Reader → Apple app: uses
README.md - Reader → Share extension: shares content
README.md - Web app → GraphQL API: queries
packages/web/lib/networking/networkHelpers.ts - API server → Authentication: routes auth
packages/api/src/server.ts - Android data service → Android local database: uses database
android/Omnivore/app/src/main/java/app/omnivore/omnivore/core/data/DataService.kt - Android data service → API server: calls networker
- Apple app → Apple data service: uses services
apple/OmnivoreKit/Sources/App/Services.swift - Apple data service → API server: syncs remotely
- Share extension → Apple data service: saves page
apple/OmnivoreKit/Sources/App/AppExtensions/Share/ShareExtensionViewModel.swift - Content fetch → Page parser: requests parsing
packages/content-fetch/src/request_handler.ts - Newsletter email → Content fetch: submits content
- RSS discovery → API server: adds discoveries
- Content handlers → Content fetch: handles content
- API server → PostgreSQL: persists records
README.md - Web app → Search and library: fetches library
packages/web/lib/networking/queries/useGetArticleQuery.tsx - Android app → Article reader: opens saved items
- Article reader → Highlights and labels: creates annotations
- Apple app → Text to speech: plays speech
apple/OmnivoreKit/Sources/App/Services.swift - Apple app → PDF reading: opens PDFs
README.md