danvics/openreader
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

fix: update Docker run commands and improve local network setup instructions in documentation

Browse source
This commit is contained in:
Richard R 2026-02-19 11:34:19 -07:00
parent af5373bf26
commit cfd5a7679c
2 changed files with 18 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
docs-site/docs/configure/tts-provider-guides/kokoro-fastapi.md
View file

@ -18,9 +18,9 @@ For Kokoro issues and support, use the upstream repository: [remsky/Kokoro-FastA
## Run Kokoro (CPU) ## Run Kokoro (CPU)
```bash ```bash
docker run -d \ docker run --name kokoro-tts \
--name kokoro-tts \
--restart unless-stopped \ --restart unless-stopped \
-d \
-p 8880:8880 \ -p 8880:8880 \
-e ONNX_NUM_THREADS=8 \ -e ONNX_NUM_THREADS=8 \
-e ONNX_INTER_OP_THREADS=4 \ -e ONNX_INTER_OP_THREADS=4 \
@ -35,11 +35,11 @@ docker run -d \
## Run Kokoro (GPU) ## Run Kokoro (GPU)
```bash ```bash
docker run -d \ docker run --name kokoro-tts \
--name kokoro-tts \ --restart unless-stopped \
-d \
--gpus all \ --gpus all \
--user 1001:1001 \ --user 1001:1001 \
--restart unless-stopped \
-p 8880:8880 \ -p 8880:8880 \
-e USE_GPU=true \ -e USE_GPU=true \
-e PYTHONUNBUFFERED=1 \ -e PYTHONUNBUFFERED=1 \

32
docs-site/docs/docker-quick-start.md
View file

@ -30,7 +30,7 @@ docker run --name openreader \
``` ```
</TabItem> </TabItem>
<TabItem value="full" label="Full Setup"> <TabItem value="localhost" label="Localhost">
Persistent storage, embedded SeaweedFS `weed mini`, optional auth, optional library mount: Persistent storage, embedded SeaweedFS `weed mini`, optional auth, optional library mount:
@ -49,39 +49,33 @@ docker run --name openreader \
``` ```
</TabItem> </TabItem>
<TabItem value="local-network" label="On Local Network"> <TabItem value="local-network" label="LAN Host">
Use this when the app should be reachable from other devices on your LAN: Use this when the app should be reachable from other devices on your LAN:
```bash ```bash
docker run --name openreader \ docker run --name openreader \
--restart unless-stopped \ --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 3003:3003 \
-p 8333:8333 \ -p 8333:8333 \
-v openreader_docstore:/app/docstore \ -v openreader_docstore:/app/docstore \
ghcr.io/richardr1126/openreader:main -e API_BASE=http://host.docker.internal:8880/v1 \
-e BASE_URL=http://<YOUR_LAN_IP>: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 `<YOUR_LAN_IP>` with the Docker host IP address on your local network to allow access from other devices.
</TabItem> </TabItem>
</Tabs> </Tabs>
:::tip :::tip Quick Tips
Remove `/app/docstore/library` if you do not need server library import. - 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.
:::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.
::: :::
:::warning Port `8333` Exposure :::warning Port `8333` Exposure