Merge pull request #324 from silentoplayz/main

Further clean up
open-webui · Dec 18, 2024 · 7084a3c · 7084a3c
2 parents b21c03a + 56ee998
commit 7084a3c
Show file tree

Hide file tree

Showing 30 changed files with 51 additions and 45 deletions.
diff --git a/docs/features/banners.md b/docs/features/banners.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 11
+sidebar_position: 13
 title: "🔰 Customizable Banners"
 ---
 

diff --git a/docs/features/chat-params.md b/docs/features/chat-params.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 3
+sidebar_position: 4
 title: "⚙️ Chat Parameters"
 ---
 

diff --git a/docs/features/index.mdx b/docs/features/index.mdx
@@ -206,7 +206,7 @@ import { TopBanners } from "@site/src/components/TopBanners";
 ### 🎙️ Voice & Accessibility
 
 - 🗣️ **Voice Input Support**: Engage with your model through voice interactions; enjoy the convenience of talking to your model directly. Additionally, explore the option for sending voice input automatically after 3 seconds of silence for a streamlined experience.
-  - Microphone access requires manually setting up a secure connection over HTTPS to work, or [manually whitelisting your URL at your own risk](https://docs.openwebui.com/troubleshooting/microphone-access-and-other-permission-issues-with-non-https-connections).
+  - Microphone access requires manually setting up a secure connection over HTTPS to work, or [manually whitelisting your URL at your own risk](https://docs.openwebui.com/troubleshooting/microphone-error).
 
 - 😊 **Emoji Call**: Toggle this feature on from the `Settings` > `Interface` menu, allowing LLMs to express emotions using emojis during voice calls for a more dynamic interaction.
   - Microphone access requires a secure connection over HTTPS for this feature to work.

diff --git a/docs/features/jwttoken.md b/docs/features/jwttoken.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 12
+sidebar_position: 14
 title: "📎 JWT Expiration"
 ---
 

diff --git a/docs/features/memory.md b/docs/features/memory.md
@@ -0,0 +1,4 @@
+---
+sidebar_position: 15
+title: "🧠 Memory (Experimental)"
+---
diff --git a/docs/features/oauth/index.mdx b/docs/features/oauth/index.mdx
@@ -0,0 +1,4 @@
+---
+sidebar_position: 4
+title: "🔐 OAuth"
+---
diff --git a/docs/features/ollama.md b/docs/features/ollama.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 3
+sidebar_position: 6
 title: "⚖️ Ollama Load Balancing"
 ---
 

diff --git a/docs/features/openai.md b/docs/features/openai.md
@@ -1,6 +1,6 @@
 ---
-sidebar_position: 3
-title: "OpenAI Connections"
+sidebar_position: 9
+title: "🖇 OpenAI Connections"
 ---
 
 In this tutorial, we will demonstrate how to configure multiple OpenAI (or compatible) API endpoints using environment variables. This setup allows you to easily switch between different API providers or use multiple providers simultaneously, while keeping your configuration between container updates, rebuilds or redeployments.

diff --git a/docs/features/playground(beta)/index.mdx b/docs/features/playground(beta)/index.mdx
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 1
+sidebar_position: 2
 title: "🛝 Playground (Beta)"
 ---
 

diff --git a/docs/features/plugin/functions/actions.md b/docs/features/plugin/functions/actions.md
@@ -1,6 +1,6 @@
 ---
 sidebar_position: 6
-title: "Actions"
+title: "🎬 Actions"
 ---
 
 Action functions allow you to write custom buttons to the message toolbar for end users to interact

diff --git a/docs/features/plugin/functions/index.mdx b/docs/features/plugin/functions/index.mdx
@@ -1,6 +1,6 @@
 ---
 sidebar_position: 1
-title: "Functions"
+title: "🧰 Functions"
 ---
 
 ## What are Functions?

diff --git a/docs/features/plugin/index.mdx b/docs/features/plugin/index.mdx
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 2
+sidebar_position: 1
 title: "🛠️ Tools & Functions"
 ---
 

diff --git a/docs/features/plugin/tools/index.mdx b/docs/features/plugin/tools/index.mdx
@@ -1,6 +1,6 @@
 ---
 sidebar_position: 0
-title: "Tools"
+title: "⚙️ Tools"
 ---
 
 ## What are Tools?

diff --git a/docs/features/rag.md b/docs/features/rag.md
@@ -1,6 +1,6 @@
 ---
-sidebar_position: 4
-title: "Retrieval Augmented Generation (RAG)"
+sidebar_position: 8
+title: "🔎 Retrieval Augmented Generation (RAG)"
 ---
 
 Retrieval Augmented Generation (RAG) is a a cutting-edge technology that enhances the conversational capabilities of chatbots by incorporating context from diverse sources. It works by retrieving relevant information from a wide range of sources such as local and remote documents, web content, and even multimedia sources like YouTube videos. The retrieved text is then combined with a predefined RAG template and prefixed to the user's prompt, providing a more informed and contextually relevant response.

diff --git a/docs/features/sso.md b/docs/features/sso.md
@@ -1,6 +1,6 @@
 ---
-sidebar_position: 9
-title: "SSO: Federated Authentication Support"
+sidebar_position: 11
+title: "🔒 SSO: Federated Authentication Support"
 ---
 
 # Federated Authentication Support

diff --git a/docs/features/tasks.md b/docs/features/tasks.md
@@ -0,0 +1,4 @@
+---
+sidebar_position: 4
+title: "📝 Task Model"
+---
diff --git a/docs/features/url-params.md b/docs/features/url-params.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 3
+sidebar_position: 5
 title: "🔗 URL Parameters"
 ---
 

diff --git a/docs/features/webhooks.md b/docs/features/webhooks.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 10
+sidebar_position: 12
 title: "🪝 Webhook for New Sign Ups"
 ---
 

diff --git a/docs/features/whitelist.md b/docs/features/whitelist.md
@@ -1,6 +1,6 @@
 ---
-sidebar_position: 8
-title: "Model Whitelisting"
+sidebar_position: 10
+title: "📝 Model Whitelisting"
 ---
 
 Open WebUI allows you to filter specific models for use in your instance. This feature is especially useful for administrators who want to control which models are available to users. Filtering can be done through the WebUI or by adding environment variables to the backend.

diff --git a/docs/features/workspace/tools.md b/docs/features/workspace/tools.md
diff --git a/docs/getting-started/advanced-topics/env-configuration.md b/docs/getting-started/advanced-topics/env-configuration.md
@@ -19,7 +19,7 @@ Last updated: v0.3.20
 The following environment variables are used by `backend/config.py` to provide Open WebUI startup
 configuration. Please note that some variables may have different default values depending on
 whether you're running Open WebUI directly or via Docker. For more information on logging
-environment variables, see our [logging documentation](./logging#appbackend).
+environment variables, see our [logging documentation](https://docs.openwebui.com/getting-started/advanced-topics/logging)).
 
 ### General
 
@@ -107,7 +107,7 @@ allowing the client to wait indefinitely.
 - Description: Toggles email, password, sign in and "or" (only when `ENABLE_OAUTH_SIGNUP` is set to True) elements.
 
 :::danger
-This should **only** ever be set to `False` when [ENABLE_OAUTH_SIGNUP](https://docs.openwebui.com/getting-started/env-configuration#enable_oauth_signup)
+This should **only** ever be set to `False` when [ENABLE_OAUTH_SIGNUP](https://docs.openwebui.com/getting-started/advanced-topics/env-configuration/#enable_oauth_signup)
 is also being used and set to `True`. Failure to do so will result in the inability to login.
 :::
 
@@ -330,18 +330,16 @@ If installed via Python, you must instead pass `--port` as a command line argume
 - Default: `False`
 - Description: Enables safe mode, which disables potentially unsafe features, deactivating all functions.
 
-
 #### `ENABLE_FORWARD_USER_INFO_HEADERS`
 
 - type: `bool`
 - Default: `False`
 - Description: Forwards user information (name, id, email, and role) as X-headers to OpenAI API.
 If enabled, the following headers are forwarded:
-    - `X-OpenWebUI-User-Name`
-    - `X-OpenWebUI-User-Id`
-    - `X-OpenWebUI-User-Email`
-    - `X-OpenWebUI-User-Role`
-
+  - `X-OpenWebUI-User-Name`
+  - `X-OpenWebUI-User-Id`
+  - `X-OpenWebUI-User-Email`
+  - `X-OpenWebUI-User-Role`
 
 #### `WEBUI_SESSION_COOKIE_SAME_SITE`
 
@@ -374,7 +372,7 @@ requests initiated by third-party websites, but only over HTTPS.
 - Description: Sets the timeout in seconds for internal aiohttp connections. This impacts things
 such as connections to Ollama and OpenAI endpoints.
 
-### `AIOHTTP_CLIENT_TIMEOUT_OPENAI_MODEL_LIST`
+#### `AIOHTTP_CLIENT_TIMEOUT_OPENAI_MODEL_LIST`
 
 - Type: `int`
 - Description: Sets the timeout in seconds for fetching the OpenAI model list. This can be useful in cases where network latency requires a longer timeout duration to successfully retrieve the model list.
@@ -559,7 +557,6 @@ Available Tools: {{TOOLS}}\nReturn an empty string if no tools match the query.
 - Default: `False`
 - Description: Controls whether or not SSL is used for ChromaDB Server connections.
 
-
 #### `CHROMA_CLIENT_AUTH_PROVIDER`
 
 - Type: `str`
@@ -572,7 +569,6 @@ Available Tools: {{TOOLS}}\nReturn an empty string if no tools match the query.
 - Description: Specifies auth credentials for remote ChromaDB Server.
 - Example: `username:password`
 
-
 #### `MILVUS_URI`
 
 - Type: `str`

diff --git a/docs/getting-started/quick-start/tab-docker/DockerSwarm.md b/docs/getting-started/quick-start/tab-docker/DockerSwarm.md
@@ -22,6 +22,7 @@ Choose the appropriate command based on your hardware setup:
 - **With GPU Support**:
 
   #### Docker-stack.yaml
+
     ```yaml
     version: '3.9'
 

diff --git a/docs/getting-started/quick-start/tab-python/PythonUpdating.md b/docs/getting-started/quick-start/tab-python/PythonUpdating.md
@@ -1,4 +1,4 @@
-## Updating
+# Updating with Python
 
 To update your locally installed **Open-WebUI** package to the latest version using `pip`, follow these simple steps:
 

diff --git a/docs/pipelines/tutorials.md b/docs/pipelines/tutorials.md
@@ -16,7 +16,7 @@ with us, as we'd love to feature it here!
 
 - 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)
+[Building Customized Text-To-SQL Pipelines](https://www.youtube.com/watch?v=y7frgUWrcT4) (YouTube video by Jordan Nanos)
 
 - Learn how to develop tailored text-to-sql pipelines, unlocking the power of data analysis and extraction.
 

diff --git a/docs/tutorials/integrations/apache.md b/docs/tutorials/integrations/apache.md
@@ -7,17 +7,13 @@ title: "Hosting UI and Models separately"
 This tutorial is a community contribution and is not supported by the OpenWebUI team. It serves only as a demonstration on how to customize OpenWebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
 :::
 
-# Hosting UI and Models separately
-
 :::note
 If you plan to expose this to the wide area network, consider implementing security like a [network firewall](https://github.com/chr0mag/geoipsets), [web application firewall](https://github.com/owasp-modsecurity/ModSecurity), and [threat intelligence](https://github.com/crowdsecurity/crowdsec).
 Additionally, it's strongly recommended to enable HSTS possibly like `Header always set Strict-Transport-Security "max-age=31536000; includeSubDomains"` within your **HTTPS** configuration and a redirect of some kind to your **HTTPS URL** within your **HTTP** configuration. For free SSL certification, [Let's Encrypt](https://letsencrypt.org/) is a good option coupled with [Certbot](https://github.com/certbot/certbot) management.
 :::
 
 Sometimes, its beneficial to host Ollama, separate from the UI, but retain the RAG and RBAC support features shared across users:
 
-# Open WebUI Configuration
-
 ## UI Configuration
 
 For the UI configuration, you can set up the Apache VirtualHost as follows:

diff --git a/docs/features/images.md → docs/tutorials/integrations/images.md b/docs/features/images.md → docs/tutorials/integrations/images.md
diff --git a/docs/tutorials/integrations/openedai-speech-integration.md b/docs/tutorials/integrations/openedai-speech-integration.md
@@ -212,7 +212,7 @@ The configuration files, which define the available voices and their properties,
 **Additional Resources**
 ------------------------
 
-For more information on configuring Open WebUI to use `openedai-speech`, including setting environment variables, see the [Open WebUI documentation](https://docs.openwebui.com/getting-started/env-configuration/#text-to-speech).
+For more information on configuring Open WebUI to use `openedai-speech`, including setting environment variables, see the [Open WebUI documentation](https://docs.openwebui.com/getting-started/advanced-topics/env-configuration#text-to-speech).
 
 For more information about `openedai-speech`, please visit the [GitHub repository](https://github.com/matatonic/openedai-speech).
 

diff --git a/docs/tutorials/integrations/tab-nginx/LetsEncrypt.md b/docs/tutorials/integrations/tab-nginx/LetsEncrypt.md
@@ -1,5 +1,7 @@
-
-### Let's Encrypt
+---
+sidebar_position: 200
+title: "Let's Encrypt"
+---
 
 Let's Encrypt provides free SSL certificates trusted by most browsers, ideal for production environments.
 

diff --git a/docs/tutorials/integrations/tab-nginx/SelfSigned.md b/docs/tutorials/integrations/tab-nginx/SelfSigned.md
@@ -1,4 +1,7 @@
-### Self-Signed Certificate
+---
+sidebar_position: 300
+title: "Self-Signed Certificate"
+---
 
 Using self-signed certificates is suitable for development or internal use where trust is not a critical concern.
 

diff --git a/docs/features/web_search.md → docs/tutorials/integrations/web_search.md b/docs/features/web_search.md → docs/tutorials/integrations/web_search.md
-Original file line number
+Diff line change
@@ Expand Up / @@ -22,6 +22,7 @@ Choose the appropriate command based on your hardware setup: @@
     - **With GPU Support**:
       #### Docker-stack.yaml
         ```yaml
         version: '3.9'
@@ Expand Down @@