Skip to content

Commit 5bda643

Browse files
add local URL support with docker package-lock removal and documentation update
1 parent 35685c0 commit 5bda643

5 files changed

Lines changed: 40 additions & 2 deletions

File tree

PdfToPodcast/.env.example

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,8 @@ MAX_FILE_SIZE=10485760 # 10MB in bytes
1313
# Environment
1414
NODE_ENV=development
1515
PYTHON_ENV=development
16+
17+
# Local URL Endpoint (only needed for non-public domains)
18+
# If using a local domain like inference.example.com mapped to localhost, set to the domain without https://
19+
# Otherwise, set to: not-needed
20+
LOCAL_URL_ENDPOINT=not-needed

PdfToPodcast/README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ AI-powered application that transforms PDF documents into engaging podcast-style
1111
- [Quick Start Deployment](#quick-start-deployment)
1212
- [User Interface](#user-interface)
1313
- [Troubleshooting](#troubleshooting)
14+
- [Additional Info](#additional-info)
1415

1516
---
1617

@@ -139,6 +140,22 @@ OpenAI API Key for text-to-speech:
139140
- Key format starts with `sk-proj-`
140141
- Requires access to TTS APIs
141142

143+
### Local Development Configuration
144+
145+
**For Local Testing Only (Optional)**
146+
147+
If you're testing with a local inference endpoint using a custom domain (e.g., `inference.example.com` mapped to localhost in your hosts file):
148+
149+
1. Edit `api/llm-service/.env` and set:
150+
```bash
151+
LOCAL_URL_ENDPOINT=inference.example.com
152+
```
153+
(Use the domain name from your INFERENCE_API_ENDPOINT without `https://`)
154+
155+
2. This allows Docker containers to resolve your local domain correctly.
156+
157+
**Note:** For public domains or cloud-hosted endpoints, leave the default value `not-needed`.
158+
142159
---
143160

144161
## Quick Start Deployment
@@ -311,3 +328,12 @@ docker compose down -v
311328
For detailed troubleshooting guidance and solutions to common issues, refer to:
312329

313330
[TROUBLESHOOTING_and_ADDITIONAL_INFO.md](./TROUBLESHOOTING_and_ADDITIONAL_INFO.md)
331+
332+
## Additional Info
333+
334+
The following models have been validated with pdf-podcast:
335+
336+
| Model | Hardware |
337+
|-------|----------|
338+
| **deepseek-ai/DeepSeek-R1-Distill-Qwen-32B** | Gaudi |
339+
| **Qwen/Qwen3-4B-Instruct-2507** | Xeon |

PdfToPodcast/api/llm-service/.env.example

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,3 +21,9 @@ DEFAULT_MAX_LENGTH=2000
2121
TEMPERATURE=0.7
2222
MAX_TOKENS=4000
2323
MAX_RETRIES=3
24+
25+
# Local URL Endpoint (only needed for non-public domains)
26+
# If using a local domain like inference.example.com mapped to localhost:
27+
# Set this to: inference.example.com (domain without https://)
28+
# If using a public domain, set any placeholder value like: not-needed
29+
LOCAL_URL_ENDPOINT=not-needed

PdfToPodcast/docker-compose.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ services:
2525
- ./api/llm-service:/app
2626
networks:
2727
- app_network
28+
extra_hosts:
29+
- "${LOCAL_URL_ENDPOINT}:host-gateway"
2830
restart: unless-stopped
2931

3032
tts-service:

PdfToPodcast/ui/Dockerfile

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,8 @@ FROM node:18
33
# Set the working directory
44
WORKDIR /app
55

6-
# Copy package.json and package-lock.json
6+
# Copy package.json
77
COPY package.json ./
8-
COPY package-lock.json ./
98

109
# Install dependencies
1110
RUN npm install

0 commit comments

Comments
 (0)