diff --git a/README.md b/README.md index 736f433..5dcfc8f 100644 --- a/README.md +++ b/README.md @@ -30,15 +30,15 @@ OpenReader is an open source, self-host-friendly text-to-speech document reader | Goal | Link | | --- | --- | -| Run with Docker | [Docker Quick Start](https://docs.openreader.richardr.dev/getting-started/docker-quick-start) | -| Deploy on Vercel | [Vercel Deployment](https://docs.openreader.richardr.dev/getting-started/vercel-deployment) | -| Develop locally | [Local Development](https://docs.openreader.richardr.dev/getting-started/local-development) | -| Configure auth | [Auth](https://docs.openreader.richardr.dev/guides/configuration) | -| Configure SQL database | [Database and Migrations](https://docs.openreader.richardr.dev/operations/database-and-migrations) | -| Configure object storage | [Object / Blob Storage](https://docs.openreader.richardr.dev/guides/storage-and-blob-behavior) | -| Configure TTS providers | [TTS Providers](https://docs.openreader.richardr.dev/guides/tts-providers) | -| Run Kokoro locally | [Kokoro-FastAPI](https://docs.openreader.richardr.dev/integrations/kokoro-fastapi) | -| Get support or contribute | [Support and Contributing](https://docs.openreader.richardr.dev/community/support) | +| Run with Docker | [Docker Quick Start](https://docs.openreader.richardr.dev/docker-quick-start) | +| Deploy on Vercel | [Vercel Deployment](https://docs.openreader.richardr.dev/deploy/vercel-deployment) | +| Develop locally | [Local Development](https://docs.openreader.richardr.dev/deploy/local-development) | +| Configure auth | [Auth](https://docs.openreader.richardr.dev/configure/auth) | +| Configure SQL database | [Database and Migrations](https://docs.openreader.richardr.dev/configure/database) | +| Configure object storage | [Object / Blob Storage](https://docs.openreader.richardr.dev/configure/object-blob-storage) | +| Configure TTS providers | [TTS Providers](https://docs.openreader.richardr.dev/configure/tts-providers) | +| Run Kokoro locally | [Kokoro-FastAPI](https://docs.openreader.richardr.dev/configure/tts-provider-guides/kokoro-fastapi) | +| Get support or contribute | [Support and Contributing](https://docs.openreader.richardr.dev/about/support-and-contributing) | ## 🧭 Community diff --git a/docs-site/docs/docker-quick-start.md b/docs-site/docs/docker-quick-start.md index ed9f94b..a4476d5 100644 --- a/docs-site/docs/docker-quick-start.md +++ b/docs-site/docs/docker-quick-start.md @@ -48,6 +48,27 @@ docker run --name openreader \ ghcr.io/richardr1126/openreader:latest ``` + + + +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 +``` + +Replace `192.168.0.122` with your Docker host LAN IP. +