-
Notifications
You must be signed in to change notification settings - Fork 439
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
App Submission: OpenReader WebUI #2499
base: master
Are you sure you want to change the base?
Changes from all commits
8cbd8c6
1679c67
b8cd858
98bbed6
34dce5d
c3c6fdb
8a30866
2c1669f
8855afa
7fb6b12
a467b93
627d78b
57d703f
5c5ebcc
f54af58
5899c20
ad04036
6290052
3977fa6
0c3f58c
4edde17
f2d3c00
5a9a430
e6b244f
7b91cd7
9bbb7ed
08deb9b
ee13c8d
c30f87d
becbf91
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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://host.docker.internal: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 |
Original file line number | Diff line number | Diff line change | ||||||
---|---|---|---|---|---|---|---|---|
@@ -0,0 +1,37 @@ | ||||||||
manifestVersion: 1 | ||||||||
id: denny-openreader | ||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Fix the id.
Suggested change
|
||||||||
name: OpenReader WebUI | ||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Probably better to just call it OpenReader as the WebUI part would anyways be cut on the home screen.
Suggested change
|
||||||||
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: [] | ||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I would set the kokoro app as a requirement for the app to properly function.
Suggested change
|
||||||||
path: "" | ||||||||
defaultUsername: "" | ||||||||
defaultPassword: "" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The other setting does not work. I set the API url of the kokoro container, this does the trick for me.