add Docker support
This commit is contained in:
parent
8531d4a68a
commit
6a6ad6510e
2 changed files with 58 additions and 2 deletions
23
Dockerfile
Normal file
23
Dockerfile
Normal file
|
|
@ -0,0 +1,23 @@
|
||||||
|
# Use Node.js slim image
|
||||||
|
FROM node:slim
|
||||||
|
|
||||||
|
# Create app directory
|
||||||
|
WORKDIR /app
|
||||||
|
|
||||||
|
# Copy package files
|
||||||
|
COPY package*.json ./
|
||||||
|
|
||||||
|
# Install dependencies
|
||||||
|
RUN npm install
|
||||||
|
|
||||||
|
# Copy project files
|
||||||
|
COPY . .
|
||||||
|
|
||||||
|
# Build the Next.js application
|
||||||
|
RUN npm run build
|
||||||
|
|
||||||
|
# Expose the port the app runs on
|
||||||
|
EXPOSE 3003
|
||||||
|
|
||||||
|
# Start the application
|
||||||
|
CMD ["npm", "start"]
|
||||||
37
README.md
37
README.md
|
|
@ -20,7 +20,26 @@ OpenReader WebUI is a sleek, web-based PDF reader with built-in Text-to-Speech c
|
||||||
|
|
||||||
https://github.com/user-attachments/assets/323251e6-3b3b-43cc-b139-cdab01ca7d75
|
https://github.com/user-attachments/assets/323251e6-3b3b-43cc-b139-cdab01ca7d75
|
||||||
|
|
||||||
## Installation
|
## 🐳 Docker Quick Start
|
||||||
|
|
||||||
|
```bash
|
||||||
|
docker run --name openreader-webui -p 3003:3003 richardr1126/openreader-webui:latest
|
||||||
|
```
|
||||||
|
Visit [http://localhost:3003](http://localhost:3003) to run the app.
|
||||||
|
|
||||||
|
### Using Docker Compose
|
||||||
|
Create or add to a `docker-compose.yml`:
|
||||||
|
```yaml
|
||||||
|
services:
|
||||||
|
openreader-webui:
|
||||||
|
container_name: openreader-webui
|
||||||
|
image: richardr1126/openreader-webui:latest
|
||||||
|
ports:
|
||||||
|
- "3003:3003"
|
||||||
|
restart: unless-stopped
|
||||||
|
```
|
||||||
|
|
||||||
|
## Dev Installation
|
||||||
|
|
||||||
### Prerequisites
|
### Prerequisites
|
||||||
- Node.js & npm (recommended: use [nvm](https://github.com/nvm-sh/nvm))
|
- Node.js & npm (recommended: use [nvm](https://github.com/nvm-sh/nvm))
|
||||||
|
|
@ -48,7 +67,21 @@ https://github.com/user-attachments/assets/323251e6-3b3b-43cc-b139-cdab01ca7d75
|
||||||
```bash
|
```bash
|
||||||
npm run dev
|
npm run dev
|
||||||
```
|
```
|
||||||
Visit [http://localhost:3000](http://localhost:3000) to run the app.
|
|
||||||
|
or build and run the production server:
|
||||||
|
```bash
|
||||||
|
npm run build
|
||||||
|
npm start
|
||||||
|
```
|
||||||
|
|
||||||
|
Visit [http://localhost:3003](http://localhost:3003) to run the app.
|
||||||
|
|
||||||
|
> Dev server runs on port 3000 by default, while the production server runs on port 3003.
|
||||||
|
|
||||||
|
#### Docker Supported Architectures
|
||||||
|
- linux/amd64 (x86_64)
|
||||||
|
- linux/arm64 (Apple Silicon)
|
||||||
|
- linux/arm/v7 (Raspberry Pi)
|
||||||
|
|
||||||
## **Features**
|
## **Features**
|
||||||
- Real-time sentence by sentence text-to-speech via OpenAI API TTS, [Kokoro FastAPI TTS](https://github.com/remsky/Kokoro-FastAPI), or others compatible with the `/v1/audio/speech` endpoint
|
- Real-time sentence by sentence text-to-speech via OpenAI API TTS, [Kokoro FastAPI TTS](https://github.com/remsky/Kokoro-FastAPI), or others compatible with the `/v1/audio/speech` endpoint
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue