Use github packages

This commit is contained in:
Richard Roberson 2025-02-26 05:42:57 -07:00
parent 7776333168
commit 9fc7fa32c6
2 changed files with 12 additions and 12 deletions

View file

@ -6,7 +6,7 @@ on:
- 'v*.*.*' - 'v*.*.*'
env: env:
REGISTRY: docker.io REGISTRY: ghcr.io
IMAGE_NAME: richardr1126/openreader-webui IMAGE_NAME: richardr1126/openreader-webui
jobs: jobs:
@ -26,11 +26,12 @@ jobs:
- name: Set up Docker Buildx - name: Set up Docker Buildx
uses: docker/setup-buildx-action@v3 uses: docker/setup-buildx-action@v3
- name: Login to Docker Hub - name: Login to GitHub Container Registry
uses: docker/login-action@v3 uses: docker/login-action@v3
with: with:
username: ${{ secrets.DOCKERHUB_USERNAME }} registry: ${{ env.REGISTRY }}
password: ${{ secrets.DOCKERHUB_TOKEN }} username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}
- name: Extract metadata for Docker - name: Extract metadata for Docker
id: meta id: meta
@ -50,4 +51,4 @@ jobs:
tags: ${{ steps.meta.outputs.tags }} tags: ${{ steps.meta.outputs.tags }}
labels: ${{ steps.meta.outputs.labels }} labels: ${{ steps.meta.outputs.labels }}
cache-from: type=gha cache-from: type=gha
cache-to: type=gha,mode=max cache-to: type=gha,mode=max

View file

@ -5,9 +5,8 @@
[![GitHub Last Commit](https://img.shields.io/github/last-commit/richardr1126/OpenReader-WebUI)](../../commits) [![GitHub Last Commit](https://img.shields.io/github/last-commit/richardr1126/OpenReader-WebUI)](../../commits)
[![GitHub Release](https://img.shields.io/github/v/release/richardr1126/OpenReader-WebUI)](../../releases) [![GitHub Release](https://img.shields.io/github/v/release/richardr1126/OpenReader-WebUI)](../../releases)
[![Docker Image Size](https://img.shields.io/docker/image-size/richardr1126/openreader-webui/latest)](https://hub.docker.com/r/richardr1126/openreader-webui) [![Container Image Size](https://img.shields.io/badge/dynamic/json?color=blue&label=image%20size&query=size&url=https://api.github.com/repos/richardr1126/OpenReader-WebUI/packages/container/openreader-webui/versions)](https://github.com/richardr1126/OpenReader-WebUI/pkgs/container/openreader-webui)
[![Docker Image Version](https://img.shields.io/docker/v/richardr1126/openreader-webui/latest?label=latest%20docker)](https://hub.docker.com/r/richardr1126/openreader-webui/tags) [![Container Version](https://img.shields.io/github/v/release/richardr1126/OpenReader-WebUI?label=container)](https://github.com/richardr1126/OpenReader-WebUI/pkgs/container/openreader-webui)
[![Docker Hub](https://img.shields.io/docker/pulls/richardr1126/openreader-webui)](https://hub.docker.com/r/richardr1126/openreader-webui)
# OpenReader WebUI 📄🔊 # OpenReader WebUI 📄🔊
@ -42,7 +41,7 @@ https://github.com/user-attachments/assets/262b9a01-c608-4fee-893c-9461dd48c99b
docker run --name openreader-webui \ docker run --name openreader-webui \
-p 3003:3003 \ -p 3003:3003 \
-v openreader_docstore:/app/docstore \ -v openreader_docstore:/app/docstore \
richardr1126/openreader-webui:latest ghcr.io/openreader-webui:latest
``` ```
(Optionally): Set the TTS `API_BASE` URL and/or `API_KEY` to be default for all devices (Optionally): Set the TTS `API_BASE` URL and/or `API_KEY` to be default for all devices
@ -51,7 +50,7 @@ docker run --name openreader-webui \
-e API_BASE=http://host.docker.internal:8880/v1 \ -e API_BASE=http://host.docker.internal:8880/v1 \
-p 3003:3003 \ -p 3003:3003 \
-v openreader_docstore:/app/docstore \ -v openreader_docstore:/app/docstore \
richardr1126/openreader-webui:latest ghcr.io/openreader-webui:latest
``` ```
> Requesting audio from the TTS API happens on the Next.js server not the client. So the base URL for the TTS API should be accessible and relative to the Next.js server. If it is in a Docker you may need to use `host.docker.internal` to access the host machine, instead of `localhost`. > Requesting audio from the TTS API happens on the Next.js server not the client. So the base URL for the TTS API should be accessible and relative to the Next.js server. If it is in a Docker you may need to use `host.docker.internal` to access the host machine, instead of `localhost`.
@ -63,7 +62,7 @@ Visit [http://localhost:3003](http://localhost:3003) to run the app and set your
### ⬆️ Update Docker Image ### ⬆️ Update Docker Image
```bash ```bash
docker stop openreader-webui && docker rm openreader-webui docker stop openreader-webui && docker rm openreader-webui
docker pull richardr1126/openreader-webui:latest docker pull ghcr.io/openreader-webui:latest
``` ```
### Adding to a Docker Compose (i.e. with open-webui or Kokoro-FastAPI) ### Adding to a Docker Compose (i.e. with open-webui or Kokoro-FastAPI)
@ -75,7 +74,7 @@ volumes:
services: services:
openreader-webui: openreader-webui:
container_name: openreader-webui container_name: openreader-webui
image: richardr1126/openreader-webui:latest image: ghcr.io/openreader-webui:latest
environment: environment:
- API_BASE=http://host.docker.internal:8880/v1 - API_BASE=http://host.docker.internal:8880/v1
ports: ports: