OpenWebUI/docs
1
0
Fork 0
mirror of https://github.com/open-webui/docs synced 2025-05-19 10:52:14 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #440 from thiswillbeyourgithub/add_missing_doc_for_frontmatter_requirements

Browse Source 
enh: add frontmatter documentation to pip install requirements
This commit is contained in:
Timothy Jaeryang Baek 2025-03-15 17:33:12 +00:00 committed by GitHub
commit 5e26f49c62
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 27 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
docs/features/plugin/tools/index.mdx
View File

@ -310,3 +310,30 @@ async def test_function(
)
```
</details>
## External packages
In the Tools definition metadata you can specify custom packages. When you click `Save` the line will be parsed and `pip install` will be run on all requirements at once.
Keep in mind that as pip is used in the same process as Open-WebUI, the UI will be completely unresponsive during the installation.
No measures are taken to handle package conflicts with Open-WebUI's requirements. That means that specifying requirements can break OpenWebUI if you're not careful. You might be able to work around this by specifying `open-webui` itself as a requirement.
<details>
<summary>Example</summary>
```
"""
title: myToolName
author: myName
funding_url: [any link here will be shown behind a `Heart` button for users to show their support to you]
version: 1.0.0
# the version is displayed in the UI to help users keep track of updates.
license: GPLv3
description: [recommended]
requirements: package1>=2.7.0,package2,package3
"""
```
</details>