Files
umbrel-apps/openreader/umbrel-app.yml
T
2026-05-15 11:33:47 +10:00

51 lines
3.5 KiB
YAML

manifestVersion: 1
id: openreader
name: OpenReader
tagline: A document reader with Text-to-Speech capabilities
category: ai
version: "3.0.0"
port: 3391
description: >-
OpenReader WebUI is a web-based document reader that integrates text-to-speech (TTS) functionality, allowing users to listen to text from various document formats, including PDF and EPUB. Designed to enhance accessibility and improve the reading experience, it features synchronized text highlighting, ensuring that the currently read portion of the document is visually emphasized as the speech engine narrates the content. This makes it particularly useful for individuals with visual impairments, reading difficulties, or those who simply prefer an auditory learning style.
The application is built with compatibility in mind, supporting any OpenAI-compatible TTS backend, such as Kokoro-FastAPI and Orpheus-FastAPI. This allows users to select a preferred speech synthesis engine, offering flexibility in voice selection, pronunciation accuracy, and overall reading quality. By leveraging these backends, OpenReader WebUI can generate natural-sounding speech, making long-form reading more engaging and reducing the cognitive load associated with traditional reading.
The user interface is designed to be intuitive and lightweight, providing a seamless experience without unnecessary complexity. Users can upload documents directly through the web interface, control playback speed, pause and resume narration, and navigate through the document efficiently. The software aims to cater to a diverse audience, including students, professionals, and individuals with disabilities, ensuring that reading materials are more accessible to everyone.
Additionally, OpenReader WebUI is available as an open-source project, allowing developers to contribute to its improvement and expand its capabilities. A public demo is accessible online, enabling users to test its features without requiring installation, making it easy to evaluate its functionality before setting up a local instance. With a focus on usability and accessibility, OpenReader WebUI represents a modern approach to document reading, bridging the gap between text and speech in a user-friendly manner.
⚠️ This app only works in Chromium-based browsers (e.g., Chrome, Edge, Brave).
developer: Richard Roberson
website: https://openreader.richardr.dev/
submitter: dennysubke
submission: https://github.com/getumbrel/umbrel-apps/pull/2499
repo: https://github.com/richardr1126/OpenReader-WebUI
support: https://github.com/richardr1126/OpenReader-WebUI/issues
gallery:
- 1.jpg
- 2.jpg
- 3.jpg
- 4.jpg
releaseNotes: >-
⚠️ Major update: OpenReader 3.0.0 adds server-side document storage and persistent TTS audio segments. Existing Umbrel installs continue using the bundled Kokoro TTS provider after upgrading.
Key highlights:
- Added an Admin panel for shared TTS providers and site feature settings
- Added persistent per-segment TTS audio storage so documents can resume without re-synthesizing audio
- Added per-document controls for TTS segment preloading, lookahead, and maximum block length
- Added a changelog panel in Settings that can show release notes after an upgrade
- Fixed stale TTS playback after pausing and resuming, plus other playback and document-reader polish
Full release notes can be found at https://github.com/richardr1126/openreader/releases/tag/v3.0.0
dependencies:
- kokoro
path: ""
defaultUsername: ""
defaultPassword: ""