Skip to content

Commit 6113245

Browse files
authored
Update links
1 parent 8573c71 commit 6113245

12 files changed

Lines changed: 50 additions & 53 deletions

.github/CONTRIBUTING.md

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff 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 -->
22

33
Thank you for investing your time in contributing to our project!
44

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.
66

77
In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.
88

9-
Use the table of contents icon <img alt="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 <img alt="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.
1010

1111
## New contributor guide
1212

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:
1414

1515
- [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)
1616
- [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
2626

2727
#### Create a new issue
2828

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).
3030

3131
#### Solve an issue
3232

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.
3434

3535
### Make Changes
3636

3737
#### Make changes in the UI
3838

3939
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.
4040

41-
<img src="/contributing/images/contribution_cta.png" />
42-
43-
#### Make changes in a codespace
44-
45-
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+
<img src="../docs/images/contribution_cta.png" />
4642

4743
#### Make changes locally
4844

@@ -72,6 +68,6 @@ Once you submit your PR, a team member will review your proposal. We may ask que
7268

7369
### Your PR is merged!
7470

75-
Congratulations :tada::tada: The Open-WebUI-Functions team thanks you :sparkles:.
71+
Congratulations :tada::tada: the **Open-WebUI-Functions** team thanks you :sparkles:.
7672

7773
Once your PR is merged, your posts will be made public.

.github/ISSUE_TEMPLATE/contribute-your-own-feature.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ body:
1212
1313
Please fill out all relevant sections to help the maintainers review and integrate your work efficiently.
1414
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).
1616
- Before proceeding, open this issue to **coordinate with maintainers** and avoid duplicate work.
1717
1818
- type: checkboxes
@@ -21,7 +21,7 @@ body:
2121
label: Contribution Terms
2222
description: Confirm that you've reviewed the necessary guidelines and intend to contribute code.
2323
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.
2525
required: true
2626
- label: I plan to implement this feature myself and submit a pull request.
2727
required: true

.github/ISSUE_TEMPLATE/question-or-support.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ body:
88
value: |
99
**Need help or have a question?**
1010
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.
1212
1313
- type: input
1414
attributes:

.github/ISSUE_TEMPLATE/suggest-new-feature.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,16 @@ body:
88
value: |
99
**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.
1010
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).
1313
1414
- type: checkboxes
1515
id: agreement
1616
attributes:
1717
label: Contribution Terms
1818
description: Please confirm that you have read and understood the project's contribution guidelines.
1919
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.
2121
required: true
2222

2323
- type: input

README.md

Lines changed: 21 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Open-WebUI-Functions
22

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.
44

55
---
66

@@ -9,7 +9,7 @@
99
- **Custom Pipelines**: Extend Open WebUI with AI processing pipelines, including model inference and data transformations.
1010
- **Filters for Data Processing**: Apply custom filtering logic to refine, manipulate, or preprocess input and output data.
1111
- **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.
1313
- **Flexible Configuration**: Use environment variables to adjust function settings dynamically.
1414
- **Streaming and Non-Streaming Support**: Handle both real-time and batch processing efficiently.
1515
- **Secure API Key Management**: Automatic encryption of sensitive information like API keys.
@@ -20,8 +20,8 @@
2020

2121
To use these functions, ensure the following:
2222

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).
2525
3. **Admin Access**: To install functions in Open WebUI, you must have administrator privileges.
2626

2727
---
@@ -45,7 +45,7 @@ To install and configure functions in Open WebUI, follow these steps:
4545

4646
5. **Set Environment Variables (if required)**:
4747
- 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.
4949

5050
6. **Save and Activate**:
5151
- 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:
6161
- **Automatic Encryption**: API keys and other sensitive data are automatically encrypted when stored.
6262
- **Encrypted Storage**: Values are stored with an "encrypted:" prefix followed by the encrypted data.
6363
- **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.
6565

6666
To enable encryption:
6767
```bash
@@ -75,7 +75,7 @@ WEBUI_SECRET_KEY="your-secure-random-string"
7575

7676
Pipelines are processing functions that extend Open WebUI with **custom AI models**, **external integrations**, and **data manipulation logic**.
7777

78-
### **1. [Azure AI Foundry Pipeline](./pipelines/azure/azure_ai_foundry.py)**
78+
### **1. [Azure AI Foundry Pipeline](https://own.dev/github-owndev-open-webui-functions-azure-ai-foundry)**
7979

8080
- Enables interaction with **Azure OpenAI** and other **Azure AI** models.
8181
- Supports multiple Azure AI models selection via the `AZURE_AI_MODEL` environment variable (e.g. `gpt-4o, gpt-4o-mini`).
@@ -85,49 +85,50 @@ Pipelines are processing functions that extend Open WebUI with **custom AI model
8585
- Predefined models for easy access.
8686
- Supports encryption of sensitive information like API keys.
8787

88-
🔗 [Azure AI Pipeline in Open WebUI](https://openwebui.com/f/owndev/azure_ai/)
88+
🔗 [Azure AI Pipeline in Open WebUI](https://own.dev/openwebui-com-f-owndev-azure-ai)
8989

9090

91-
### **2. [N8N Pipeline](./pipelines/n8n/n8n.py)**
91+
### **2. [N8N Pipeline](https://own.dev/github-owndev-open-webui-functions-n8n-pipeline)**
9292

9393
- Integrates **Open WebUI** with **N8N**, an automation and workflow platform.
9494
- Sends messages from Open WebUI to an **N8N webhook**.
9595
- Supports real-time message processing with dynamic field handling.
9696
- Enables automation of AI-generated responses within an **N8N workflow**.
9797
- 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)
9999

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)
101101

102-
🔗 [Learn More About N8N](https://n8n.io/)
102+
🔗 [Learn More About N8N](https://own.dev/n8n-io)
103103

104104

105-
### **3. [Infomaniak](./pipelines/infomaniak/infomaniak.py)**
105+
### **3. [Infomaniak](https://own.dev/github-owndev-open-webui-functions-infomaniak)**
106106

107107
- Integrates **Open WebUI** with **Infomaniak**, a Swiss web hosting and cloud services provider.
108108
- Sends messages from Open WebUI to an **Infomaniak AI Tool**.
109109
- Supports encryption of sensitive information like API keys.
110110

111-
🔗 [Infomaniak Pipeline in Open WebUI](https://openwebui.com/f/owndev/infomaniak_ai_tools)
111+
🔗 [Infomaniak Pipeline in Open WebUI](https://own.dev/openwebui-com-f-owndev-infomaniak-ai-tools)
112112

113-
🔗 [Learn More About Infomaniak](https://www.infomaniak.com/en/hosting/ai-tools)
113+
🔗 [Learn More About Infomaniak](https://own.dev/infomaniak-com-en-hosting-ai-tools)
114114

115115
---
116116

117117
## Filters
118118

119119
Filters allow for **preprocessing and postprocessing** of data within Open WebUI.
120120

121-
### **1. [Time Token Tracker](./filters/time_token_tracker.py)**
121+
### **1. [Time Token Tracker](https://own.dev/github-owndev-open-webui-functions-time-token-tracker)**
122122

123123
- Measures **response time** and **token usage** for AI interactions.
124124
- Supports tracking of **total token usage** and **per-message token counts**.
125125
- Can calculate token usage for all messages or only a subset.
126126
- 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).
128128

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)
131132

132133
---
133134

@@ -153,4 +154,4 @@ AZURE_AI_MODEL="gpt-4o, gpt-4o-mini" # Optional model name, only necessary if n
153154
## Contribute
154155

155156
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).

docs/setup-azure-log-analytics.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Setup Azure Log Analytics Workspace
22
## Installation
3-
- [Create Workspace](https://learn.microsoft.com/en-us/azure/azure-monitor/logs/quick-create-workspace)
3+
- [Create Workspace](https://own.dev/learn-microsoft-com-en-us-azure-azure-monitor-logs-quick-create-workspace)
44

55
## Get Shared Key
66
To send data from Time Token Tracker to Azure Log Analytics, a shared key is required. This can be found under `Settings` > `Agents` > `Primary key`.

filters/time_token_tracker.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
"""
22
title: Time Token Tracker
33
author: owndev
4-
author_url: https://github.com/owndev
5-
project_url: https://github.com/owndev/Open-WebUI-Functions
6-
funding_url: https://github.com/owndev/Open-WebUI-Functions
4+
author_url: https://own.dev/github
5+
project_url: https://own.dev/github-owndev-open-webui-functions
6+
funding_url: https://own.dev/github-owndev-open-webui-functions
77
version: 2.5.0
88
license: Apache License 2.0
99
description: A filter for tracking the response time and token usage of a request with Azure Log Analytics integration.

pipelines/azure/azure_ai_foundry.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
"""
22
title: Azure AI Foundry Pipeline
33
author: owndev
4-
author_url: https://github.com/owndev
5-
project_url: https://github.com/owndev/Open-WebUI-Functions
6-
funding_url: https://github.com/owndev/Open-WebUI-Functions
4+
author_url: https://own.dev/github
5+
project_url: https://own.dev/github-owndev-open-webui-functions
6+
funding_url: https://own.dev/github-owndev-open-webui-functions
77
version: 2.2.1
88
license: Apache License 2.0
99
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

Comments
 (0)