[PR #22567] [CLOSED] feat: add validation feedback for Open Terminal connections #81632

Closed
opened 2026-05-13 15:59:25 -05:00 by GiteaMirror · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/22567
Author: @silenceroom
Created: 3/11/2026
Status: Closed

Base: devHead: feature/terminal-validation-feedback


📝 Commits (4)

  • 7cb3a48 feat: add verify button for terminal server connections
  • cf76aef feat: add error toast notifications for terminal connections
  • a697153 i18n: add localization strings for terminal verification
  • 510c423 style: fix code formatting issues

📊 Changes

6 files changed (+246 additions, -2 deletions)

View changed files

📝 src/lib/components/AddTerminalServerModal.svelte (+221 -0)
📝 src/lib/components/chat/MessageInput/TerminalMenu.svelte (+8 -1)
📝 src/lib/components/chat/Settings/Integrations.svelte (+7 -1)
📝 src/lib/i18n/locales/en-US/translation.json (+5 -0)
📝 src/lib/i18n/locales/zh-CN/translation.json (+5 -0)
src/lib/i18n/locales/zh-TW/.translation.json.swp (+0 -0)

📄 Description

Pull Request Checklist

Note to first-time contributors: Please open a discussion post in Discussions to discuss your idea/fix with the community before creating a pull request, and describe your changes before submitting a pull request.

This is to ensure large feature PRs are discussed with the community first, before starting work on it. If the community does not want this feature or it is not relevant for Open WebUI as a project, it can be identified in the discussion before working on the feature and submitting the PR.

Before submitting, make sure you've checked the following:

  • Target branch: Verify that the pull request targets the dev branch. PRs targeting main will be immediately closed.
  • Description: Provide a concise description of the changes made in this pull request down below.
  • Changelog: Ensure a changelog entry following the format of Keep a Changelog is added at the bottom of the PR description.
  • Documentation: Add docs in Open WebUI Docs Repository. Document user-facing behavior, environment variables, public APIs/interfaces, or deployment steps.
  • Dependencies: Are there any new or upgraded dependencies? If so, explain why, update the changelog/docs, and include any compatibility notes. Actually run the code/function that uses updated library to ensure it doesn't crash.
  • Testing: Perform manual tests to verify the implemented fix/feature works as intended AND does not break any other functionality. Include reproducible steps to demonstrate the issue before the fix. Test edge cases (URL encoding, HTML entities, types). Take this as an opportunity to make screenshots of the feature/fix and include them in the PR description.
  • Agentic AI Code: Confirm this Pull Request is not written by any AI Agent or has at least gone through additional human review AND manual testing. If any AI Agent is the co-author of this PR, it may lead to immediate closure of the PR.
  • Code review: Have you performed a self-review of your code, addressing any coding standard issues and ensuring adherence to the project's coding standards?
  • Design & Architecture: Prefer smart defaults over adding new settings; use local state for ephemeral UI logic. Open a Discussion for major architectural or UX changes.
  • Git Hygiene: Keep PRs atomic (one logical change). Clean up commits and rebase on dev to ensure no unrelated commits (e.g. from main) are included. Push updates to the existing PR branch instead of closing and reopening.
  • Title Prefix: To clearly categorize this pull request, prefix the pull request title using one of the following:
    • BREAKING CHANGE: Significant changes that may affect compatibility
    • build: Changes that affect the build system or external dependencies
    • ci: Changes to our continuous integration processes or workflows
    • chore: Refactor, cleanup, or other non-functional code changes
    • docs: Documentation update or addition
    • feat: Introduces a new feature or enhancement to the codebase
    • fix: Bug fix or error correction
    • i18n: Internationalization or localization changes
    • perf: Performance improvement
    • refactor: Code restructuring for better maintainability, readability, or scalability
    • style: Changes that do not affect the meaning of the code (white space, formatting, missing semi-colons, etc.)
    • test: Adding missing tests or correcting existing tests
    • WIP: Work in progress, a temporary label for incomplete or ongoing work

Changelog Entry

Description

  • This PR adds comprehensive validation feedback for Open Terminal connections, matching the validation experience provided for Tool Servers.

Added

Validation Button

  • Added verify button in terminal server configuration modal (URL input field)
  • Shows loading spinner during validation
  • Located next to URL input for easy access

Multi-Endpoint Authentication Validation

  • Validates API key by testing multiple terminal endpoints
  • Tests /browse/, /info, and /execute endpoints
  • Supports Bearer, Session, and None authentication types
  • Provides detailed error feedback for each failure case

Error Feedback

  • Empty API Key: "API Key is required for Bearer authentication"
  • Wrong API Key: "Invalid API Key or authentication failed"
  • Network Issues: "Failed to connect to terminal server"
  • Success: "Connection successful"

Translations

  • Added 5 new translation keys in English and Chinese
  • All error messages are properly localized

Changed

  • AddTerminalServerModal.svelte: Add verify button and validation logic
  • Integrations.svelte: Add error toast for connection failures
  • TerminalMenu.svelte: Add error feedback for terminal selection
  • en-US/translation.json: Added English translations
  • zh-CN/translation.json: Added Chinese translations

Deprecated

  • None

Removed

  • None

Security

  • None

Breaking Changes

  • None

Additional Information

  • Addresses missing validation feedback for Open Terminal connections that was available for Tool Servers.

Screenshots or Videos

New button for connection verification

image

Connection Fail with wrong URL

image

Blank Key

image

Invalid API Key

image

Contributor License Agreement

Note

Deleting the CLA section will lead to immediate closure of your PR and it will not be merged in.


🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/open-webui/open-webui/pull/22567 **Author:** [@silenceroom](https://github.com/silenceroom) **Created:** 3/11/2026 **Status:** ❌ Closed **Base:** `dev` ← **Head:** `feature/terminal-validation-feedback` --- ### 📝 Commits (4) - [`7cb3a48`](https://github.com/open-webui/open-webui/commit/7cb3a48d61094b0f1d823801bdfb3a2cfc90429c) feat: add verify button for terminal server connections - [`cf76aef`](https://github.com/open-webui/open-webui/commit/cf76aef52b4373a0a9ac7052ae48b6e24bf5c6d5) feat: add error toast notifications for terminal connections - [`a697153`](https://github.com/open-webui/open-webui/commit/a697153674fcd05d3f457341fa75c2e9d904f280) i18n: add localization strings for terminal verification - [`510c423`](https://github.com/open-webui/open-webui/commit/510c42377967f90673aab98057c6130417e61d63) style: fix code formatting issues ### 📊 Changes **6 files changed** (+246 additions, -2 deletions) <details> <summary>View changed files</summary> 📝 `src/lib/components/AddTerminalServerModal.svelte` (+221 -0) 📝 `src/lib/components/chat/MessageInput/TerminalMenu.svelte` (+8 -1) 📝 `src/lib/components/chat/Settings/Integrations.svelte` (+7 -1) 📝 `src/lib/i18n/locales/en-US/translation.json` (+5 -0) 📝 `src/lib/i18n/locales/zh-CN/translation.json` (+5 -0) ➕ `src/lib/i18n/locales/zh-TW/.translation.json.swp` (+0 -0) </details> ### 📄 Description <!-- ⚠️ CRITICAL CHECKS FOR CONTRIBUTORS (READ, DON'T DELETE) ⚠️ 1. Target the `dev` branch. PRs targeting `main` will be automatically closed. 2. Do NOT delete the CLA section at the bottom. It is required for the bot to accept your PR. --> # Pull Request Checklist ### Note to first-time contributors: Please open a discussion post in [Discussions](https://github.com/open-webui/open-webui/discussions) to discuss your idea/fix with the community before creating a pull request, and describe your changes before submitting a pull request. This is to ensure large feature PRs are discussed with the community first, before starting work on it. If the community does not want this feature or it is not relevant for Open WebUI as a project, it can be identified in the discussion before working on the feature and submitting the PR. **Before submitting, make sure you've checked the following:** - [x] **Target branch:** Verify that the pull request targets the `dev` branch. **PRs targeting `main` will be immediately closed.** - [x] **Description:** Provide a concise description of the changes made in this pull request down below. - [x] **Changelog:** Ensure a changelog entry following the format of [Keep a Changelog](https://keepachangelog.com/) is added at the bottom of the PR description. - [x] **Documentation:** Add docs in [Open WebUI Docs Repository](https://github.com/open-webui/docs). Document user-facing behavior, environment variables, public APIs/interfaces, or deployment steps. - [x] **Dependencies:** Are there any new or upgraded dependencies? If so, explain why, update the changelog/docs, and include any compatibility notes. Actually run the code/function that uses updated library to ensure it doesn't crash. - [x] **Testing:** Perform manual tests to **verify the implemented fix/feature works as intended AND does not break any other functionality**. Include reproducible steps to demonstrate the issue before the fix. Test edge cases (URL encoding, HTML entities, types). Take this as an opportunity to **make screenshots of the feature/fix and include them in the PR description**. - [x] **Agentic AI Code:** Confirm this Pull Request is **not written by any AI Agent** or has at least **gone through additional human review AND manual testing**. If any AI Agent is the co-author of this PR, it may lead to immediate closure of the PR. - [x] **Code review:** Have you performed a self-review of your code, addressing any coding standard issues and ensuring adherence to the project's coding standards? - [x] **Design & Architecture:** Prefer smart defaults over adding new settings; use local state for ephemeral UI logic. Open a Discussion for major architectural or UX changes. - [x] **Git Hygiene:** Keep PRs atomic (one logical change). Clean up commits and rebase on `dev` to ensure no unrelated commits (e.g. from `main`) are included. Push updates to the existing PR branch instead of closing and reopening. - [x] **Title Prefix:** To clearly categorize this pull request, prefix the pull request title using one of the following: - **BREAKING CHANGE**: Significant changes that may affect compatibility - **build**: Changes that affect the build system or external dependencies - **ci**: Changes to our continuous integration processes or workflows - **chore**: Refactor, cleanup, or other non-functional code changes - **docs**: Documentation update or addition - **feat**: Introduces a new feature or enhancement to the codebase - **fix**: Bug fix or error correction - **i18n**: Internationalization or localization changes - **perf**: Performance improvement - **refactor**: Code restructuring for better maintainability, readability, or scalability - **style**: Changes that do not affect the meaning of the code (white space, formatting, missing semi-colons, etc.) - **test**: Adding missing tests or correcting existing tests - **WIP**: Work in progress, a temporary label for incomplete or ongoing work # Changelog Entry ### Description - This PR adds comprehensive validation feedback for Open Terminal connections, matching the validation experience provided for Tool Servers. ### Added #### Validation Button - Added verify button in terminal server configuration modal (URL input field) - Shows loading spinner during validation - Located next to URL input for easy access #### Multi-Endpoint Authentication Validation - Validates API key by testing multiple terminal endpoints - Tests `/browse/`, `/info`, and `/execute` endpoints - Supports Bearer, Session, and None authentication types - Provides detailed error feedback for each failure case #### Error Feedback - Empty API Key: "API Key is required for Bearer authentication" - Wrong API Key: "Invalid API Key or authentication failed" - Network Issues: "Failed to connect to terminal server" - Success: "Connection successful" #### Translations - Added 5 new translation keys in English and Chinese - All error messages are properly localized ### Changed - AddTerminalServerModal.svelte: Add verify button and validation logic - Integrations.svelte: Add error toast for connection failures - TerminalMenu.svelte: Add error feedback for terminal selection - en-US/translation.json: Added English translations - zh-CN/translation.json: Added Chinese translations ### Deprecated - None ### Removed - None ### Security - None ### Breaking Changes - None --- ### Additional Information - Addresses missing validation feedback for Open Terminal connections that was available for Tool Servers. ### Screenshots or Videos #### New button for connection verification <img width="499" height="292" alt="image" src="https://github.com/user-attachments/assets/c3e9612e-1059-4de8-ba9f-0645c958f00b" /> #### Connection Fail with wrong URL <img width="965" height="536" alt="image" src="https://github.com/user-attachments/assets/e6d0cec6-1aef-4d8a-a22f-2d93948ac753" /> #### Blank Key <img width="988" height="528" alt="image" src="https://github.com/user-attachments/assets/3c2ff5dd-3764-45e6-937b-005d07a7839f" /> #### Invalid API Key <img width="961" height="518" alt="image" src="https://github.com/user-attachments/assets/8ff2e3f5-8a33-4bb0-b004-eaf9fb9e85a3" /> ### Contributor License Agreement <!-- 🚨 DO NOT DELETE THE TEXT BELOW 🚨 Keep the "Contributor License Agreement" confirmation text intact. Deleting it will trigger the CLA-Bot to INVALIDATE your PR. Your PR will NOT be reviewed or merged until you check the box below confirming that you have read and agree to the terms of the CLA. --> - [x] By submitting this pull request, I confirm that I have read and fully agree to the [Contributor License Agreement (CLA)](https://github.com/open-webui/open-webui/blob/main/CONTRIBUTOR_LICENSE_AGREEMENT), and I am providing my contributions under its terms. > [!NOTE] > Deleting the CLA section will lead to immediate closure of your PR and it will not be merged in. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
GiteaMirror added the pull-request label 2026-05-13 15:59:25 -05:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/open-webui#81632