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

Merge pull request #217 from silentoplayz/silentoplayz-swagger

Browse Source 
Decouple Swagger Docs from features.mdx
This commit is contained in:
Timothy Jaeryang Baek 2024-09-17 14:58:29 +02:00 committed by GitHub
commit e456d3e0f4
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
5 changed files with 33 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
docs/features.mdx
View File

@ -151,7 +151,7 @@ import { TopBanners } from "@site/src/components/TopBanners";
- 🔄 **Seamless Integration**: Copy any `ollama run {model:tag}` CLI command directly from a model's page on [Ollama library](https://ollama.com/library/) and paste it into the model dropdown to easily select and pull models.
- 🗂️ **Create Ollama Modelfile**: To create a model file for Ollama, navagate to the `Admin Panel` > `Settings` > `Models` > `Create a model` menu.
- 🗂️ **Create Ollama Modelfile**: To create a model file for Ollama, navigate to the `Admin Panel` > `Settings` > `Models` > `Create a model` menu.
- ⬆️ **GGUF File Model Creation**: Effortlessly create Ollama models by uploading GGUF files directly from Open WebUI from the `Admin Settings` > `Settings` > `Model` > `Experimental` menu. The process has been streamlined with the option to upload from your machine or download GGUF files from Hugging Face.
@ -192,7 +192,7 @@ import { TopBanners } from "@site/src/components/TopBanners";
- 📦 **Export All Archived Chats as JSON**: This feature enables users to easily export all their archived chats in a single JSON file, which can be used for backup or transfer purposes.
- 📄 **Download Chats as JSON/PDF/TXT**: Easily download your chats individually in your preffered format of `.json`, `.pdf`, or `.txt` format.
- 📄 **Download Chats as JSON/PDF/TXT**: Easily download your chats individually in your preferred format of `.json`, `.pdf`, or `.txt` format.
- 📤📥 **Import/Export Chat History**: Seamlessly move your chat data in and out of the platform via `Import Chats` and `Export Chats` options.
@ -260,7 +260,7 @@ import { TopBanners } from "@site/src/components/TopBanners";
- 👥 **Multi-User Management**: Intuitive admin panel with pagination allows you to seamlessly manage multiple users, streamlining user administration and simplifying user life-cycle management.
- 🔧 **Admin Panel**: The user management system is designed to streamline the onboarding and management of users, offering the option to add users directly or in bulk via CSV import.
- 🔧 **Admin Panel**: The user management system is designed to streamline the on-boarding and management of users, offering the option to add users directly or in bulk via CSV import.
- 👥 **Active Users Indicator**: Monitor the number of active users and which models are being utilized by whom to assist in gauging when performance may be impacted due to a high number of users.
@ -285,17 +285,5 @@ import { TopBanners } from "@site/src/components/TopBanners";
- 🔒 **Authentication**: Please note that Open WebUI does not natively support federated authentication schemes such as SSO, OAuth, SAML, or OIDC. However, it can be configured to delegate authentication to an authenticating reverse proxy, effectively achieving a Single Sign-On (`SSO`) experience. This setup allows you to centralize user authentication and management, enhancing security and user convenience. By integrating Open WebUI with an authenticating reverse proxy, you can leverage existing authentication systems and streamline user access to Open WebUI. For more information on configuring this feature, please refer to the [Federated Authentication Support](https://docs.openwebui.com/tutorial/sso).
- 🔓 **Optional Authentication**: Enjoy the flexibility of disabling authentication by setting `WEBUI_AUTH` to `False`. This is an ideal solution for fresh installations without existing users or can be useful for demonstration purposes.
---
### 📄 Swagger Documentation
- 📄 **Comprehensive Swagger documentation**: providing detailed information on endpoints, parameters, and responses. This feature streamlines API integration and development, ensuring seamless communication between Open WebUI and external systems.
| App | Docs Path |
|--------------|---------------------|
| WebUI | /api/v1/docs |
| Ollama | /ollama/docs |
| OpenAI | /openai/docs |
| Images | /images/api/v1/docs |
| Audio | /audio/api/v1/docs |
| RAG | /rag/api/v1/docs |

10
docs/getting-started/swagger.md Normal file
View File

@ -0,0 +1,10 @@
# Swagger Docs
| App | Docs Path |
|----------|---------------------|
| WebUI | /api/v1/docs |
| Ollama | /ollama/docs |
| OpenAI | /openai/docs |
| Images | /images/api/v1/docs |
| Audio | /audio/api/v1/docs |
| RAG | /rag/api/v1/docs |

9
docs/pipelines/actions.md
View File

@ -4,11 +4,14 @@ title: "Actions"
---
# Actions
Action functions allow you to write custom buttons to the message toolbar for end users to interact with. This feature enables more interactive messaging, enabling users to grant permission before a task is performed, generate visualizations of structured data, download an audio snippet of chats, and many other use cases.
Action functions allow you to write custom buttons to the message toolbar for end users to interact
with. This feature enables more interactive messaging, enabling users to grant permission before a
task is performed, generate visualizations of structured data, download an audio snippet of chats,
and many other use cases.
A scaffold of Action code can be found [in the community dection](https://openwebui.com/f/hub/custom_action/).
A scaffold of Action code can be found [in the community section](https://openwebui.com/f/hub/custom_action/).
An example of a graph vizualization Action can be seen in the video below.
An example of a graph visualization Action can be seen in the video below.
<p align="center">
<a href="#">

16
docs/pipelines/tutorials.md
View File

@ -5,14 +5,18 @@ title: "Tutorials"
# Tutorials
## Tutorials Wanted!
Write a blog post or create a YouTube video about your pipeline setup, and we'll happily host it here.
## Tutorials Welcome!
## Tutorials
[Monitoring Open WebUI with Filters](https://medium.com/@0xthresh/monitor-open-webui-with-datadog-llm-observability-620ef3a598c6)
Are you a content creator with a blog post or YouTube video about your pipeline setup? Get in touch
with us, as we'd love to feature it here!
## Featured Tutorials
[Building Customized Text-To-SQL Pipelines](https://www.youtube.com/watch?v=y7frgUWrcT4&t=14s)
[Monitoring Open WebUI with Filters](https://medium.com/@0xthresh/monitor-open-webui-with-datadog-llm-observability-620ef3a598c6) (Medium article by @0xthresh)
- A detailed guide to monitoring the Open WebUI using DataDog LLM observability.
[Building Customized Text-To-SQL Pipelines](https://www.youtube.com/watch?v=y7frgUWrcT4&t=14s) (YouTube video by Jordan Nanos)
- Learn how to develop tailored text-to-sql pipelines, unlocking the power of data analysis and extraction.
[Demo and Code Review for Text-To-SQL with Open-WebUI](https://www.youtube.com/watch?v=iLVyEgxGbg4)
[Demo and Code Review for Text-To-SQL with Open-WebUI](https://www.youtube.com/watch?v=iLVyEgxGbg4) (YouTube video by Jordan Nanos)
- A hands-on demonstration and code review on utilizing text-to-sql tools powered by the Open WebUI.

2
docs/tutorial/apache.md
View File

@ -70,7 +70,7 @@ _Normally, mod_proxy will canonicalise ProxyPassed URLs. But this may be incompa
I'm using virtualmin here for my SSL clusters, but you can also use certbot directly or your preferred SSL method. To use SSL:
### Prerequisites.
### Prerequisites
Run the following commands: