App Submission: OpenReader WebUI (#2499)

This commit is contained in:
Denny 2025-04-18 11:24:21 +02:00 committed by GitHub
parent ee1d5b5442
commit 4c39161688
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 55 additions and 0 deletions

View File

@ -0,0 +1 @@

View File

@ -0,0 +1,16 @@
version: '3.7'
services:
app_proxy:
environment:
APP_HOST: openreader_web_1
APP_PORT: 3003
web:
image: ghcr.io/richardr1126/openreader-webui:0.2.6@sha256:1f60d64898f85d24fab3a0b34be3c7c7a51b2fd37540ae54baca81d35e7289bb
user: "1000:1000"
environment:
- API_BASE=http://kokoro_web_1:8880/v1 #Set the TTS API_BASE URL and/or API_KEY as the default for all devices. These values can also be overridden in the UI.
restart: on-failure
volumes:
- ${APP_DATA_DIR}/data/docstore:/app/docstore

38
openreader/umbrel-app.yml Normal file
View File

@ -0,0 +1,38 @@
manifestVersion: 1
id: openreader
name: OpenReader
tagline: A document reader with Text-to-Speech capabilities
category: ai
version: "0.2.6"
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: hhttps://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: ""
dependencies:
- kokoro
path: ""
defaultUsername: ""
defaultPassword: ""