Open WebUI as a Tool

EveryoneUpdated 11 Jun 2024LLM & Open WebUI
Open WebUI as a Tool
Overview

This guide explains how to deploy Open WebUI as a tool within a project on the GRACE AI platform. It covers adding a new deployment, configuring settings, allocating resources, upgrading, and deleting deployments.

User Guide
Step 1: Navigate to Tools in Your GRACE Project
  1. Go to the project you have created on the GRACE AI platform.
  2. Under the Envelops section, select Tools.
  3. View the list of already deployed tools.
Step 2: Add a New Open WebUI Deployment
  1. Click Add Tool.
  2. Enter a name for your deployment (e.g., "Chat UI").
  3. Select the image version of Open WebUI you wish to deploy (choose from current or previous versions).
  4. Optionally, add a Terms and Conditions page (string format expected).
  5. Configure authentication:
    • GRACE: Use GRACE authentication.
    • Realm: Select a specific realm for authentication (choose the realm to connect to).
  6. Set additional parameters:
    • Retention Days: Specify how long messages and data are retained (e.g., 5 or 10 days). Leave empty for unlimited retention.
    • Max Chat Count per User: Limit the number of chats per user to control LLM usage.
  7. Allocate resources for the deployment:
    • Minimum recommended: 1 CPU and 2 GB of memory for Open WebUI.
  8. Click Create to deploy. The deployment process takes approximately 2–3 minutes.
  9. Once deployed, you can view details such as version, access URL, owner, deployment time, and estimated cost.
Step 3: Upgrade an Existing Deployment
  1. Select the deployment you wish to upgrade.
  2. Click Edit.
  3. Select the new image version (e.g., upgrade to version 1.3 if available).
  4. Click Save to redeploy. The upgrade process takes 2–3 minutes, and data will be restored as before.
Step 4: Delete a Deployment
  1. Select the tool you wish to delete.
  2. Click Delete to remove the deployment from your project.
Summary
  • Deploy Open WebUI as a tool on any GRACE AI project using the Tools section.
  • Configure authentication, retention, chat limits, and resource allocation as needed.
  • Easily upgrade or delete deployments as your project evolves.
  • More tools will be available in future GRACE platform releases.