From cfd5a7679c5b29657a86b43982b33263f5723bb2 Mon Sep 17 00:00:00 2001 From: Richard R Date: Thu, 19 Feb 2026 11:34:19 -0700 Subject: [PATCH] fix: update Docker run commands and improve local network setup instructions in documentation --- .../tts-provider-guides/kokoro-fastapi.md | 10 +++--- docs-site/docs/docker-quick-start.md | 32 ++++++++----------- 2 files changed, 18 insertions(+), 24 deletions(-) diff --git a/docs-site/docs/configure/tts-provider-guides/kokoro-fastapi.md b/docs-site/docs/configure/tts-provider-guides/kokoro-fastapi.md index fb39a5c..0d6d03c 100644 --- a/docs-site/docs/configure/tts-provider-guides/kokoro-fastapi.md +++ b/docs-site/docs/configure/tts-provider-guides/kokoro-fastapi.md @@ -18,9 +18,9 @@ For Kokoro issues and support, use the upstream repository: [remsky/Kokoro-FastA ## Run Kokoro (CPU) ```bash -docker run -d \ - --name kokoro-tts \ +docker run --name kokoro-tts \ --restart unless-stopped \ + -d \ -p 8880:8880 \ -e ONNX_NUM_THREADS=8 \ -e ONNX_INTER_OP_THREADS=4 \ @@ -35,11 +35,11 @@ docker run -d \ ## Run Kokoro (GPU) ```bash -docker run -d \ - --name kokoro-tts \ +docker run --name kokoro-tts \ + --restart unless-stopped \ + -d \ --gpus all \ --user 1001:1001 \ - --restart unless-stopped \ -p 8880:8880 \ -e USE_GPU=true \ -e PYTHONUNBUFFERED=1 \ diff --git a/docs-site/docs/docker-quick-start.md b/docs-site/docs/docker-quick-start.md index a4476d5..0fd8902 100644 --- a/docs-site/docs/docker-quick-start.md +++ b/docs-site/docs/docker-quick-start.md @@ -30,7 +30,7 @@ docker run --name openreader \ ``` - + Persistent storage, embedded SeaweedFS `weed mini`, optional auth, optional library mount: @@ -49,39 +49,33 @@ docker run --name openreader \ ``` - + Use this when the app should be reachable from other devices on your LAN: ```bash docker run --name openreader \ --restart unless-stopped \ - -e API_BASE=http://host.docker.internal:8880/v1 \ - -e BASE_URL=http://192.168.0.122:3003 \ - -e AUTH_SECRET=replace-with-a-long-random-secret \ - -e AUTH_TRUSTED_ORIGINS=http://localhost:3003,http://127.0.0.1:3003,http://192.168.0.122:3003 \ - -e USE_ANONYMOUS_AUTH_SESSIONS=true \ -p 3003:3003 \ -p 8333:8333 \ -v openreader_docstore:/app/docstore \ - ghcr.io/richardr1126/openreader:main + -e API_BASE=http://host.docker.internal:8880/v1 \ + -e BASE_URL=http://:3003 \ + -e AUTH_SECRET=$(openssl rand -hex 32) \ + -e AUTH_TRUSTED_ORIGINS=http://localhost:3003,http://127.0.0.1:3003 \ + -e USE_ANONYMOUS_AUTH_SESSIONS=true \ + ghcr.io/richardr1126/openreader:latest ``` -Replace `192.168.0.122` with your Docker host LAN IP. +Replace `` with the Docker host IP address on your local network to allow access from other devices. -:::tip -Remove `/app/docstore/library` if you do not need server library import. -::: - -:::tip -Remove either `BASE_URL` or `AUTH_SECRET` to keep auth disabled. -::: - -:::tip TTS API Base -Set `API_BASE` to your reachable TTS server base URL. +:::tip Quick Tips +- Remove `/app/docstore/library` if you do not need server library import. +- Remove either `BASE_URL` or `AUTH_SECRET` to keep auth disabled. +- Set `API_BASE` to your reachable TTS server base URL. ::: :::warning Port `8333` Exposure