Skip to content

2.3.25 Satellite: Open WebUI Pipelines

av edited this page Nov 9, 2024 · 3 revisions

Handle: pipelines
URL: http://localhost:34211
Integration author: @ic4l4s9c

Pipelines bring modular, customizable workflows to any UI client supporting OpenAI API specs – and much more! Easily extend functionalities, integrate unique logic, and create dynamic workflows with just a few lines of code.


Starting

# [Optional] Pre-pull the images
harbor pull pipelines

# Start the service
harbor up pipelines

Note

It makes most sense to run pipelines and webui together, as they are designed to work in tandem

Usage

Harbor connects pipelines to the webui service by default, when run together.

Screenshot of OpenWebUI and pipelines pre-configured

Apart from that, you can access the Pipelines API:

# URL for access from the host
harbor url pipelines

# URL for access in the same LAN
harbor url -a pipelines

# [Optional] create tunnel for access via
# public interned
# ⚠️ Never expose unprotected endpoints to the public internet
harbor tunnel pipelines

Configuration

Majority of configuration will happen via webui. Navigate to the pipelines settings (typically Admin Settings -> Settings -> Pipelines) and upload either a .py file with the pipeline code or point the service to a raw GitHub URL (for example: https://raw.githubusercontent.com/open-webui/pipelines/refs/heads/main/examples/pipelines/integrations/wikipedia_pipeline.py)

After upload, the usage of the pipeline in the webui will depend on the type of the pipeline (e.g. Filter, Function, Scaffold, etc.).

Example wikipedia pipeline in the webui

Please refer to the official documentation for many more examples and detailed instructions.

Documentation

Clone this wiki locally