Skip to content

Commit d99a5d4

Browse files
committed
docs: add Open WebUI integration documentation
- Add OPENWEBUI_API_URL and OPENWEBUI_API_KEY to .env.example - Document Open WebUI integration in CONFIGURATION.md - Add feature to README.md
1 parent 61a328c commit d99a5d4

3 files changed

Lines changed: 27 additions & 1 deletion

File tree

.env.example

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,18 @@ FILTER_IMAGE_MODELS=true
5353
# Cache TTL for model list in seconds (default: 3600 = 1 hour)
5454
MODEL_CACHE_TTL=3600
5555

56+
# -----------------------------------------------------------------------------
57+
# Open WebUI Integration (Optional)
58+
# -----------------------------------------------------------------------------
59+
# When configured, images are uploaded to Open WebUI's file storage.
60+
# This ensures images are accessible from anywhere (internal/external).
61+
62+
# Open WebUI instance URL (e.g., https://chat.mydomain.com)
63+
OPENWEBUI_API_URL=
64+
65+
# API key from Open WebUI (Settings > Account > API Keys)
66+
OPENWEBUI_API_KEY=
67+
5668
# -----------------------------------------------------------------------------
5769
# Server Configuration
5870
# -----------------------------------------------------------------------------

CONFIGURATION.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,20 @@ Complete configuration reference for the Image Generation API.
5050
- Example: `gpt-image-1`, `dall-e-3`
5151
- Optional - if not set, first available model is used
5252

53+
### Open WebUI Integration
54+
55+
**`OPENWEBUI_API_URL`**
56+
- Open WebUI instance URL
57+
- Example: `https://chat.mydomain.com`
58+
- When set (with API key), images are uploaded to Open WebUI's file storage
59+
60+
**`OPENWEBUI_API_KEY`**
61+
- API key from Open WebUI
62+
- Get from: Open WebUI Settings > Account > API Keys
63+
- Required together with `OPENWEBUI_API_URL`
64+
65+
When both are configured, images are automatically uploaded to Open WebUI. This ensures images work from anywhere - no more URL accessibility issues with Docker or external access.
66+
5367
### Security
5468

5569
**`API_BEARER_TOKEN`**

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ OpenAPI server for AI image generation and editing. Supports LiteLLM proxy (for
88
- **Image Editing**: Edit existing images with mask-based inpainting (OpenAI) or prompt-based editing (Gemini)
99
- **Multi-Provider**: OpenAI (DALL-E 3, GPT-Image-1) and Google Gemini
1010
- **LiteLLM Integration**: Unified API with cost tracking
11+
- **Open WebUI Integration**: Auto-upload images to Open WebUI's file storage
1112
- **Dynamic Models**: Auto-discovers available models from LiteLLM
12-
- **Multiple Response Formats**: URL, base64, or markdown
1313

1414
## Quick Start
1515

0 commit comments

Comments
 (0)