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

doc: top banner for all index

Browse Source
This commit is contained in:
Timothy J. Baek 2024-05-28 13:31:11 -07:00
parent 35b0252baf
commit 073ed0c4ba
13 changed files with 201 additions and 59 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/contributing.md → docs/contributing.mdx
View File

@ -3,6 +3,10 @@ sidebar_position: 1000
title: "🤝 Contributing" title: "🤝 Contributing"
--- ---
import { TopBanners } from "@site/src/components/TopBanners";
<TopBanners />
# Contributing to Open WebUI # Contributing to Open WebUI
🚀 **Welcome, Contributors!** 🚀 🚀 **Welcome, Contributors!** 🚀

4
docs/faq.md → docs/faq.mdx
View File

@ -3,6 +3,10 @@ sidebar_position: 600
title: "📋 FAQ" title: "📋 FAQ"
--- ---
import { TopBanners } from "@site/src/components/TopBanners";
<TopBanners />
# 📋 Frequently Asked Questions # 📋 Frequently Asked Questions
### Table of Contents ### Table of Contents

4
docs/features.md → docs/features.mdx
View File

@ -3,6 +3,10 @@ sidebar_position: 3
title: "⭐ Features" title: "⭐ Features"
--- ---
import { TopBanners } from "@site/src/components/TopBanners";
<TopBanners />
## Key Features of Open WebUI ⭐ ## Key Features of Open WebUI ⭐
- 🚀 **Effortless Setup**: Install seamlessly using Docker or Kubernetes (kubectl, kustomize or helm) for a hassle-free experience with support for both `:ollama` and `:cuda` tagged images. - 🚀 **Effortless Setup**: Install seamlessly using Docker or Kubernetes (kubectl, kustomize or helm) for a hassle-free experience with support for both `:ollama` and `:cuda` tagged images.

4
docs/getting-started/index.md → docs/getting-started/index.mdx
View File

@ -3,6 +3,10 @@ sidebar_position: 2
title: "🚀 Getting Started" title: "🚀 Getting Started"
--- ---
import { TopBanners } from "@site/src/components/TopBanners";
<TopBanners />
## How to Install 🚀 ## How to Install 🚀
:::info **Important Note on User Roles and Privacy:** :::info **Important Note on User Roles and Privacy:**

23
docs/intro.mdx
View File

@ -5,28 +5,9 @@ title: 🏡 Home
hide_title: true hide_title: true
--- ---
import { TopBanner } from "@site/src/components/Sponsors/TopBanner"; import { TopBanners } from "@site/src/components/TopBanners";
<TopBanner <TopBanners />
items={[
{
imgSrc: "/ads/pipelines-banner.png",
mobileImgSrc: "/ads/pipelines-banner-mobile.png",
url: "https://github.com/open-webui/pipelines",
name: "Open WebUI Pipelines",
description:
"Pipelines: Versatile, UI-Agnostic OpenAI-Compatible Plugin Framework",
},
{
imgSrc: "/ads/placeholder.png",
mobileImgSrc: "/ads/placeholder-mobile.png",
url: "https://github.com/sponsors/tjbck",
name: "Open WebUI",
description:
"The top banner spot is reserved for only two Enterprise Diamond sponsors on a first-come, first-served basis",
},
]}
/>
# Open WebUI # Open WebUI

4
docs/migration.md → docs/migration.mdx
View File

@ -3,6 +3,10 @@ sidebar_position: 800
title: "🔄 Migration" title: "🔄 Migration"
--- ---
import { TopBanners } from "@site/src/components/TopBanners";
<TopBanners />
# Moving from Ollama WebUI to Open WebUI # Moving from Ollama WebUI to Open WebUI
Given recent name changes from [Ollama WebUI to Open WebUI](https://github.com/open-webui/open-webui/discussions/602), the docker image has been renamed. Additional steps are required to update for those people that used Ollama WebUI previously and want to start using the new images. Given recent name changes from [Ollama WebUI to Open WebUI](https://github.com/open-webui/open-webui/discussions/602), the docker image has been renamed. Additional steps are required to update for those people that used Ollama WebUI previously and want to start using the new images.

4
docs/research.md → docs/research.mdx
View File

@ -3,6 +3,10 @@ sidebar_position: 900
title: "🧑‍🔬 Open WebUI for Research" title: "🧑‍🔬 Open WebUI for Research"
--- ---
import { TopBanners } from "@site/src/components/TopBanners";
<TopBanners />
# 🧑‍🔬 Open WebUI for Research # 🧑‍🔬 Open WebUI for Research
## Interested in Using Open WebUI for Research? ## Interested in Using Open WebUI for Research?

4
docs/roadmap.md → docs/roadmap.mdx
View File

@ -3,6 +3,10 @@ sidebar_position: 700
title: "🛣️ Roadmap" title: "🛣️ Roadmap"
--- ---
import { TopBanners } from "@site/src/components/TopBanners";
<TopBanners />
# 🎯 Our Mission # 🎯 Our Mission
Our mission is founded on the belief that AI technologies hold transformative potential for society, yet their benefits have been narrowly confined due to complex setup requirements. Recognizing this, we are dedicated to democratizing AI by developing an easy-to-install, feature-rich local WebUI that is designed to operate locally without internet access. Enabling anyone with basic technical skills to tap into the power of AI, effectively bringing its capabilities to communities far and wide. Our mission is founded on the belief that AI technologies hold transformative potential for society, yet their benefits have been narrowly confined due to complex setup requirements. Recognizing this, we are dedicated to democratizing AI by developing an easy-to-install, feature-rich local WebUI that is designed to operate locally without internet access. Enabling anyone with basic technical skills to tap into the power of AI, effectively bringing its capabilities to communities far and wide.

4
docs/sponsorships.md → docs/sponsorships.mdx
View File

@ -3,6 +3,10 @@ sidebar_position: 1100
title: "🌐 Sponsorships" title: "🌐 Sponsorships"
--- ---
import { TopBanners } from "@site/src/components/TopBanners";
<TopBanners />
# 🤝 Sponsorships # 🤝 Sponsorships
At Open WebUI, our community always comes first. Sponsors are welcome, but they must respect our community-first approach. This philosophy guides all our sponsorship policies. At Open WebUI, our community always comes first. Sponsors are welcome, but they must respect our community-first approach. This philosophy guides all our sponsorship policies.

4
docs/troubleshooting/index.md → docs/troubleshooting/index.mdx
View File

@ -3,6 +3,10 @@ sidebar_position: 400
title: "🛠️ Troubleshooting" title: "🛠️ Troubleshooting"
--- ---
import { TopBanners } from "@site/src/components/TopBanners";
<TopBanners />
# Troubleshooting # Troubleshooting
## Understanding the Open WebUI Architecture ## Understanding the Open WebUI Architecture

38
docs/tutorial-deployment/index.md
View File

@ -1,38 +0,0 @@
---
sidebar_position: 500
title: "☁️ Deployment"
---
# ☁️ Deployment
:::info
# **Seeking Contributors!**
👋 Calling all youtubers! Want to showcase Open WebUI's features in a video? We'll feature it at the top of our guide section!
:::
<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/QHuTBksNt_w?si=l99ZFxeNbbPcyfch" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/Gyvy9JpDVBw?si=qUf0DVd4bnp_ndzH" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/Ic5BRW_nLok?si=zhQXPqb0PuKqg3u1" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/bp2eev21Qfo?si=-JoG1as7l6ZjNDyE" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/DHVQ1UBaYMQ?si=PjslnpJKiHsct8lF" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/Wjrdr0NU4Sk?si=gDsyvkE19AsMlJJa" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/kDwEIgmqaEE?si=hes3N1xHp7AaVOGk" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/D4H5hMMoZ28?si=vKiTocXDRkez1SoV" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/syR0fT0rkgY?si=UusLnKSvU1HGjtyc" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/jlvjipGNwSU?si=RrPk-tMRFU_badO8" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/PhCoRPY7hCE?si=flHuovmiwx7DwKZb" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/zc3ltJeMNpM?si=FJvfCccQYIntnAJR" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>

137
docs/tutorial-deployment/index.mdx Normal file
View File

@ -0,0 +1,137 @@
---
sidebar_position: 500
title: "☁️ Deployment"
---
import { TopBanners } from "@site/src/components/TopBanners";
<TopBanners />
# ☁️ Deployment
:::info
# **Seeking Contributors!**
👋 Calling all youtubers! Want to showcase Open WebUI's features in a video? We'll feature it at the top of our guide section!
:::
<iframe
width="560"
height="315"
src="https://www.youtube-nocookie.com/embed/QHuTBksNt_w?si=l99ZFxeNbbPcyfch"
title="YouTube video player"
frameborder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
allowfullscreen
></iframe>
<iframe
width="560"
height="315"
src="https://www.youtube-nocookie.com/embed/Gyvy9JpDVBw?si=qUf0DVd4bnp_ndzH"
title="YouTube video player"
frameborder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
allowfullscreen
></iframe>
<iframe
width="560"
height="315"
src="https://www.youtube-nocookie.com/embed/Ic5BRW_nLok?si=zhQXPqb0PuKqg3u1"
title="YouTube video player"
frameborder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
allowfullscreen
></iframe>
<iframe
width="560"
height="315"
src="https://www.youtube-nocookie.com/embed/bp2eev21Qfo?si=-JoG1as7l6ZjNDyE"
title="YouTube video player"
frameborder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
allowfullscreen
></iframe>
<iframe
width="560"
height="315"
src="https://www.youtube-nocookie.com/embed/DHVQ1UBaYMQ?si=PjslnpJKiHsct8lF"
title="YouTube video player"
frameborder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
allowfullscreen
></iframe>
<iframe
width="560"
height="315"
src="https://www.youtube-nocookie.com/embed/Wjrdr0NU4Sk?si=gDsyvkE19AsMlJJa"
title="YouTube video player"
frameborder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
allowfullscreen
></iframe>
<iframe
width="560"
height="315"
src="https://www.youtube-nocookie.com/embed/kDwEIgmqaEE?si=hes3N1xHp7AaVOGk"
title="YouTube video player"
frameborder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
allowfullscreen
></iframe>
<iframe
width="560"
height="315"
src="https://www.youtube-nocookie.com/embed/D4H5hMMoZ28?si=vKiTocXDRkez1SoV"
title="YouTube video player"
frameborder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
allowfullscreen
></iframe>
<iframe
width="560"
height="315"
src="https://www.youtube-nocookie.com/embed/syR0fT0rkgY?si=UusLnKSvU1HGjtyc"
title="YouTube video player"
frameborder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
allowfullscreen
></iframe>
<iframe
width="560"
height="315"
src="https://www.youtube-nocookie.com/embed/jlvjipGNwSU?si=RrPk-tMRFU_badO8"
title="YouTube video player"
frameborder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
allowfullscreen
></iframe>
<iframe
width="560"
height="315"
src="https://www.youtube-nocookie.com/embed/PhCoRPY7hCE?si=flHuovmiwx7DwKZb"
title="YouTube video player"
frameborder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
allowfullscreen
></iframe>
<iframe
width="560"
height="315"
src="https://www.youtube-nocookie.com/embed/zc3ltJeMNpM?si=FJvfCccQYIntnAJR"
title="YouTube video player"
frameborder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
allowfullscreen
></iframe>

26
src/components/TopBanners.js Normal file
View File

@ -0,0 +1,26 @@
import { TopBanner } from "@site/src/components/Sponsors/TopBanner";
export const TopBanners = () => {
return (
<TopBanner
items={[
{
imgSrc: "/ads/pipelines-banner.png",
mobileImgSrc: "/ads/pipelines-banner-mobile.png",
url: "https://github.com/open-webui/pipelines",
name: "Open WebUI Pipelines",
description:
"Pipelines: Versatile, UI-Agnostic OpenAI-Compatible Plugin Framework",
},
{
imgSrc: "/ads/placeholder.png",
mobileImgSrc: "/ads/placeholder-mobile.png",
url: "https://github.com/sponsors/tjbck",
name: "Open WebUI",
description:
"The top banner spot is reserved for only two Enterprise Diamond sponsors on a first-come, first-served basis",
},
]}
/>
);
};