docs/docs/getting-started/quick-start/index.mdx
Timothy Jaeryang Baek fe642b4d6d refac
2025-01-08 13:38:25 -08:00

160 lines
4.8 KiB
Plaintext

---
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 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 Conda from './tab-python/Conda.md';
import PythonUpdating from './tab-python/PythonUpdating.md';
<TopBanners />
:::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.
- **All models are private by default.** Models must be explicitly shared via groups or by being made public. If a model is assigned to a group, only members of that group can see it. If a model is made public, anyone on the instance can see it.
:::
Choose your preferred installation method below:
- **Docker:** **Officially supported and recommended for most users**
- **Python:** Suitable for low-resource environments or those wanting a manual setup
- **Kubernetes:** Ideal for enterprise deployments that require scaling and orchestration
<Tabs>
<TabItem value="docker" label="Docker">
<Tabs>
<TabItem value="docker" label="Docker">
<div className='mt-5'>
<ManualDocker />
<DockerUpdating />
</div>
</TabItem>
<TabItem value="compose" label="Docker Compose">
<div className='mt-5'>
<DockerCompose />
</div>
</TabItem>
<TabItem value="podman" label="Podman">
<div className='mt-5'>
<Podman />
</div>
</TabItem>
<TabItem value="swarm" label="Docker Swarm">
<div className='mt-5'>
<DockerSwarm />
</div>
</TabItem>
</Tabs>
</TabItem>
<TabItem value="python" label="Python">
<Tabs>
{/* <TabItem value="uvx" label="uvx">
<div className='mt-5'>
<Uvx />
</div>
<PythonUpdating />
</TabItem> */}
<TabItem value="conda" label="Conda">
<div className='mt-5'>
<Conda />
</div>
<PythonUpdating />
</TabItem>
<TabItem value="venv" label="Venv">
<div className='mt-5'>
<Venv />
</div>
<PythonUpdating />
</TabItem>
<TabItem value="development" label="Development">
<div className='mt-5'>
<h3>Development Setup</h3>
<p>
For developers who want to contribute, check the Development Guide in <a href="/getting-started/advanced-topics">Advanced Topics</a>.
</p>
</div>
</TabItem>
</Tabs>
</TabItem>
<TabItem value="kubernetes" label="Kubernetes">
<Tabs>
<TabItem value="helm" label="Helm">
<Helm />
</TabItem>
<TabItem value="kustomize" label="Kustomize">
<Kustomize />
</TabItem>
</Tabs>
</TabItem>
<TabItem value="third-party" label="Third Party">
<Tabs>
<TabItem value="pinokio-computer" label="Pinokio.computer">
### 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.
</TabItem>
</Tabs>
### Additional Third-Party Integrations
*(Add information about third-party integrations as they become available.)*
</TabItem>
</Tabs>
## 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 with Ollama
If you're using OpenWebUI with Ollama, be sure to check out our [Starting with Ollama Guide](/getting-started/quick-start/starting-with-ollama) to learn how to manage your Ollama instances with Open WebUI.
## 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!