From 56ee9980bc1216e341c7b74e95e6083a0e1c76fa Mon Sep 17 00:00:00 2001 From: Silentoplayz <50341825+Silentoplayz@users.noreply.github.com> Date: Tue, 17 Dec 2024 22:24:12 -0500 Subject: [PATCH] Further clean up Further clean up --- docs/features/banners.md | 2 +- docs/features/chat-params.md | 2 +- docs/features/index.mdx | 2 +- docs/features/jwttoken.md | 2 +- docs/features/memory.md | 4 ++++ docs/features/oauth/index.mdx | 4 ++++ docs/features/ollama.md | 2 +- docs/features/openai.md | 4 ++-- docs/features/playground(beta)/index.mdx | 2 +- docs/features/plugin/functions/actions.md | 2 +- docs/features/plugin/functions/index.mdx | 2 +- docs/features/plugin/index.mdx | 2 +- docs/features/plugin/tools/index.mdx | 2 +- docs/features/rag.md | 4 ++-- docs/features/sso.md | 4 ++-- docs/features/tasks.md | 4 ++++ docs/features/url-params.md | 2 +- docs/features/webhooks.md | 2 +- docs/features/whitelist.md | 4 ++-- docs/features/workspace/tools.md | 4 ---- .../advanced-topics/env-configuration.md | 18 +++++++----------- .../quick-start/tab-docker/DockerSwarm.md | 1 + .../quick-start/tab-python/PythonUpdating.md | 2 +- docs/pipelines/tutorials.md | 2 +- docs/tutorials/integrations/apache.md | 4 ---- .../integrations}/images.md | 0 .../openedai-speech-integration.md | 2 +- .../integrations/tab-nginx/LetsEncrypt.md | 6 ++++-- .../integrations/tab-nginx/SelfSigned.md | 5 ++++- .../integrations}/web_search.md | 0 30 files changed, 51 insertions(+), 45 deletions(-) create mode 100644 docs/features/memory.md create mode 100644 docs/features/oauth/index.mdx create mode 100644 docs/features/tasks.md delete mode 100644 docs/features/workspace/tools.md rename docs/{features => tutorials/integrations}/images.md (100%) rename docs/{features => tutorials/integrations}/web_search.md (100%) diff --git a/docs/features/banners.md b/docs/features/banners.md index f7dd0de8..d919ea9d 100644 --- 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 index a8d9575e..98716bd2 100644 --- 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 index e66e8630..fb618569 100644 --- 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 index 7526b1e4..e810ffae 100644 --- 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 new file mode 100644 index 00000000..fbd2b0b6 --- /dev/null +++ b/docs/features/memory.md @@ -0,0 +1,4 @@ +--- +sidebar_position: 15 +title: "🧠 Memory (Experimental)" +--- \ No newline at end of file diff --git a/docs/features/oauth/index.mdx b/docs/features/oauth/index.mdx new file mode 100644 index 00000000..e9842c6a --- /dev/null +++ b/docs/features/oauth/index.mdx @@ -0,0 +1,4 @@ +--- +sidebar_position: 4 +title: "🔐 OAuth" +--- \ No newline at end of file diff --git a/docs/features/ollama.md b/docs/features/ollama.md index 90ea0219..42c24254 100644 --- 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 index b520fc2d..fe7af252 100644 --- 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 index 5ae07645..3f071ce3 100644 --- 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 index 2110858f..ad0e12a5 100644 --- 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 index 5afd5519..e65a260c 100644 --- 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 index 3ec51fef..e4c82725 100644 --- 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 index b4eccbbf..c12373bf 100644 --- 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 index 45c6933e..1fcfd455 100644 --- 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 index 7c480dd6..a4e1166c 100644 --- 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 new file mode 100644 index 00000000..6c9286bc --- /dev/null +++ b/docs/features/tasks.md @@ -0,0 +1,4 @@ +--- +sidebar_position: 4 +title: "📝 Task Model" +--- \ No newline at end of file diff --git a/docs/features/url-params.md b/docs/features/url-params.md index 95d60c84..45755339 100644 --- 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 index 50b10845..bca38dcf 100644 --- 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 index f030bed1..6122ff12 100644 --- 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 deleted file mode 100644 index 2f5e147b..00000000 --- a/docs/features/workspace/tools.md +++ /dev/null @@ -1,4 +0,0 @@ ---- -sidebar_position: 3 -title: "🛠️ Tools" ---- \ No newline at end of file diff --git a/docs/getting-started/advanced-topics/env-configuration.md b/docs/getting-started/advanced-topics/env-configuration.md index 99191478..fe0e4e09 100644 --- 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 index bf4d147f..9ae7175e 100644 --- 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 index 0d1b8579..39b0f5cb 100644 --- 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 index aee33759..6be94381 100644 --- 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 index b408c3f3..7b8d6259 100644 --- a/docs/tutorials/integrations/apache.md +++ b/docs/tutorials/integrations/apache.md @@ -7,8 +7,6 @@ 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. @@ -16,8 +14,6 @@ Additionally, it's strongly recommended to enable HSTS possibly like `Header alw 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 b/docs/tutorials/integrations/images.md similarity index 100% rename from docs/features/images.md rename to docs/tutorials/integrations/images.md diff --git a/docs/tutorials/integrations/openedai-speech-integration.md b/docs/tutorials/integrations/openedai-speech-integration.md index 2602ff63..43746113 100644 --- 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 index 3bd4ae15..eb75290c 100644 --- 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 index f2a637a1..34a717f0 100644 --- 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 b/docs/tutorials/integrations/web_search.md similarity index 100% rename from docs/features/web_search.md rename to docs/tutorials/integrations/web_search.md