From 73fc0651d24d09d4721460c8420b36cb2f4b9242 Mon Sep 17 00:00:00 2001 From: Matthew Hand Date: Tue, 5 Nov 2024 19:51:44 +0000 Subject: [PATCH] Add quick-start/index.mdx changes from feature-nginx-combined --- docs/getting-started/quick-start/index.mdx | 155 +++++++++++++++++++++ 1 file changed, 155 insertions(+) create mode 100644 docs/getting-started/quick-start/index.mdx diff --git a/docs/getting-started/quick-start/index.mdx b/docs/getting-started/quick-start/index.mdx new file mode 100644 index 0000000..1ba1bf1 --- /dev/null +++ b/docs/getting-started/quick-start/index.mdx @@ -0,0 +1,155 @@ +--- +sidebar_position: 2 +title: "⏱️ Quick Start" +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import { TopBanners } from "@site/src/components/TopBanners"; + +import DockerCompose from './tab-docker/DockerCompose.md'; +import Podman from './tab-docker/Podman.md'; +import ManualDocker from './tab-docker/ManualDocker.md'; +import DockerSwarm from './tab-docker/DockerSwarm.md'; +import DataStorage from './tab-docker/DataStorage.md'; +import DockerUpdating from './tab-docker/DockerUpdating.md'; +import Helm from './tab-kubernetes/Helm.md'; +import Kustomize from './tab-kubernetes/Kustomize.md'; +import Venv from './tab-python/Venv.md'; +import CondaUnix from './tab-python/CondaUnix.md'; +import CondaWindows from './tab-python/CondaWindows.md'; + + + +## How to Install ⏱️ + +:::info **Important Note on User Roles and Privacy:** + +- **Admin Creation:** The first account created on Open WebUI gains **Administrator privileges**, controlling user management and system settings. +- **User Registrations:** Subsequent sign-ups start with **Pending** status, requiring Administrator approval for access. +- **Privacy and Data Security:** **All your data**, including login details, is **locally stored** on your device. Open WebUI ensures **strict confidentiality** and **no external requests** for enhanced privacy and security. + +::: + +Choose your preferred installation method below: + +- **Docker:** Recommended for most users due to ease of setup and flexibility. +- **Kubernetes:** Ideal for enterprise deployments that require scaling and orchestration. +- **Python:** Suitable for low-resource environments or those wanting a manual setup. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Choose Your Platform

+ + + + + + + + + +
+ + +

Development Setup

+

+ For developers who want to contribute, check the Development Guide in Advanced Topics. +

+
+
+
+ + + + + ### Pinokio.computer Installation + + For installation via Pinokio.computer, please visit their website: + + [https://pinokio.computer/](https://pinokio.computer/) + + Support for this installation method is provided through their website. + + + + ### Additional Third-Party Integrations + + *(Add information about third-party integrations as they become available.)* + +
+ +## Next Steps + +After installing, visit: + +- [http://localhost:3000](http://localhost:3000) to access OpenWebUI. +- or [http://localhost:8080/](http://localhost:8080/) when using a Python deployment. + +You are now ready to start **[Using OpenWebUI](../using-openwebui/index.mdx)**! + +## Join the Community + +Need help? Have questions? Join our community: + +- [Open WebUI Discord](https://discord.gg/5rJgQTnV4s) +- [GitHub Issues](https://github.com/open-webui/open-webui/issues) + +Stay updated with the latest features, troubleshooting tips, and announcements! + +## Conclusion + +Thank you for choosing Open WebUI! We are committed to providing a powerful, privacy-focused interface for your LLM needs. If you encounter any issues, refer to the [Troubleshooting Guide](../../troubleshooting/index.mdx). + +Happy exploring! 🎉