[PR #22207] [CLOSED] refactor: remove pydub dependency #113860

Closed
opened 2026-05-18 14:21:23 -05:00 by GiteaMirror · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/22207
Author: @Elettrotecnica
Created: 3/4/2026
Status: Closed

Base: devHead: remove-pydub-dependency


📝 Commits (4)

  • 88c59c7 Refactor audio processing utilities to use pyav instead of pydub
  • 672f5af Remove pydub from python requirements
  • 7dd1660 Remove ffmpeg from docker image, pyav already comes with the binaries
  • a815436 Merge branch 'dev' into remove-pydub-dependency

📊 Changes

6 files changed (+150 additions, -70 deletions)

View changed files

📝 Dockerfile (+1 -1)
📝 backend/open_webui/routers/audio.py (+149 -55)
📝 backend/requirements-min.txt (+0 -1)
📝 backend/requirements.txt (+0 -1)
📝 pyproject.toml (+0 -1)
📝 uv.lock (+0 -11)

📄 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

Use pyav (already a dependency) instead of pydub for audio processing to improve compatibility with constrained Kubernetes security environments.

Added

Changed

  • Refactored audio processing helpers to use pyav instead of pydub

Deprecated

Removed

  • Removed ffmpeg dependency as an apt package in the Dockerfile
  • Removed pydub as a dependency in python requirements

Fixed

  • STT now works also in constrained Kubernetes security environments

Security

Breaking Changes

  • External OpenWebUI integratiions relying on pydub and ffmpeg will now need to provide their own dependency

Additional Information

pydub works by spawning ffmpeg and ffprobe via subprocess calls. This means:

  • The ffmpeg binary must be available in the system PATH
  • The runtime environment must allow execve syscalls
  • The container must include shell-compatible tooling
  • Security policies (e.g., seccomp) may block execution

For instance, when a container runs:

  • As non-root
  • With allowPrivilegeEscalation: false
  • With capabilities: drop: ALL
  • Under a strict seccomp profile

Using subprocess-based media probing (as pydub does) will fail when trying to Speech To Text with a model, as the audio recognition will fail (an so the whole processing).

We understand that OpenWebUI does not officially support rootless execution (see e.g. https://github.com/open-webui/open-webui/discussions/18541). However, this enables those who are willing to maintain their own images have STT in a restricted environment.

Screenshots or Videos

  • [Attach any relevant screenshots or videos demonstrating the changes]

Contributor License Agreement

By submitting this pull request, I confirm that I have read and fully agree to the Contributor License Agreement (CLA), 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.


🔄 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/22207 **Author:** [@Elettrotecnica](https://github.com/Elettrotecnica) **Created:** 3/4/2026 **Status:** ❌ Closed **Base:** `dev` ← **Head:** `remove-pydub-dependency` --- ### 📝 Commits (4) - [`88c59c7`](https://github.com/open-webui/open-webui/commit/88c59c72990f0067aef0fff40c2db10f4714d5a8) Refactor audio processing utilities to use pyav instead of pydub - [`672f5af`](https://github.com/open-webui/open-webui/commit/672f5af0b0ba7ff22584d803567169e51fb3ce85) Remove pydub from python requirements - [`7dd1660`](https://github.com/open-webui/open-webui/commit/7dd1660135545f5f94a7696f7dd28e370582a6fb) Remove ffmpeg from docker image, pyav already comes with the binaries - [`a815436`](https://github.com/open-webui/open-webui/commit/a81543688ea7bba6e00b0fce607d76bc0ac8359b) Merge branch 'dev' into remove-pydub-dependency ### 📊 Changes **6 files changed** (+150 additions, -70 deletions) <details> <summary>View changed files</summary> 📝 `Dockerfile` (+1 -1) 📝 `backend/open_webui/routers/audio.py` (+149 -55) 📝 `backend/requirements-min.txt` (+0 -1) 📝 `backend/requirements.txt` (+0 -1) 📝 `pyproject.toml` (+0 -1) 📝 `uv.lock` (+0 -11) </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 Use pyav (already a dependency) instead of pydub for audio processing to improve compatibility with constrained Kubernetes security environments. ### Added ### Changed - Refactored audio processing helpers to use pyav instead of pydub ### Deprecated ### Removed - Removed ffmpeg dependency as an apt package in the Dockerfile - Removed pydub as a dependency in python requirements ### Fixed - STT now works also in constrained Kubernetes security environments ### Security ### Breaking Changes - External OpenWebUI integratiions relying on pydub and ffmpeg will now need to provide their own dependency --- ### Additional Information pydub works by spawning ffmpeg and ffprobe via subprocess calls. This means: - The ffmpeg binary must be available in the system PATH - The runtime environment must allow execve syscalls - The container must include shell-compatible tooling - Security policies (e.g., seccomp) may block execution For instance, when a container runs: - As non-root - With allowPrivilegeEscalation: false - With capabilities: drop: ALL - Under a strict seccomp profile Using subprocess-based media probing (as pydub does) will fail when trying to Speech To Text with a model, as the audio recognition will fail (an so the whole processing). We understand that OpenWebUI does not officially support rootless execution (see e.g. https://github.com/open-webui/open-webui/discussions/18541). However, this enables those who are willing to maintain their own images have STT in a restricted environment. ### Screenshots or Videos - [Attach any relevant screenshots or videos demonstrating the changes] ### 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. --> 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-18 14:21:23 -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#113860