Skip to content

issue: TOOL_SERVER_CONNECTIONS env var not documented #609

@zachwalton

Description

@zachwalton

Check Existing Issues

  • I have searched the existing issues and discussions.
  • I am using the latest version of Open WebUI.

Installation Method

Git Clone

Open WebUI Version

dev commit 372836c

Ollama Version (if applicable)

No response

Operating System

MacOS Sequoia

Browser (if applicable)

Safari

Confirmation

  • I have read and followed all instructions in README.md.
  • I am using the latest version of both Open WebUI and Ollama.
  • I have included the browser console logs.
  • I have included the Docker container logs.
  • I have provided every relevant configuration, setting, and environment variable used in my setup.
  • I have clearly listed every relevant configuration, custom setting, environment variable, and command-line option that influences my setup (such as Docker Compose overrides, .env values, browser settings, authentication configurations, etc).
  • I have documented step-by-step reproduction instructions that are precise, sequential, and leave nothing to interpretation. My steps:
  • Start with the initial platform/version/OS and dependencies used,
  • Specify exact install/launch/configure commands,
  • List URLs visited, user input (incl. example values/emails/passwords if needed),
  • Describe all options and toggles enabled or changed,
  • Include any files or environmental changes,
  • Identify the expected and actual result at each stage,
  • Ensure any reasonably skilled user can follow and hit the same issue.

Expected Behavior

Configure tool server in UI, tool server persists and is usable

Actual Behavior

Due to ENABLE_PERSISTENT_CONFIG=false, the tool servers I configure in the UI vanish after saving and refreshing.

Digging through the changelog and code, I found that a TOOL_SERVER_CONNECTIONS variable was recently added. I sorted out how to construct it by reading through code and ended up with:

        - name: TOOL_SERVER_CONNECTIONS
          value: '[{"url": "http://localhost:8081", "path": "/some-server", "auth_type":
            "bearer", "key": "your-api-key", "config": {"enable": true}, "info": {"name":
            "Some Server", "description": "Some tool server"}}]'

After restarting Open WebUI with this config, the tool server is now available in the UI.

Steps to Reproduce

  1. Check out commit referenced in the description
  2. Start instance with ENABLE_PERSISTENT_CONFIG=false`
  3. Configure in the UI, watch it vanish

Logs & Screenshots

N/A

Additional Information

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions