From a0cc189a0f9cb60450a3b31f42bb091f3494618a Mon Sep 17 00:00:00 2001 From: Richard R Date: Wed, 18 Feb 2026 02:49:47 -0700 Subject: [PATCH] refactor: rename project from OpenReader WebUI to OpenReader across all relevant files. --- .github/ISSUE_TEMPLATE/bug_report.md | 2 +- NOTICE.txt | 2 +- README.md | 26 ++++++++++--------- docs-site/docs/about/license.md | 4 +-- .../docs/about/support-and-contributing.md | 4 +-- docs-site/docs/configure/database.md | 2 +- docs-site/docs/configure/migrations.md | 2 +- docs-site/docs/configure/tts-providers.md | 2 +- docs-site/docs/deploy/local-development.md | 4 +-- docs-site/docs/deploy/vercel-deployment.md | 2 +- docs-site/docs/docker-quick-start.md | 16 ++++++------ docs-site/docs/introduction.md | 6 +++-- .../docs/reference/environment-variables.md | 2 +- docs-site/docusaurus.config.ts | 18 ++++++------- package.json | 2 +- src/app/(public)/layout.tsx | 2 +- src/app/(public)/page.tsx | 6 ++--- src/app/(public)/privacy/page.tsx | 10 +++---- src/app/layout.tsx | 4 +-- src/app/manifest.json | 2 +- src/hooks/audio/useMediaSession.ts | 2 +- 21 files changed, 62 insertions(+), 58 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index cc2701d..4c29433 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -11,7 +11,7 @@ assignees: richardr1126 A description of what the bug is, which explains how you got there. **Environment info:** - - OpenReader-WebUI version: [e.g. v0.2.5 (found in the terminal when starting)] + - OpenReader version: [e.g. v0.2.5 (found in the terminal when starting)] - Using Docker: yes/no - Browser: [e.g. Safari, Firefox, Chromium] - Device: [e.g. iPhone16, Macbook Pro, Intel/AMD PC] diff --git a/NOTICE.txt b/NOTICE.txt index dbf8b9a..9ce0bfd 100644 --- a/NOTICE.txt +++ b/NOTICE.txt @@ -1,4 +1,4 @@ -OpenReader-WebUI +OpenReader Third-Party Notices =================== diff --git a/README.md b/README.md index dbb6df4..736f433 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,18 @@ -[![GitHub Release](https://img.shields.io/github/v/release/richardr1126/OpenReader-WebUI)](https://github.com/richardr1126/OpenReader-WebUI/releases) -[![License](https://img.shields.io/github/license/richardr1126/OpenReader-WebUI)](LICENSE) -[![Docs](https://img.shields.io/badge/docs-openreader--webui-0a6c74)](https://docs.openreader.richardr.dev/) -[![Playwright Tests](https://github.com/richardr1126/OpenReader-WebUI/actions/workflows/playwright.yml/badge.svg)](https://github.com/richardr1126/OpenReader-WebUI/actions/workflows/playwright.yml) -[![Docs Check](https://github.com/richardr1126/OpenReader-WebUI/actions/workflows/docs-check.yml/badge.svg)](https://github.com/richardr1126/OpenReader-WebUI/actions/workflows/docs-check.yml) +[![GitHub Release](https://img.shields.io/github/v/release/richardr1126/openreader)](https://github.com/richardr1126/openreader/releases) +[![License](https://img.shields.io/github/license/richardr1126/openreader)](LICENSE) +[![Docs](https://img.shields.io/badge/docs-openreader-0a6c74)](https://docs.openreader.richardr.dev/) +[![Playwright Tests](https://github.com/richardr1126/openreader/actions/workflows/playwright.yml/badge.svg)](https://github.com/richardr1126/openreader/actions/workflows/playwright.yml) +[![Docs Check](https://github.com/richardr1126/openreader/actions/workflows/docs-check.yml/badge.svg)](https://github.com/richardr1126/openreader/actions/workflows/docs-check.yml) -[![GitHub Stars](https://img.shields.io/github/stars/richardr1126/OpenReader-WebUI)](https://github.com/richardr1126/OpenReader-WebUI/stargazers) -[![GitHub Forks](https://img.shields.io/github/forks/richardr1126/OpenReader-WebUI)](https://github.com/richardr1126/OpenReader-WebUI/network/members) -[![Discussions](https://img.shields.io/badge/Discussions-Ask%20a%20Question-blue)](https://github.com/richardr1126/OpenReader-WebUI/discussions) +[![GitHub Stars](https://img.shields.io/github/stars/richardr1126/openreader)](https://github.com/richardr1126/openreader/stargazers) +[![GitHub Forks](https://img.shields.io/github/forks/richardr1126/openreader)](https://github.com/richardr1126/openreader/network/members) +[![Discussions](https://img.shields.io/badge/Discussions-Ask%20a%20Question-blue)](https://github.com/richardr1126/openreader/discussions) -# 📄🔊 OpenReader WebUI +# 📄🔊 OpenReader -OpenReader WebUI is an open source, self-host-friendly text-to-speech document reader built with Next.js for **EPUB, PDF, TXT, MD, and DOCX** with synchronized read-along playback. +OpenReader is an open source, self-host-friendly text-to-speech document reader built with Next.js for **EPUB, PDF, TXT, MD, and DOCX** with synchronized read-along playback. + +> Previously named **OpenReader-WebUI**. > **Get started in the [docs](https://docs.openreader.richardr.dev/)**. @@ -40,8 +42,8 @@ OpenReader WebUI is an open source, self-host-friendly text-to-speech document r ## 🧭 Community -- Questions and ideas: [GitHub Discussions](https://github.com/richardr1126/OpenReader-WebUI/discussions) -- Bug reports: [GitHub Issues](https://github.com/richardr1126/OpenReader-WebUI/issues) +- Questions and ideas: [GitHub Discussions](https://github.com/richardr1126/openreader/discussions) +- Bug reports: [GitHub Issues](https://github.com/richardr1126/openreader/issues) - Contributions: open a pull request ## 📜 License diff --git a/docs-site/docs/about/license.md b/docs-site/docs/about/license.md index 0208ca1..24af383 100644 --- a/docs-site/docs/about/license.md +++ b/docs-site/docs/about/license.md @@ -2,6 +2,6 @@ title: License --- -OpenReader WebUI is licensed under the MIT License. +OpenReader is licensed under the MIT License. -- Repository license file: [LICENSE](https://github.com/richardr1126/OpenReader-WebUI/blob/main/LICENSE) +- Repository license file: [LICENSE](https://github.com/richardr1126/openreader/blob/main/LICENSE) diff --git a/docs-site/docs/about/support-and-contributing.md b/docs-site/docs/about/support-and-contributing.md index 8a630c9..cef6224 100644 --- a/docs-site/docs/about/support-and-contributing.md +++ b/docs-site/docs/about/support-and-contributing.md @@ -4,11 +4,11 @@ title: Support and Contributing ## Feature requests -Use [GitHub Discussions](https://github.com/richardr1126/OpenReader-WebUI/discussions) for feature requests and ideas. +Use [GitHub Discussions](https://github.com/richardr1126/openreader/discussions) for feature requests and ideas. ## Issues and support -If you encounter a bug, open an issue in [GitHub Issues](https://github.com/richardr1126/OpenReader-WebUI/issues). +If you encounter a bug, open an issue in [GitHub Issues](https://github.com/richardr1126/openreader/issues). ## Contributing diff --git a/docs-site/docs/configure/database.md b/docs-site/docs/configure/database.md index eb8e89f..45586af 100644 --- a/docs-site/docs/configure/database.md +++ b/docs-site/docs/configure/database.md @@ -2,7 +2,7 @@ title: Database --- -This page covers database mode selection for OpenReader WebUI. +This page covers database mode selection for OpenReader. ## Database mode diff --git a/docs-site/docs/configure/migrations.md b/docs-site/docs/configure/migrations.md index 9cb3234..66c8f4b 100644 --- a/docs-site/docs/configure/migrations.md +++ b/docs-site/docs/configure/migrations.md @@ -5,7 +5,7 @@ title: Migrations import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -This page covers migration behavior for both database schema and storage data in OpenReader WebUI. +This page covers migration behavior for both database schema and storage data in OpenReader. ## Startup migration behavior diff --git a/docs-site/docs/configure/tts-providers.md b/docs-site/docs/configure/tts-providers.md index 75631c0..296a0b1 100644 --- a/docs-site/docs/configure/tts-providers.md +++ b/docs-site/docs/configure/tts-providers.md @@ -5,7 +5,7 @@ title: TTS Providers import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -OpenReader WebUI supports OpenAI-compatible TTS providers through a common API shape. +OpenReader supports OpenAI-compatible TTS providers through a common API shape. :::tip If you are running a self-hosted TTS server (Kokoro/Orpheus/etc.), use **Custom OpenAI-Like** in Settings. diff --git a/docs-site/docs/deploy/local-development.md b/docs-site/docs/deploy/local-development.md index cc1c0c5..6b6b71b 100644 --- a/docs-site/docs/deploy/local-development.md +++ b/docs-site/docs/deploy/local-development.md @@ -62,8 +62,8 @@ Set `WHISPER_CPP_BIN` in your `.env` to enable word-by-word highlighting. 1. Clone the repository. ```bash -git clone https://github.com/richardr1126/OpenReader-WebUI.git -cd OpenReader-WebUI +git clone https://github.com/richardr1126/openreader.git +cd OpenReader ``` 2. Install dependencies. diff --git a/docs-site/docs/deploy/vercel-deployment.md b/docs-site/docs/deploy/vercel-deployment.md index 89a91a9..ebe0b6c 100644 --- a/docs-site/docs/deploy/vercel-deployment.md +++ b/docs-site/docs/deploy/vercel-deployment.md @@ -2,7 +2,7 @@ title: Vercel Deployment --- -This guide covers deploying OpenReader WebUI to Vercel with external Postgres and S3-compatible object storage. +This guide covers deploying OpenReader to Vercel with external Postgres and S3-compatible object storage. ## What works on Vercel diff --git a/docs-site/docs/docker-quick-start.md b/docs-site/docs/docker-quick-start.md index c08d7fb..5f8ff68 100644 --- a/docs-site/docs/docker-quick-start.md +++ b/docs-site/docs/docker-quick-start.md @@ -22,11 +22,11 @@ If you have suitable hardware, you can run Kokoro locally with Docker. See [Koko Auth disabled, embedded storage ephemeral, no library import: ```bash -docker run --name openreader-webui \ +docker run --name openreader \ --restart unless-stopped \ -p 3003:3003 \ -p 8333:8333 \ - ghcr.io/richardr1126/openreader-webui:latest + ghcr.io/richardr1126/openreader:latest ``` @@ -35,7 +35,7 @@ docker run --name openreader-webui \ Persistent storage, embedded SeaweedFS `weed mini`, optional auth, optional library mount: ```bash -docker run --name openreader-webui \ +docker run --name openreader \ --restart unless-stopped \ -p 3003:3003 \ -p 8333:8333 \ @@ -45,7 +45,7 @@ docker run --name openreader-webui \ -e API_KEY=none \ -e BASE_URL=http://localhost:3003 \ -e AUTH_SECRET=$(openssl rand -hex 32) \ - ghcr.io/richardr1126/openreader-webui:latest + ghcr.io/richardr1126/openreader:latest ``` @@ -91,10 +91,10 @@ If `8333` is not reachable from the browser, direct presigned access is unavaila ## 3. Update Docker image ```bash -docker stop openreader-webui || true && \ -docker rm openreader-webui || true && \ -docker image rm ghcr.io/richardr1126/openreader-webui:latest || true && \ -docker pull ghcr.io/richardr1126/openreader-webui:latest +docker stop openreader || true && \ +docker rm openreader || true && \ +docker image rm ghcr.io/richardr1126/openreader:latest || true && \ +docker pull ghcr.io/richardr1126/openreader:latest ``` :::tip diff --git a/docs-site/docs/introduction.md b/docs-site/docs/introduction.md index 46c4c32..f3ed2a3 100644 --- a/docs-site/docs/introduction.md +++ b/docs-site/docs/introduction.md @@ -4,7 +4,9 @@ title: Introduction slug: / --- -OpenReader WebUI is an open source text-to-speech document reader built with Next.js. It provides a read-along experience with narration for **EPUB, PDF, TXT, MD, and DOCX documents**. +OpenReader is an open source text-to-speech document reader built with Next.js. It provides a read-along experience with narration for **EPUB, PDF, TXT, MD, and DOCX documents**. + +> Previously named **OpenReader-WebUI**. It supports multiple TTS providers including OpenAI, DeepInfra, and custom OpenAI-compatible endpoints such as [Kokoro-FastAPI](https://github.com/remsky/Kokoro-FastAPI) and [Orpheus-FastAPI](https://github.com/Lex-au/Orpheus-FastAPI). @@ -46,4 +48,4 @@ It supports multiple TTS providers including OpenAI, DeepInfra, and custom OpenA ## Source Repository -- GitHub: [richardr1126/OpenReader-WebUI](https://github.com/richardr1126/OpenReader-WebUI) +- GitHub: [richardr1126/openreader](https://github.com/richardr1126/openreader) diff --git a/docs-site/docs/reference/environment-variables.md b/docs-site/docs/reference/environment-variables.md index 3aeb812..daef2bd 100644 --- a/docs-site/docs/reference/environment-variables.md +++ b/docs-site/docs/reference/environment-variables.md @@ -3,7 +3,7 @@ title: Environment Variables toc_max_heading_level: 3 --- -This is the single reference page for OpenReader WebUI environment variables. +This is the single reference page for OpenReader environment variables. ## Quick Reference Table diff --git a/docs-site/docusaurus.config.ts b/docs-site/docusaurus.config.ts index 672331e..dc224ed 100644 --- a/docs-site/docusaurus.config.ts +++ b/docs-site/docusaurus.config.ts @@ -3,7 +3,7 @@ import type { Config } from '@docusaurus/types'; import type * as Preset from '@docusaurus/preset-classic'; const config: Config = { - title: 'OpenReader WebUI Docs', + title: 'OpenReader Docs', tagline: 'Docs for OpenReader', favicon: 'favicon.ico', @@ -15,7 +15,7 @@ const config: Config = { baseUrl: '/', organizationName: 'richardr1126', - projectName: 'OpenReader-WebUI', + projectName: 'OpenReader', onBrokenLinks: 'throw', markdown: { @@ -36,7 +36,7 @@ const config: Config = { docs: { routeBasePath: '/', sidebarPath: './sidebars.ts', - editUrl: 'https://github.com/richardr1126/OpenReader-WebUI/tree/main/docs-site/', + editUrl: 'https://github.com/richardr1126/openreader/tree/main/docs-site/', // lastVersion: 'current', // versions: { // current: { @@ -74,7 +74,7 @@ const config: Config = { respectPrefersColorScheme: true, }, navbar: { - title: 'OpenReader WebUI', + title: 'OpenReader', items: [ { type: 'docSidebar', @@ -87,7 +87,7 @@ const config: Config = { position: 'left', }, { - href: 'https://github.com/richardr1126/OpenReader-WebUI', + href: 'https://github.com/richardr1126/openreader', label: 'GitHub', position: 'right', }, @@ -99,15 +99,15 @@ const config: Config = { title: 'Community', items: [ { label: 'Support', to: '/about/support-and-contributing' }, - { label: 'GitHub Discussions', href: 'https://github.com/richardr1126/OpenReader-WebUI/discussions' }, - { label: 'Issues', href: 'https://github.com/richardr1126/OpenReader-WebUI/issues' }, + { label: 'GitHub Discussions', href: 'https://github.com/richardr1126/openreader/discussions' }, + { label: 'Issues', href: 'https://github.com/richardr1126/openreader/issues' }, ], }, { title: 'Project', items: [ - { label: 'GitHub', href: 'https://github.com/richardr1126/OpenReader-WebUI' }, - { label: 'Releases', href: 'https://github.com/richardr1126/OpenReader-WebUI/releases' }, + { label: 'GitHub', href: 'https://github.com/richardr1126/openreader' }, + { label: 'Releases', href: 'https://github.com/richardr1126/openreader/releases' }, ], }, ], diff --git a/package.json b/package.json index 6ae38d4..a45498c 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "name": "openreader-webui", + "name": "openreader", "version": "v1.3.0", "private": true, "scripts": { diff --git a/src/app/(public)/layout.tsx b/src/app/(public)/layout.tsx index 93634a8..c616228 100644 --- a/src/app/(public)/layout.tsx +++ b/src/app/(public)/layout.tsx @@ -292,7 +292,7 @@ export default function PublicLayout({ children }: { children: ReactNode }) {