intro.mdx 8.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180
  1. ---
  2. sidebar_position: 0
  3. slug: /
  4. title: 🏡 Home
  5. hide_title: true
  6. ---
  7. import { TopBanners } from "@site/src/components/TopBanners";
  8. import { SponsorList } from "@site/src/components/SponsorList";
  9. # Open WebUI
  10. <TopBanners />
  11. **Open WebUI is an [extensible](https://docs.openwebui.com/features/plugin/), feature-rich, and user-friendly self-hosted AI interface designed to operate entirely offline.** It supports various LLM runners, including Ollama and OpenAI-compatible APIs.
  12. ![GitHub stars](https://img.shields.io/github/stars/open-webui/open-webui?style=social)
  13. ![GitHub forks](https://img.shields.io/github/forks/open-webui/open-webui?style=social)
  14. ![GitHub watchers](https://img.shields.io/github/watchers/open-webui/open-webui?style=social)
  15. ![GitHub repo size](https://img.shields.io/github/repo-size/open-webui/open-webui)
  16. ![GitHub language count](https://img.shields.io/github/languages/count/open-webui/open-webui)
  17. ![GitHub top language](https://img.shields.io/github/languages/top/open-webui/open-webui)
  18. ![GitHub last commit](https://img.shields.io/github/last-commit/open-webui/open-webui?color=red)
  19. ![Hits](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2Follama-webui%2Follama-wbui&count_bg=%2379C83D&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=hits&edge_flat=false)
  20. [![Discord](https://img.shields.io/badge/Discord-Open_WebUI-blue?logo=discord&logoColor=white)](https://discord.gg/5rJgQTnV4s)
  21. [![](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub&color=%23fe8e86)](https://github.com/sponsors/tjbck)
  22. ![Open WebUI Demo](/img/demo.gif)
  23. :::info **Important Note on User Roles and Privacy:**
  24. - **Admin Creation:** The first account created on Open WebUI gains **Administrator privileges**, controlling user management and system settings.
  25. - **User Registrations:** Subsequent sign-ups start with **Pending** status, requiring Administrator approval for access.
  26. - **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.
  27. :::
  28. ## Quick Start with Docker 🐳 (Recommended)
  29. :::tip
  30. #### Disabling Login for Single User
  31. If you want to disable login for a single-user setup, set [`WEBUI_AUTH`](./getting-started/advanced-topics/env-configuration) to `False`. This will bypass the login page.
  32. :::warning
  33. You cannot switch between single-user mode and multi-account mode after this change.
  34. :::
  35. :::danger
  36. When using Docker to install Open WebUI, make sure to include the `-v open-webui:/app/backend/data` in your Docker command. This step is crucial as it ensures your database is properly mounted and prevents any loss of data.
  37. :::
  38. <details>
  39. <summary>Data Storage in Docker</summary>
  40. This tutorial uses [Docker named volumes](https://docs.docker.com/storage/volumes/) to guarantee the **persistance of your data**. This might make it difficult to know exactly where your data is stored in your machine if this is your first time using Docker. Alternatively, you can replace the volume name with a absolute path on your host machine to link your container data to a folder in your computer using a [bind mount](https://docs.docker.com/storage/bind-mounts/).
  41. **Example**: change `-v open-webui:/app/backend/data` to `-v /path/to/folder:/app/backend/data`
  42. Ensure you have the proper access rights to the folder on your host machine.
  43. Visit the [Docker documentation](https://docs.docker.com/storage/) to understand more about volumes and bind mounts.
  44. </details>
  45. ### Installation with Default Configuration
  46. - **If Ollama is on your computer**, use this command:
  47. ```bash
  48. docker run -d -p 3000:8080 --add-host=host.docker.internal:host-gateway -v open-webui:/app/backend/data --name open-webui --restart always ghcr.io/open-webui/open-webui:main
  49. ```
  50. - **If Ollama is on a Different Server**, use this command:
  51. To connect to Ollama on another server, change the `OLLAMA_BASE_URL` to the server's URL:
  52. ```bash
  53. docker run -d -p 3000:8080 -e OLLAMA_BASE_URL=https://example.com -v open-webui:/app/backend/data --name open-webui --restart always ghcr.io/open-webui/open-webui:main
  54. ```
  55. - **To run Open WebUI with Nvidia GPU support**, use this command:
  56. ```bash
  57. docker run -d -p 3000:8080 --gpus all --add-host=host.docker.internal:host-gateway -v open-webui:/app/backend/data --name open-webui --restart always ghcr.io/open-webui/open-webui:cuda
  58. ```
  59. ### Installation for OpenAI API Usage Only
  60. - **If you're only using OpenAI API**, use this command:
  61. ```bash
  62. docker run -d -p 3000:8080 -e OPENAI_API_KEY=your_secret_key -v open-webui:/app/backend/data --name open-webui --restart always ghcr.io/open-webui/open-webui:main
  63. ```
  64. ### Installing Open WebUI with Bundled Ollama Support
  65. This installation method uses a single container image that bundles Open WebUI with Ollama, allowing for a streamlined setup via a single command. Choose the appropriate command based on your hardware setup:
  66. - **With GPU Support**:
  67. Utilize GPU resources by running the following command:
  68. ```bash
  69. docker run -d -p 3000:8080 --gpus=all -v ollama:/root/.ollama -v open-webui:/app/backend/data --name open-webui --restart always ghcr.io/open-webui/open-webui:ollama
  70. ```
  71. - **For CPU Only**:
  72. If you're not using a GPU, use this command instead:
  73. ```bash
  74. docker run -d -p 3000:8080 -v ollama:/root/.ollama -v open-webui:/app/backend/data --name open-webui --restart always ghcr.io/open-webui/open-webui:ollama
  75. ```
  76. Both commands facilitate a built-in, hassle-free installation of both Open WebUI and Ollama, ensuring that you can get everything up and running swiftly.
  77. After installation, you can access Open WebUI at [http://localhost:3000](http://localhost:3000). Enjoy! 😄
  78. ### Using the Dev Branch 🌙
  79. :::warning
  80. The `:dev` branch contains the latest unstable features and changes. Use it at your own risk as it may have bugs or incomplete features.
  81. :::
  82. If you want to try out the latest bleeding-edge features and are okay with occasional instability, you can use the `:dev` tag like this:
  83. ```bash
  84. docker run -d -p 3000:8080 -v open-webui:/app/backend/data --name open-webui --restart always ghcr.io/open-webui/open-webui:dev
  85. ```
  86. ## Manual Installation
  87. ### Installation with `pip` (Beta)
  88. For users who prefer to use Python's package manager `pip`, Open WebUI offers a installation method. Python 3.11 is required for this method.
  89. 1. **Install Open WebUI**:
  90. Open your terminal and run the following command:
  91. ```bash
  92. pip install open-webui
  93. ```
  94. 2. **Start Open WebUI**:
  95. Once installed, start the server using:
  96. ```bash
  97. open-webui serve
  98. ```
  99. This method installs all necessary dependencies and starts Open WebUI, allowing for a simple and efficient setup. After installation, you can access Open WebUI at [http://localhost:8080](http://localhost:8080). Enjoy! 😄
  100. ## Other Installation Methods
  101. We offer various installation alternatives, including non-Docker native installation methods, Docker Compose, Kustomize, and Helm. Visit our [Open WebUI Documentation](https://docs.openwebui.com/getting-started/) or join our [Discord community](https://discord.gg/5rJgQTnV4s) for comprehensive guidance.
  102. ## Troubleshooting
  103. If you're facing various issues like "Open WebUI: Server Connection Error", see [TROUBLESHOOTING](troubleshooting) for information on how to troubleshoot and/or join our [Open WebUI Discord community](https://discord.gg/5rJgQTnV4s).
  104. ## Updating
  105. Check out how to update Docker in the [Quick Start guide](./getting-started/quick-start).
  106. In case you want to update your local Docker installation to the latest version, you can do it with [Watchtower](https://containrrr.dev/watchtower/):
  107. ```bash
  108. docker run --rm --volume /var/run/docker.sock:/var/run/docker.sock containrrr/watchtower --run-once open-webui
  109. ```
  110. In the last part of the command, replace `open-webui` with your container name if it is different.
  111. Continue with the full [getting started guide](/getting-started).
  112. ## Sponsors 🙌
  113. We are incredibly grateful for the generous support of our sponsors. Their contributions help us to maintain and improve our project, ensuring we can continue to deliver quality work to our community. Thank you!
  114. <SponsorList />