libre-webui 0.3.1 → 0.3.2

package/README.md

@@ -96,20 +96,67 @@ npx libre-webui
 
 That's it. Opens at `http://localhost:8080`
 
-**Options:**
+### Docker
+
+| Setup                                     | Command                                                      |
+| ----------------------------------------- | ------------------------------------------------------------ |
+| Bundled Ollama (CPU)                      | `docker-compose up -d`                                       |
+| Bundled Ollama (NVIDIA GPU)               | `docker-compose -f docker-compose.gpu.yml up -d`             |
+| External Ollama (already running on host) | `docker-compose -f docker-compose.external-ollama.yml up -d` |
+
+Access at `http://localhost:8080`
+
+<details>
+<summary><strong>Development builds (unstable)</strong></summary>
+
+> **Warning:** Development builds are automatically generated from the `dev` branch and may contain experimental features, breaking changes, or bugs. Use at your own risk and do not use in production environments.
+
+| Setup                             | Command                                                          |
+| --------------------------------- | ---------------------------------------------------------------- |
+| Dev + Bundled Ollama (CPU)        | `docker-compose -f docker-compose.dev.yml up -d`                 |
+| Dev + Bundled Ollama (NVIDIA GPU) | `docker-compose -f docker-compose.dev.gpu.yml up -d`             |
+| Dev + External Ollama             | `docker-compose -f docker-compose.dev.external-ollama.yml up -d` |
+
+Development builds use separate data volumes (`libre_webui_dev_data`) to prevent conflicts with stable installations.
+
+To pull the latest dev image manually:
 
 ```bash
-npx libre-webui --port 3000      # Custom port
-npx libre-webui --help           # Show all options
+docker pull librewebui/libre-webui:dev
 ```
 
-**Environment variables:**
+</details>
+
+### Kubernetes (Helm)
 
 ```bash
-OPENAI_API_KEY=sk-... npx libre-webui
-ANTHROPIC_API_KEY=sk-ant-... npx libre-webui
+helm install libre-webui oci://ghcr.io/libre-webui/charts/libre-webui
 ```
 
+<details>
+<summary><strong>Helm configuration options</strong></summary>
+
+```bash
+# With external Ollama
+helm install libre-webui oci://ghcr.io/libre-webui/charts/libre-webui \
+  --set ollama.bundled.enabled=false \
+  --set ollama.external.enabled=true \
+  --set ollama.external.url=http://my-ollama:11434
+
+# With NVIDIA GPU support
+helm install libre-webui oci://ghcr.io/libre-webui/charts/libre-webui \
+  --set ollama.bundled.gpu.enabled=true
+
+# With Ingress
+helm install libre-webui oci://ghcr.io/libre-webui/charts/libre-webui \
+  --set ingress.enabled=true \
+  --set ingress.hosts[0].host=chat.example.com
+```
+
+See [helm/libre-webui/values.yaml](helm/libre-webui/values.yaml) for all configuration options.
+
+</details>
+
 ### Development Setup
 
 ```bash
@@ -135,23 +182,8 @@ OLLAMA_BASE_URL=http://localhost:11434
 # Cloud AI Providers (add the ones you need)
 OPENAI_API_KEY=sk-...
 ANTHROPIC_API_KEY=sk-ant-...
-GROQ_API_KEY=gsk_...
-GEMINI_API_KEY=...
-
-# Optional: Text-to-Speech
-ELEVENLABS_API_KEY=...
-```
-
-**Or with Docker** (requires Ollama running on host):
-
-```bash
-docker-compose -f docker-compose.external-ollama.yml up -d
 ```
 
-> A bundled `docker-compose.yml` with Ollama included exists but is untested.
-
-Access at `http://localhost:5173` (dev) or `http://localhost:8080` (Docker)
-
 ### Desktop App (In Development)
 
 > **Note:** The desktop app is currently in active development. The macOS build is pending Apple notarization, which may cause security warnings or installation issues on some systems. We're working to resolve this. Feedback and bug reports are welcome!