You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/CONTRIBUTING.md
+8-12Lines changed: 8 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,16 +1,16 @@
1
-
# Welcome to GitHub docs contributing guide <!-- omit in toc -->
1
+
# Welcome to Open-WebUI-Functions contributing guide <!-- omit in toc -->
2
2
3
3
Thank you for investing your time in contributing to our project!
4
4
5
-
Read our [Code of Conduct](./CODE_OF_CONDUCT.md) to keep our community approachable and respectable.
5
+
Read our [Code of Conduct](https://own.dev/github-owndev-open-webui-functions-code-of-conduct) to keep our community approachable and respectable.
6
6
7
7
In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.
8
8
9
-
Use the table of contents icon <imgalt="Table of contents icon"src="/contributing/images/table-of-contents.png"width="25"height="25" /> on the top left corner of this document to get to a specific section of this guide quickly.
9
+
Use the table of contents icon <imgalt="Table of contents icon"src="../docs/images/table-of-contents.png"width="25"height="25" /> on the top left corner of this document to get to a specific section of this guide quickly.
10
10
11
11
## New contributor guide
12
12
13
-
To get an overview of the project, read the [README](../README.md) file. Here are some resources to help you get started with open source contributions:
13
+
To get an overview of the project, read the [README](https://own.dev/github-owndev-open-webui-functions) file. Here are some resources to help you get started with open source contributions:
14
14
15
15
-[Finding ways to contribute to open source on GitHub](https://docs.github.com/en/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github)
16
16
-[Set up Git](https://docs.github.com/en/get-started/git-basics/set-up-git)
@@ -26,23 +26,19 @@ For more information on how we write our markdown files, see "[Using Markdown in
26
26
27
27
#### Create a new issue
28
28
29
-
If you spot a problem, [search if an issue already exists](https://docs.github.com/en/github/searching-for-information-on-github/searching-on-github/searching-issues-and-pull-requests#search-by-the-title-body-or-comments). If a related issue doesn't exist, you can open a new issue using a relevant [issue form](https://github.com/github/docs/issues/new/choose).
29
+
If you spot a problem, [search if an issue already exists](https://docs.github.com/en/github/searching-for-information-on-github/searching-on-github/searching-issues-and-pull-requests#search-by-the-title-body-or-comments). If a related issue doesn't exist, you can open a new issue using a relevant [issue form](https://own.dev/github-owndev-open-webui-functions-issues-new).
30
30
31
31
#### Solve an issue
32
32
33
-
Scan through our [existing issues](https://github.com/github/docs/issues) to find one that interests you. You can narrow down the search using `labels` as filters. As a general rule, we don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix.
33
+
Scan through our [existing issues](https://own.dev/github-owndev-open-webui-functions-issues) to find one that interests you. You can narrow down the search using `labels` as filters. As a general rule, we don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix.
34
34
35
35
### Make Changes
36
36
37
37
#### Make changes in the UI
38
38
39
39
Click **Make a contribution** at the bottom of any docs page to make small changes such as a typo, sentence fix, or a broken link. This takes you to the `.md` file where you can make your changes and [create a pull request](#pull-request) for a review.
For more information about using a codespace for working on GitHub documentation, see "[Working in a codespace](https://github.com/github/docs/blob/main/contributing/codespace.md)."
41
+
<imgsrc="../docs/images/contribution_cta.png" />
46
42
47
43
#### Make changes locally
48
44
@@ -72,6 +68,6 @@ Once you submit your PR, a team member will review your proposal. We may ask que
72
68
73
69
### Your PR is merged!
74
70
75
-
Congratulations :tada::tada:The Open-WebUI-Functions team thanks you :sparkles:.
71
+
Congratulations :tada::tada:the **Open-WebUI-Functions** team thanks you :sparkles:.
76
72
77
73
Once your PR is merged, your posts will be made public.
Copy file name to clipboardExpand all lines: .github/ISSUE_TEMPLATE/contribute-your-own-feature.yaml
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@ body:
12
12
13
13
Please fill out all relevant sections to help the maintainers review and integrate your work efficiently.
14
14
15
-
- Make sure you’ve read the [Contributing Guide](https://github.com/owndev/Open-WebUI-Functions/blob/main/.github/CONTRIBUTING.md).
15
+
- Make sure you’ve read the [Contributing Guide](https://own.dev/github-owndev-open-webui-functions-contributing).
16
16
- Before proceeding, open this issue to **coordinate with maintainers** and avoid duplicate work.
17
17
18
18
- type: checkboxes
@@ -21,7 +21,7 @@ body:
21
21
label: Contribution Terms
22
22
description: Confirm that you've reviewed the necessary guidelines and intend to contribute code.
23
23
options:
24
-
- label: I have reviewed the project’s [Code of Conduct](https://github.com/owndev/Open-WebUI-Functions/blob/main/.github/CODE_OF_CONDUCT.md) and contribution guidelines.
24
+
- label: I have reviewed the project’s [Code of Conduct](https://own.dev/github-owndev-open-webui-functions-code-of-conduct) and contribution guidelines.
25
25
required: true
26
26
- label: I plan to implement this feature myself and submit a pull request.
Copy file name to clipboardExpand all lines: .github/ISSUE_TEMPLATE/question-or-support.yaml
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ body:
8
8
value: |
9
9
**Need help or have a question?**
10
10
This form is for general usage questions or support requests.
11
-
Please check the [documentation](https://github.com/owndev/Open-WebUI-Functions) and existing [issues](https://github.com/owndev/Open-WebUI-Functions/issues) before submitting.
11
+
Please check the [documentation](https://own.dev/github-owndev-open-webui-functions) and existing [issues](https://own.dev/github-owndev-open-webui-functions-issues) before submitting.
Copy file name to clipboardExpand all lines: .github/ISSUE_TEMPLATE/suggest-new-feature.yaml
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -8,16 +8,16 @@ body:
8
8
value: |
9
9
**Hello Contributors!** Thank you for taking the time to suggest a new feature for the project. Please provide as much detail as possible to help us understand your request.
10
10
11
-
* Before submitting this request, ensure you've reviewed the [Contributing Guide](https://github.com/owndev/Open-WebUI-Functions/blob/main/.github/CONTRIBUTING.md).
12
-
* Check if a similar request already exists in the [issues](https://github.com/owndev/Open-WebUI-Functions/issues).
11
+
* Before submitting this request, ensure you've reviewed the [Contributing Guide](https://own.dev/github-owndev-open-webui-functions-contributing).
12
+
* Check if a similar request already exists in the [issues](https://own.dev/github-owndev-open-webui-functions-issues).
13
13
14
14
- type: checkboxes
15
15
id: agreement
16
16
attributes:
17
17
label: Contribution Terms
18
18
description: Please confirm that you have read and understood the project's contribution guidelines.
19
19
options:
20
-
- label: I have reviewed the project’s [Code of Conduct](https://github.com/owndev/Open-WebUI-Functions/blob/main/.github/CODE_OF_CONDUCT.md) and contribution guidelines.
20
+
- label: I have reviewed the project’s [Code of Conduct](https://own.dev/github-owndev-open-webui-functions-code-of-conduct) and contribution guidelines.
Copy file name to clipboardExpand all lines: README.md
+21-20Lines changed: 21 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Open-WebUI-Functions
2
2
3
-
**Open-WebUI-Functions** is a collection of Python-based functions designed to extend the capabilities of [Open WebUI](https://github.com/open-webui) with additional **pipelines**, **filters**, and **integrations**. These functions allow users to interact with various AI models, process data efficiently, and customize the Open WebUI experience.
3
+
**Open-WebUI-Functions** is a collection of Python-based functions designed to extend the capabilities of [Open WebUI](https://own.dev/github-com-open-webui-open-webui) with additional **pipelines**, **filters**, and **integrations**. These functions allow users to interact with various AI models, process data efficiently, and customize the Open WebUI experience.
4
4
5
5
---
6
6
@@ -9,7 +9,7 @@
9
9
-**Custom Pipelines**: Extend Open WebUI with AI processing pipelines, including model inference and data transformations.
10
10
-**Filters for Data Processing**: Apply custom filtering logic to refine, manipulate, or preprocess input and output data.
11
11
-**Azure AI Support**: Seamlessly connect Open WebUI with **Azure OpenAI** and other **Azure AI** models.
12
-
-**N8N Workflow Integration**: Enable interactions with [N8N](https://n8n.io/) for automation.
12
+
-**N8N Workflow Integration**: Enable interactions with [N8N](https://own.dev/n8n-io) for automation.
13
13
-**Flexible Configuration**: Use environment variables to adjust function settings dynamically.
14
14
-**Streaming and Non-Streaming Support**: Handle both real-time and batch processing efficiently.
15
15
-**Secure API Key Management**: Automatic encryption of sensitive information like API keys.
@@ -20,8 +20,8 @@
20
20
21
21
To use these functions, ensure the following:
22
22
23
-
1.**An Active Open WebUI Instance**: You must have [Open WebUI](https://github.com/open-webui/open-webui) installed and running.
24
-
2.**Required AI Services (if applicable)**: Some pipelines require external AI services, such as [Azure AI](https://ai.azure.com/).
23
+
1.**An Active Open WebUI Instance**: You must have [Open WebUI](https://own.dev/github-com-open-webui-open-webui) installed and running.
24
+
2.**Required AI Services (if applicable)**: Some pipelines require external AI services, such as [Azure AI](https://own.dev/ai-azure-com).
25
25
3.**Admin Access**: To install functions in Open WebUI, you must have administrator privileges.
26
26
27
27
---
@@ -45,7 +45,7 @@ To install and configure functions in Open WebUI, follow these steps:
45
45
46
46
5.**Set Environment Variables (if required)**:
47
47
- Some functions require API keys or specific configurations via environment variables.
48
-
- Set [WEBUI_SECRET_KEY](https://docs.openwebui.com/getting-started/env-configuration/#webui_secret_key) for secure encryption of sensitive API keys.
48
+
- Set [WEBUI_SECRET_KEY](https://own.dev/docs-openwebui-com-getting-started-env-configuration-webui-secret-key) for secure encryption of sensitive API keys.
49
49
50
50
6.**Save and Activate**:
51
51
- Save the function, and it will be available for use within Open WebUI.
@@ -61,7 +61,7 @@ The functions include a built-in encryption mechanism for sensitive information:
61
61
-**Automatic Encryption**: API keys and other sensitive data are automatically encrypted when stored.
62
62
-**Encrypted Storage**: Values are stored with an "encrypted:" prefix followed by the encrypted data.
63
63
-**Transparent Usage**: The encryption/decryption happens automatically when values are accessed.
64
-
-**No Configuration Required**: Works out-of-the-box when [WEBUI_SECRET_KEY](https://docs.openwebui.com/getting-started/env-configuration/#webui_secret_key) is set.
64
+
-**No Configuration Required**: Works out-of-the-box when [WEBUI_SECRET_KEY](https://own.dev/docs-openwebui-com-getting-started-env-configuration-webui-secret-key) is set.
- Integrates **Open WebUI** with **N8N**, an automation and workflow platform.
94
94
- Sends messages from Open WebUI to an **N8N webhook**.
95
95
- Supports real-time message processing with dynamic field handling.
96
96
- Enables automation of AI-generated responses within an **N8N workflow**.
97
97
- Supports encryption of sensitive information like API keys.
98
-
- Here is an example [N8N workflow](./pipelines/n8n/Open_WebUI_Test_Agent.json) for [N8N Pipeline](./pipelines/n8n/n8n.py)
98
+
- Here is an example [N8N workflow](https://own.dev/github-owndev-open-webui-functions-open-webui-test-agent) for [N8N Pipeline](https://own.dev/github-owndev-open-webui-functions-n8n-pipeline)
99
99
100
-
🔗 [N8N Pipeline in Open WebUI](https://openwebui.com/f/owndev/n8n_pipeline/)
100
+
🔗 [N8N Pipeline in Open WebUI](https://own.dev/openwebui-com-f-owndev-n8n-pipeline)
- Measures **response time** and **token usage** for AI interactions.
124
124
- Supports tracking of **total token usage** and **per-message token counts**.
125
125
- Can calculate token usage for all messages or only a subset.
126
126
- Uses OpenAI's `tiktoken` library for token counting (only accurate for OpenAI models).
127
-
- Optional: Can send logs to [Azure Log Analytics Workspace](https://learn.microsoft.com/en-us/azure/azure-monitor/logs/log-analytics-workspace-overview).
127
+
- Optional: Can send logs to [Azure Log Analytics Workspace](https://own.dev/learn-microsoft-com-en-us-azure-azure-monitor-logs-log-analytics-workspace-overview).
128
128
129
-
🔗 [How to Setup](./docs/setup-azure-log-analytics.md)
130
-
🔗 [Time Token Tracker in Open WebUI](https://openwebui.com/f/owndev/time_token_tracker)
129
+
🔗 [How to Setup](https://own.dev/github-owndev-open-webui-functions-setup-azure-log-analytics)
130
+
131
+
🔗 [Time Token Tracker in Open WebUI](https://own.dev/openwebui-com-f-owndev-time-token-tracker)
131
132
132
133
---
133
134
@@ -153,4 +154,4 @@ AZURE_AI_MODEL="gpt-4o, gpt-4o-mini" # Optional model name, only necessary if n
153
154
## Contribute
154
155
155
156
We accept different types of contributions, including some that don't require you to write a single line of code.
156
-
For detailed instructions on how to get started with our project, see [About contributing to Open-WebUI-Functions](./.github/CONTRIBUTING.md).
157
+
For detailed instructions on how to get started with our project, see [About contributing to Open-WebUI-Functions](https://own.dev/github-owndev-open-webui-functions-contributing).
description: A pipeline for interacting with Azure AI services, enabling seamless communication with various AI models via configurable headers and robust error handling. This includes support for Azure OpenAI models as well as other Azure AI models by dynamically managing headers and request configurations.
0 commit comments