summaryrefslogtreecommitdiff
path: root/openwebui/README.md
diff options
context:
space:
mode:
authorTyler Hoang <tyler@tylerhoang.xyz>2026-07-09 21:49:56 -0700
committerTyler Hoang <tyler@tylerhoang.xyz>2026-07-09 21:49:56 -0700
commit1d043702ef136e8f2e516c5304a57be5718f1f6f (patch)
tree9b3ad070f11dad5994c58acd41a15db8043745aa /openwebui/README.md
Initial commit: docker compose files for all self-hosted servicesHEADmaster
12 services: adguard, ampache, azuracast, flood, glance, glances, grafana, immich, invidious, jellyfin, openwebui, watchtower Each service includes a docker-compose.yml, README.md with setup instructions, and .env.example where applicable.
Diffstat (limited to 'openwebui/README.md')
-rw-r--r--openwebui/README.md35
1 files changed, 35 insertions, 0 deletions
diff --git a/openwebui/README.md b/openwebui/README.md
new file mode 100644
index 0000000..dd8de37
--- /dev/null
+++ b/openwebui/README.md
@@ -0,0 +1,35 @@
+# Open WebUI
+
+Self-hosted web interface for interacting with LLMs (Ollama, OpenAI-compatible APIs, etc.).
+
+Includes:
+- **Open WebUI** — Main chat interface
+- **Open Terminal** — Browser-based terminal
+- **Apache Tika** — Document parsing for RAG
+
+## Setup
+
+1. Copy `.env.example` to `.env` and set your API key:
+ ```
+ cp .env.example .env
+ ```
+
+2. Start:
+ ```
+ docker compose up -d
+ ```
+
+## Access
+
+| Service | URL |
+|---------------|--------------------------|
+| Open WebUI | `http://<host>:3000` |
+| Open Terminal | `http://<host>:8001` |
+| Tika | `http://<host>:9998` |
+
+## What to Configure
+
+- **`.env`** — Set `OPEN_TERMINAL_API_KEY` to a secure random string.
+- **Ollama / LLM backend** — The `host.docker.internal` extra host is configured to reach a local Ollama instance. If your LLM backend runs elsewhere, update the host or add environment variables like `OPENAI_API_BASE_URL`.
+- **RAG settings** — `RAG_EMBEDDING_ENGINE=openai` uses OpenAI-compatible embeddings. Change if using a different engine.
+- **Persistent volumes** — `open-webui` and `open-terminal` are named Docker volumes. Data persists across container restarts.