ruflo 3.42.1 → 3.42.3

package/src/ruvocal/docs/source/configuration/overview.md

@@ -1,89 +1,89 @@
-# Configuration Overview
-
-Chat UI is configured through environment variables. Default values are in `.env`; override them in `.env.local` or via your environment.
-
-## Required Configuration
-
-Chat UI connects to any OpenAI-compatible API endpoint:
-
-```ini
-OPENAI_BASE_URL=https://router.huggingface.co/v1
-OPENAI_API_KEY=hf_************************
-```
-
-Models are automatically discovered from `${OPENAI_BASE_URL}/models`. No manual model configuration is required.
-
-## Database
-
-```ini
-MONGODB_URL=mongodb://localhost:27017
-MONGODB_DB_NAME=chat-ui
-```
-
-For development, `MONGODB_URL` is optional - Chat UI falls back to an embedded MongoDB that persists to `./db`.
-
-## Model Overrides
-
-To customize model behavior, use the `MODELS` environment variable (JSON5 format):
-
-```ini
-MODELS=`[
-  {
-    "id": "meta-llama/Llama-3.3-70B-Instruct",
-    "name": "Llama 3.3 70B",
-    "multimodal": false,
-    "supportsTools": true
-  }
-]`
-```
-
-Override properties:
-
-- `id` - Model identifier (must match an ID from the `/models` endpoint)
-- `name` - Display name in the UI
-- `multimodal` - Enable image uploads
-- `supportsTools` - Enable MCP tool calling for models that don’t advertise tool support
-- `parameters` - Override default parameters (temperature, max_tokens, etc.)
-
-## Task Model
-
-Set a specific model for internal tasks (title generation, etc.):
-
-```ini
-TASK_MODEL=meta-llama/Llama-3.1-8B-Instruct
-```
-
-If not set, the current conversation model is used.
-
-## Voice Transcription
-
-Enable voice input with Whisper:
-
-```ini
-TRANSCRIPTION_MODEL=openai/whisper-large-v3-turbo
-TRANSCRIPTION_BASE_URL=https://router.huggingface.co/hf-inference/models
-```
-
-## Feature Flags
-
-```ini
-LLM_SUMMARIZATION=true          # Enable automatic conversation title generation
-ENABLE_DATA_EXPORT=true         # Allow users to export their data
-ALLOW_IFRAME=false              # Disallow embedding in iframes (set to true to allow)
-```
-
-## User Authentication
-
-Use OpenID Connect for authentication:
-
-```ini
-OPENID_CLIENT_ID=your_client_id
-OPENID_CLIENT_SECRET=your_client_secret
-OPENID_SCOPES="openid profile"
-```
-
-See [OpenID configuration](./open-id) for details.
-
-## Environment Variable Reference
-
-See the [`.env` file](https://github.com/huggingface/chat-ui/blob/main/.env) for the complete list of available options.
+# Configuration Overview
+
+Chat UI is configured through environment variables. Default values are in `.env`; override them in `.env.local` or via your environment.
+
+## Required Configuration
+
+Chat UI connects to any OpenAI-compatible API endpoint:
+
+```ini
+OPENAI_BASE_URL=https://router.huggingface.co/v1
+OPENAI_API_KEY=hf_************************
+```
+
+Models are automatically discovered from `${OPENAI_BASE_URL}/models`. No manual model configuration is required.
+
+## Database
+
+```ini
+MONGODB_URL=mongodb://localhost:27017
+MONGODB_DB_NAME=chat-ui
+```
+
+For development, `MONGODB_URL` is optional - Chat UI falls back to an embedded MongoDB that persists to `./db`.
+
+## Model Overrides
+
+To customize model behavior, use the `MODELS` environment variable (JSON5 format):
+
+```ini
+MODELS=`[
+  {
+    "id": "meta-llama/Llama-3.3-70B-Instruct",
+    "name": "Llama 3.3 70B",
+    "multimodal": false,
+    "supportsTools": true
+  }
+]`
+```
+
+Override properties:
+
+- `id` - Model identifier (must match an ID from the `/models` endpoint)
+- `name` - Display name in the UI
+- `multimodal` - Enable image uploads
+- `supportsTools` - Enable MCP tool calling for models that don’t advertise tool support
+- `parameters` - Override default parameters (temperature, max_tokens, etc.)
+
+## Task Model
+
+Set a specific model for internal tasks (title generation, etc.):
+
+```ini
+TASK_MODEL=meta-llama/Llama-3.1-8B-Instruct
+```
+
+If not set, the current conversation model is used.
+
+## Voice Transcription
+
+Enable voice input with Whisper:
+
+```ini
+TRANSCRIPTION_MODEL=openai/whisper-large-v3-turbo
+TRANSCRIPTION_BASE_URL=https://router.huggingface.co/hf-inference/models
+```
+
+## Feature Flags
+
+```ini
+LLM_SUMMARIZATION=true          # Enable automatic conversation title generation
+ENABLE_DATA_EXPORT=true         # Allow users to export their data
+ALLOW_IFRAME=false              # Disallow embedding in iframes (set to true to allow)
+```
+
+## User Authentication
+
+Use OpenID Connect for authentication:
+
+```ini
+OPENID_CLIENT_ID=your_client_id
+OPENID_CLIENT_SECRET=your_client_secret
+OPENID_SCOPES="openid profile"
+```
+
+See [OpenID configuration](./open-id) for details.
+
+## Environment Variable Reference
+
+See the [`.env` file](https://github.com/huggingface/chat-ui/blob/main/.env) for the complete list of available options.

package/src/ruvocal/docs/source/configuration/theming.md

@@ -1,20 +1,20 @@
-# Theming
-
-Customize the look and feel of Chat UI with these environment variables:
-
-```ini
-PUBLIC_APP_NAME=ChatUI
-PUBLIC_APP_ASSETS=chatui
-PUBLIC_APP_DESCRIPTION="Making the community's best AI chat models available to everyone."
-```
-
-- `PUBLIC_APP_NAME` - The name used as a title throughout the app
-- `PUBLIC_APP_ASSETS` - Directory for logos & favicons in `static/$PUBLIC_APP_ASSETS`. Options: `chatui`, `huggingchat`
-- `PUBLIC_APP_DESCRIPTION` - Description shown in meta tags and about sections
-
-## Additional Options
-
-```ini
-PUBLIC_APP_DATA_SHARING=1    # Show data sharing opt-in toggle in settings
-PUBLIC_ORIGIN=https://chat.example.com  # Your public URL (required for sharing)
-```
+# Theming
+
+Customize the look and feel of Chat UI with these environment variables:
+
+```ini
+PUBLIC_APP_NAME=ChatUI
+PUBLIC_APP_ASSETS=chatui
+PUBLIC_APP_DESCRIPTION="Making the community's best AI chat models available to everyone."
+```
+
+- `PUBLIC_APP_NAME` - The name used as a title throughout the app
+- `PUBLIC_APP_ASSETS` - Directory for logos & favicons in `static/$PUBLIC_APP_ASSETS`. Options: `chatui`, `huggingchat`
+- `PUBLIC_APP_DESCRIPTION` - Description shown in meta tags and about sections
+
+## Additional Options
+
+```ini
+PUBLIC_APP_DATA_SHARING=1    # Show data sharing opt-in toggle in settings
+PUBLIC_ORIGIN=https://chat.example.com  # Your public URL (required for sharing)
+```

package/src/ruvocal/docs/source/developing/architecture.md

@@ -1,48 +1,48 @@
-# Architecture
-
-This document provides a high-level overview of the Chat UI codebase. If you're looking to contribute or understand how the codebase works, this is the place for you!
-
-## Overview
-
-Chat UI provides a simple interface connecting LLMs to external tools via MCP. The project uses [MongoDB](https://www.mongodb.com/) and [SvelteKit](https://kit.svelte.dev/) with [Tailwind](https://tailwindcss.com/).
-
-Key architectural decisions:
-
-- **OpenAI-compatible only**: All model interactions use the OpenAI API format
-- **MCP for tools**: Tool calling is handled via Model Context Protocol servers
-- **Auto-discovery**: Models are discovered from the `/models` endpoint
-
-## Code Map
-
-### `routes`
-
-All routes rendered with SSR via SvelteKit. The majority of backend and frontend logic lives here, with shared modules in `lib` (client) and `lib/server` (server).
-
-### `textGeneration`
-
-Provides a standard interface for chat features including model output, tool calls, and streaming. Outputs `MessageUpdate`s for fine-grained status updates (new tokens, tool results, etc.).
-
-### `endpoints`
-
-Provides the streaming interface for OpenAI-compatible endpoints. Models are fetched and cached from `${OPENAI_BASE_URL}/models`.
-
-### `mcp`
-
-Implements MCP client functionality for tool discovery and execution. See [MCP Tools](../configuration/mcp-tools) for configuration.
-
-### `llmRouter`
-
-Intelligent routing logic that selects the best model for each request. Uses the Arch router model for classification. See [LLM Router](../configuration/llm-router) for details.
-
-### `migrations`
-
-MongoDB migrations for maintaining backwards compatibility across schema changes. Any schema changes must include a migration.
-
-## Development
-
-```bash
-npm install
-npm run dev
-```
-
-The dev server runs at `http://localhost:5173` with hot reloading.
+# Architecture
+
+This document provides a high-level overview of the Chat UI codebase. If you're looking to contribute or understand how the codebase works, this is the place for you!
+
+## Overview
+
+Chat UI provides a simple interface connecting LLMs to external tools via MCP. The project uses [MongoDB](https://www.mongodb.com/) and [SvelteKit](https://kit.svelte.dev/) with [Tailwind](https://tailwindcss.com/).
+
+Key architectural decisions:
+
+- **OpenAI-compatible only**: All model interactions use the OpenAI API format
+- **MCP for tools**: Tool calling is handled via Model Context Protocol servers
+- **Auto-discovery**: Models are discovered from the `/models` endpoint
+
+## Code Map
+
+### `routes`
+
+All routes rendered with SSR via SvelteKit. The majority of backend and frontend logic lives here, with shared modules in `lib` (client) and `lib/server` (server).
+
+### `textGeneration`
+
+Provides a standard interface for chat features including model output, tool calls, and streaming. Outputs `MessageUpdate`s for fine-grained status updates (new tokens, tool results, etc.).
+
+### `endpoints`
+
+Provides the streaming interface for OpenAI-compatible endpoints. Models are fetched and cached from `${OPENAI_BASE_URL}/models`.
+
+### `mcp`
+
+Implements MCP client functionality for tool discovery and execution. See [MCP Tools](../configuration/mcp-tools) for configuration.
+
+### `llmRouter`
+
+Intelligent routing logic that selects the best model for each request. Uses the Arch router model for classification. See [LLM Router](../configuration/llm-router) for details.
+
+### `migrations`
+
+MongoDB migrations for maintaining backwards compatibility across schema changes. Any schema changes must include a migration.
+
+## Development
+
+```bash
+npm install
+npm run dev
+```
+
+The dev server runs at `http://localhost:5173` with hot reloading.

package/src/ruvocal/docs/source/index.md

@@ -1,53 +1,53 @@
-# Chat UI
-
-Open source chat interface with support for tools, multimodal inputs, and intelligent routing across models. The app uses MongoDB and SvelteKit behind the scenes. Try the live version called [HuggingChat on hf.co/chat](https://huggingface.co/chat) or [setup your own instance](./installation/local).
-
-Chat UI connects to any OpenAI-compatible API endpoint, making it work with:
-
-- [Hugging Face Inference Providers](https://huggingface.co/docs/inference-providers)
-- [Ollama](https://ollama.ai)
-- [llama.cpp](https://github.com/ggerganov/llama.cpp)
-- [OpenRouter](https://openrouter.ai)
-- Any other OpenAI-compatible service
-
-**[MCP Tools](./configuration/mcp-tools)**: Function calling via Model Context Protocol (MCP) servers
-
-**[LLM Router](./configuration/llm-router)**: Intelligent routing to select the best model for each request
-
-**[Multimodal](./configuration/overview)**: Image uploads on models that support vision
-
-**[OpenID](./configuration/open-id)**: Optional user authentication via OpenID Connect
-
-## Quickstart
-
-**Step 1 - Create `.env.local`:**
-
-```ini
-OPENAI_BASE_URL=https://router.huggingface.co/v1
-OPENAI_API_KEY=hf_************************
-```
-
-You can use any OpenAI-compatible endpoint:
-
-| Provider     | `OPENAI_BASE_URL`                  | `OPENAI_API_KEY` |
-| ------------ | ---------------------------------- | ---------------- |
-| Hugging Face | `https://router.huggingface.co/v1` | `hf_xxx`         |
-| Ollama       | `http://127.0.0.1:11434/v1`        | `ollama`         |
-| llama.cpp    | `http://127.0.0.1:8080/v1`         | `sk-local`       |
-| OpenRouter   | `https://openrouter.ai/api/v1`     | `sk-or-v1-xxx`   |
-
-**Step 2 - Install and run:**
-
-```bash
-git clone https://github.com/huggingface/chat-ui
-cd chat-ui
-npm install
-npm run dev -- --open
-```
-
-That's it! Chat UI will automatically discover available models from your endpoint.
-
-> [!TIP]
-> MongoDB is optional for development. When `MONGODB_URL` is not set, Chat UI uses an embedded database that persists to `./db`.
-
-For production deployments, see the [installation guides](./installation/local).
+# Chat UI
+
+Open source chat interface with support for tools, multimodal inputs, and intelligent routing across models. The app uses MongoDB and SvelteKit behind the scenes. Try the live version called [HuggingChat on hf.co/chat](https://huggingface.co/chat) or [setup your own instance](./installation/local).
+
+Chat UI connects to any OpenAI-compatible API endpoint, making it work with:
+
+- [Hugging Face Inference Providers](https://huggingface.co/docs/inference-providers)
+- [Ollama](https://ollama.ai)
+- [llama.cpp](https://github.com/ggerganov/llama.cpp)
+- [OpenRouter](https://openrouter.ai)
+- Any other OpenAI-compatible service
+
+**[MCP Tools](./configuration/mcp-tools)**: Function calling via Model Context Protocol (MCP) servers
+
+**[LLM Router](./configuration/llm-router)**: Intelligent routing to select the best model for each request
+
+**[Multimodal](./configuration/overview)**: Image uploads on models that support vision
+
+**[OpenID](./configuration/open-id)**: Optional user authentication via OpenID Connect
+
+## Quickstart
+
+**Step 1 - Create `.env.local`:**
+
+```ini
+OPENAI_BASE_URL=https://router.huggingface.co/v1
+OPENAI_API_KEY=hf_************************
+```
+
+You can use any OpenAI-compatible endpoint:
+
+| Provider     | `OPENAI_BASE_URL`                  | `OPENAI_API_KEY` |
+| ------------ | ---------------------------------- | ---------------- |
+| Hugging Face | `https://router.huggingface.co/v1` | `hf_xxx`         |
+| Ollama       | `http://127.0.0.1:11434/v1`        | `ollama`         |
+| llama.cpp    | `http://127.0.0.1:8080/v1`         | `sk-local`       |
+| OpenRouter   | `https://openrouter.ai/api/v1`     | `sk-or-v1-xxx`   |
+
+**Step 2 - Install and run:**
+
+```bash
+git clone https://github.com/huggingface/chat-ui
+cd chat-ui
+npm install
+npm run dev -- --open
+```
+
+That's it! Chat UI will automatically discover available models from your endpoint.
+
+> [!TIP]
+> MongoDB is optional for development. When `MONGODB_URL` is not set, Chat UI uses an embedded database that persists to `./db`.
+
+For production deployments, see the [installation guides](./installation/local).

package/src/ruvocal/docs/source/installation/docker.md

@@ -1,43 +1,43 @@
-# Running on Docker
-
-Pre-built Docker images are available:
-
-- **`ghcr.io/huggingface/chat-ui-db`** - Includes MongoDB (recommended for quick setup)
-- **`ghcr.io/huggingface/chat-ui`** - Requires external MongoDB
-
-## Quick Start (with bundled MongoDB)
-
-```bash
-docker run -p 3000:3000 \
-  -e OPENAI_BASE_URL=https://router.huggingface.co/v1 \
-  -e OPENAI_API_KEY=hf_*** \
-  -v chat-ui-data:/data \
-  ghcr.io/huggingface/chat-ui-db
-```
-
-## With External MongoDB
-
-If you have an existing MongoDB instance:
-
-```bash
-docker run -p 3000:3000 \
-  -e OPENAI_BASE_URL=https://router.huggingface.co/v1 \
-  -e OPENAI_API_KEY=hf_*** \
-  -e MONGODB_URL=mongodb://host.docker.internal:27017 \
-  ghcr.io/huggingface/chat-ui
-```
-
-Use `host.docker.internal` to reach MongoDB running on your host machine, or provide your MongoDB Atlas connection string.
-
-## Using an Environment File
-
-For more configuration options, use `--env-file` to avoid leaking secrets in shell history:
-
-```bash
-docker run -p 3000:3000 \
-  --env-file .env.local \
-  -v chat-ui-data:/data \
-  ghcr.io/huggingface/chat-ui-db
-```
-
-See the [configuration overview](../configuration/overview) for all available environment variables.
+# Running on Docker
+
+Pre-built Docker images are available:
+
+- **`ghcr.io/huggingface/chat-ui-db`** - Includes MongoDB (recommended for quick setup)
+- **`ghcr.io/huggingface/chat-ui`** - Requires external MongoDB
+
+## Quick Start (with bundled MongoDB)
+
+```bash
+docker run -p 3000:3000 \
+  -e OPENAI_BASE_URL=https://router.huggingface.co/v1 \
+  -e OPENAI_API_KEY=hf_*** \
+  -v chat-ui-data:/data \
+  ghcr.io/huggingface/chat-ui-db
+```
+
+## With External MongoDB
+
+If you have an existing MongoDB instance:
+
+```bash
+docker run -p 3000:3000 \
+  -e OPENAI_BASE_URL=https://router.huggingface.co/v1 \
+  -e OPENAI_API_KEY=hf_*** \
+  -e MONGODB_URL=mongodb://host.docker.internal:27017 \
+  ghcr.io/huggingface/chat-ui
+```
+
+Use `host.docker.internal` to reach MongoDB running on your host machine, or provide your MongoDB Atlas connection string.
+
+## Using an Environment File
+
+For more configuration options, use `--env-file` to avoid leaking secrets in shell history:
+
+```bash
+docker run -p 3000:3000 \
+  --env-file .env.local \
+  -v chat-ui-data:/data \
+  ghcr.io/huggingface/chat-ui-db
+```
+
+See the [configuration overview](../configuration/overview) for all available environment variables.

package/src/ruvocal/docs/source/installation/helm.md

@@ -1,43 +1,43 @@
-# Helm
-
-<Tip warning={true}>
-
-The Helm chart is a work in progress and should be considered unstable. Breaking changes may be pushed without migration guides. Contributions welcome!
-
-</Tip>
-
-For Kubernetes deployment, use the Helm chart in `/chart`. No chart repository is published, so clone the repository and install by path.
-
-## Installation
-
-```bash
-git clone https://github.com/huggingface/chat-ui
-cd chat-ui
-helm install chat-ui ./chart -f values.yaml
-```
-
-## Example values.yaml
-
-```yaml
-replicas: 1
-
-domain: example.com
-
-service:
-  type: ClusterIP
-
-resources:
-  requests:
-    cpu: 100m
-    memory: 2Gi
-  limits:
-    cpu: "4"
-    memory: 6Gi
-
-envVars:
-  OPENAI_BASE_URL: https://router.huggingface.co/v1
-  OPENAI_API_KEY: hf_***
-  MONGODB_URL: mongodb://chat-ui-mongo:27017
-```
-
-See the [configuration overview](../configuration/overview) for all available environment variables.
+# Helm
+
+<Tip warning={true}>
+
+The Helm chart is a work in progress and should be considered unstable. Breaking changes may be pushed without migration guides. Contributions welcome!
+
+</Tip>
+
+For Kubernetes deployment, use the Helm chart in `/chart`. No chart repository is published, so clone the repository and install by path.
+
+## Installation
+
+```bash
+git clone https://github.com/huggingface/chat-ui
+cd chat-ui
+helm install chat-ui ./chart -f values.yaml
+```
+
+## Example values.yaml
+
+```yaml
+replicas: 1
+
+domain: example.com
+
+service:
+  type: ClusterIP
+
+resources:
+  requests:
+    cpu: 100m
+    memory: 2Gi
+  limits:
+    cpu: "4"
+    memory: 6Gi
+
+envVars:
+  OPENAI_BASE_URL: https://router.huggingface.co/v1
+  OPENAI_API_KEY: hf_***
+  MONGODB_URL: mongodb://chat-ui-mongo:27017
+```
+
+See the [configuration overview](../configuration/overview) for all available environment variables.