libre-webui 0.7.0 → 0.8.0

package/README.md

@@ -26,7 +26,7 @@
   <img src="https://img.shields.io/badge/SOC_2-Ready-purple" alt="SOC 2 Ready">
 </p>
 
-[Website](https://librewebui.org) • [Documentation](https://docs.librewebui.org) • [𝕏](https://x.com/librewebui) • [Sponsor](https://github.com/sponsors/libre-webui) • [Get Started](#quick-start)
+[Website](https://librewebui.org) • [Documentation](https://docs.librewebui.org) • [GitLab](https://git.kroonen.ai/libre-webui/libre-webui) • [𝕏](https://x.com/librewebui) • [Sponsor](https://github.com/sponsors/libre-webui) • [Get Started](#quick-start)
 
 </div>
 
@@ -61,7 +61,9 @@ A simple, self-hosted interface for AI chat. Run it locally with Ollama, connect
 - **Local**: Ollama (full integration)
 - **Cloud**: OpenAI, Anthropic, Google, Groq, Mistral, OpenRouter, HuggingFace, and more
 - **HuggingFace Hub** — 1M+ models for chat, TTS, image gen, embeddings, STT
+- **Image Generation** — ComfyUI with Flux models
 - **Plugin System** — Add any OpenAI-compatible API via JSON config
+- **Plugin Variables** — Per-plugin configurable settings (temperature, endpoint, etc.)
 
 </td>
 <td width="50%">
@@ -205,6 +207,95 @@ ANTHROPIC_API_KEY=sk-ant-...
 HUGGINGFACE_API_KEY=hf_...
 ```
 
+---
+
+## Plugin System
+
+Plugins let you connect any OpenAI-compatible (or custom) API to Libre WebUI using a simple JSON file. Built-in plugins are included for OpenAI, Anthropic, Google Gemini, Groq, Mistral, OpenRouter, HuggingFace, and more.
+
+### How It Works
+
+A plugin is a JSON config file stored in the `plugins/` directory. Each plugin defines:
+
+- **Endpoint** — The API URL to send requests to
+- **Auth** — How to authenticate (header name, prefix, env variable fallback)
+- **Model map** — Which models the plugin supports
+- **Capabilities** — Optional multi-capability support (chat, TTS, image generation, embeddings, STT)
+- **Variables** — Per-plugin configurable settings users can adjust from the UI
+
+### Example Plugin
+
+```json
+{
+  "id": "my-provider",
+  "name": "My Provider",
+  "type": "completion",
+  "endpoint": "https://api.example.com/v1/chat/completions",
+  "auth": {
+    "header": "Authorization",
+    "prefix": "Bearer ",
+    "key_env": "MY_PROVIDER_API_KEY"
+  },
+  "model_map": ["model-a", "model-b"],
+  "variables": [
+    {
+      "name": "temperature",
+      "type": "number",
+      "label": "Temperature",
+      "description": "Controls randomness.",
+      "default": 0.7,
+      "min": 0,
+      "max": 2
+    }
+  ]
+}
+```
+
+### Plugin Management
+
+Plugins are managed from **Settings > Plugins** in the UI where you can:
+
+- **Upload** a JSON plugin file or paste JSON directly
+- **Browse HuggingFace** to discover and import models
+- **Activate/deactivate** plugins
+- **Set API keys** per plugin (encrypted at rest with AES-256-GCM, with env variable fallback)
+- **Configure variables** — override endpoint, temperature, max tokens, and other settings per plugin
+- **Export** plugins as JSON
+
+### Plugin Variables
+
+Variables are typed settings defined in the plugin JSON that users can configure from the UI. Supported types: `string`, `number`, `boolean`, `select`. Sensitive variables (like API keys) are encrypted in the database. Variable values are stored per-user.
+
+### Multi-Capability Plugins
+
+A single plugin can support multiple capabilities. For example, OpenAI's plugin handles both chat completions and TTS:
+
+```json
+{
+  "id": "openai",
+  "type": "completion",
+  "endpoint": "https://api.openai.com/v1/chat/completions",
+  "capabilities": {
+    "tts": {
+      "endpoint": "https://api.openai.com/v1/audio/speech",
+      "model_map": ["tts-1", "tts-1-hd"],
+      "config": {
+        "voices": ["alloy", "echo", "nova", "shimmer"],
+        "default_voice": "alloy"
+      }
+    }
+  }
+}
+```
+
+### Creating Custom Plugins
+
+To add a new provider, create a JSON file in the `plugins/` directory following the schema above, or upload one through the UI. Any OpenAI-compatible API works out of the box — just set the correct endpoint and auth config.
+
+For the full plugin reference (variables, credentials, security, API endpoints), see the [Plugin Architecture docs](./docs/08-PLUGIN_ARCHITECTURE.md).
+
+---
+
 ### 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!
@@ -252,6 +343,7 @@ Download the native desktop app from [GitHub Releases](https://github.com/libre-
 - [Contributing](https://github.com/libre-webui/libre-webui/contribute) — Help improve Libre WebUI
 - [𝕏 @librewebui](https://x.com/librewebui) — Follow for updates
 - [Mastodon](https://fosstodon.org/@librewebui) — Fediverse updates
+- [GitLab](https://git.kroonen.ai/libre-webui/libre-webui) — Self-hosted mirror
 - [GitHub Issues](https://github.com/libre-webui/libre-webui/issues) — Bug reports & feature requests
 - [Documentation](https://docs.librewebui.org) — Guides & API reference
 

package/backend/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAkBA,OAAO,UAAU,CAAC;AA6ElB,QAAA,MAAM,GAAG,6CAAY,CAAC;AA4jCtB,eAAe,GAAG,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAkBA,OAAO,UAAU,CAAC;AAkFlB,QAAA,MAAM,GAAG,6CAAY,CAAC;AAkgDtB,eAAe,GAAG,CAAC"}