doc: update

docs/getting-started.md

@@ -2,3 +2,146 @@
 sidebar_position: 2
 title: "🔑 Getting Started"
 ---
+
+## How to Install 🚀
+
+🌟 **Important Note on User Roles and Privacy:**
+
+- **Admin Creation:** The very first account to sign up on Open WebUI will be granted **Administrator privileges**. This account will have comprehensive control over the platform, including user management and system settings.
+
+- **User Registrations:** All subsequent users signing up will initially have their accounts set to **Pending** status by default. These accounts will require approval from the Administrator to gain access to the platform functionalities.
+
+- **Privacy and Data Security:** We prioritize your privacy and data security above all. Please be reassured that all data entered into Open WebUI is stored locally on your device. Our system is designed to be privacy-first, ensuring that no external requests are made, and your data does not leave your local environment. We are committed to maintaining the highest standards of data privacy and security, ensuring that your information remains confidential and under your control.
+
+### Steps to Install Open WebUI
+
+#### Before You Begin
+
+1. **Installing Docker:**
+
+   - **For Windows and Mac Users:**
+
+     - Download Docker Desktop from [Docker's official website](https://www.docker.com/products/docker-desktop).
+     - Follow the installation instructions provided on the website. After installation, open Docker Desktop to ensure it's running properly.
+
+   - **For Ubuntu and Other Linux Users:**
+     - Open your terminal.
+     - Set up your Docker apt repository according to the [Docker documentation](https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository)
+     - Update your package index:
+       ```bash
+       sudo apt-get update
+       ```
+     - Install Docker using the following command:
+       ```bash
+       sudo apt-get install docker-ce docker-ce-cli containerd.io
+       ```
+     - Verify the Docker installation with:
+       ```bash
+       sudo docker run hello-world
+       ```
+       This command downloads a test image and runs it in a container, which prints an informational message.
+
+2. **Ensure You Have the Latest Version of Ollama:**
+
+   - Download the latest version from [https://ollama.com/](https://ollama.com/).
+
+3. **Verify Ollama Installation:**
+   - After installing Ollama, check if it's working by visiting [http://127.0.0.1:11434/](http://127.0.0.1:11434/) in your web browser. Remember, the port number might be different for you.
+
+#### Installing with Docker 🐳
+
+- **Important:** 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.
+
+- **If Ollama is on your computer**, use this command:
+
+  ```bash
+  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
+  ```
+
+- **To build the container yourself**, follow these steps:
+
+  ```bash
+  docker build -t open-webui .
+  docker run -d -p 3000:8080 --add-host=host.docker.internal:host-gateway -v open-webui:/app/backend/data --name open-webui --restart always open-webui
+  ```
+
+- After installation, you can access Open WebUI at [http://localhost:3000](http://localhost:3000).
+
+#### Using Ollama on a Different Server
+
+- To connect to Ollama on another server, change the `OLLAMA_API_BASE_URL` to the server's URL:
+
+  ```bash
+  docker run -d -p 3000:8080 -e OLLAMA_API_BASE_URL=https://example.com/api -v open-webui:/app/backend/data --name open-webui --restart always ghcr.io/open-webui/open-webui:main
+  ```
+
+  Or for a self-built container:
+
+  ```bash
+  docker build -t open-webui .
+  docker run -d -p 3000:8080 -e OLLAMA_API_BASE_URL=https://example.com/api -v open-webui:/app/backend/data --name open-webui --restart always open-webui
+  ```
+
+### Installing Ollama and Open WebUI Together
+
+#### Using Docker Compose
+
+- If you don't have Ollama yet, use Docker Compose for easy installation. Run this command:
+
+  ```bash
+  docker compose up -d --build
+  ```
+
+- **For GPU Support:** Use an additional Docker Compose file:
+
+  ```bash
+  docker compose -f docker-compose.yaml -f docker-compose.gpu.yaml up -d --build
+  ```
+
+- **To Expose Ollama API:** Use another Docker Compose file:
+
+  ```bash
+  docker compose -f docker-compose.yaml -f docker-compose.api.yaml up -d --build
+  ```
+
+#### Using `run-compose.sh` Script (Linux or Docker-Enabled WSL2 on Windows)
+
+- Give execute permission to the script:
+
+  ```bash
+  chmod +x run-compose.sh
+  ```
+
+- For CPU-only container:
+
+  ```bash
+  ./run-compose.sh
+  ```
+
+- For GPU support (read the note about GPU compatibility):
+
+  ```bash
+  ./run-compose.sh --enable-gpu
+  ```
+
+- To build the latest local version, add `--build`:
+
+  ```bash
+  ./run-compose.sh --enable-gpu --build
+  ```
+
+### Alternative Installation Methods
+
+For other ways to install, like using Kustomize or Helm, check out [INSTALLATION.md](/INSTALLATION.md). Join our [Open WebUI Discord community](https://discord.gg/5rJgQTnV4s) for more help and information.
+
+### Updating your Docker Installation
+
+In case you want to update your local Docker installation to the latest version, you can do it performing the following actions:
+
+```bash
+docker rm -f open-webui
+docker pull ghcr.io/open-webui/open-webui:main
+[insert command you used to install]
+```
+
+In the last line, you need to use the very same command you used to install (local install, remote server, etc.)

docs/intro.md

@@ -20,23 +20,51 @@ hide_title: true
 [![Discord](https://img.shields.io/badge/Discord-Open_WebUI-blue?logo=discord&logoColor=white)](https://discord.gg/5rJgQTnV4s)
 [![](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub&color=%23fe8e86)](https://github.com/sponsors/tjbck)
 
-#### Installing with Docker 🐳
-
-- **Important:** 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.
+![Open WebUI Demo](/img/demo.gif)
+
+## Features ⭐
+
+- 🖥️ **Intuitive Interface**: Our chat interface takes inspiration from ChatGPT, ensuring a user-friendly experience.
+- 📱 **Responsive Design**: Enjoy a seamless experience on both desktop and mobile devices.
+- ⚡ **Swift Responsiveness**: Enjoy fast and responsive performance.
+- 🚀 **Effortless Setup**: Install seamlessly using Docker or Kubernetes (kubectl, kustomize or helm) for a hassle-free experience.
+- 💻 **Code Syntax Highlighting**: Enjoy enhanced code readability with our syntax highlighting feature.
+- ✒️🔢 **Full Markdown and LaTeX Support**: Elevate your LLM experience with comprehensive Markdown and LaTeX capabilities for enriched interaction.
+- 📚 **Local RAG Integration**: Dive into the future of chat interactions with the groundbreaking Retrieval Augmented Generation (RAG) support. This feature seamlessly integrates document interactions into your chat experience. You can load documents directly into the chat or add files to your document library, effortlessly accessing them using `#` command in the prompt. In its alpha phase, occasional issues may arise as we actively refine and enhance this feature to ensure optimal performance and reliability.
+- 🌐 **Web Browsing Capability**: Seamlessly integrate websites into your chat experience using the `#` command followed by the URL. This feature allows you to incorporate web content directly into your conversations, enhancing the richness and depth of your interactions.
+- 📜 **Prompt Preset Support**: Instantly access preset prompts using the `/` command in the chat input. Load predefined conversation starters effortlessly and expedite your interactions. Effortlessly import prompts through [Open WebUI Community](https://openwebui.com/) integration.
+- 👍👎 **RLHF Annotation**: Empower your messages by rating them with thumbs up and thumbs down, facilitating the creation of datasets for Reinforcement Learning from Human Feedback (RLHF). Utilize your messages to train or fine-tune models, all while ensuring the confidentiality of locally saved data.
+- 🏷️ **Conversation Tagging**: Effortlessly categorize and locate specific chats for quick reference and streamlined data collection.
+- 📥🗑️ **Download/Delete Models**: Easily download or remove models directly from the web UI.
+- ⬆️ **GGUF File Model Creation**: Effortlessly create Ollama models by uploading GGUF files directly from the web UI. Streamlined process with options to upload from your machine or download GGUF files from Hugging Face.
+- 🤖 **Multiple Model Support**: Seamlessly switch between different chat models for diverse interactions.
+- 🔄 **Multi-Modal Support**: Seamlessly engage with models that support multimodal interactions, including images (e.g., LLava).
+- 🧩 **Modelfile Builder**: Easily create Ollama modelfiles via the web UI. Create and add characters/agents, customize chat elements, and import modelfiles effortlessly through [Open WebUI Community](https://openwebui.com/) integration.
+- ⚙️ **Many Models Conversations**: Effortlessly engage with various models simultaneously, harnessing their unique strengths for optimal responses. Enhance your experience by leveraging a diverse set of models in parallel.
+- 💬 **Collaborative Chat**: Harness the collective intelligence of multiple models by seamlessly orchestrating group conversations. Use the `@` command to specify the model, enabling dynamic and diverse dialogues within your chat interface. Immerse yourself in the collective intelligence woven into your chat environment.
+- 🤝 **OpenAI API Integration**: Effortlessly integrate OpenAI-compatible API for versatile conversations alongside Ollama models. Customize the API Base URL to link with **LMStudio, Mistral, OpenRouter, and more**.
+- 🔄 **Regeneration History Access**: Easily revisit and explore your entire regeneration history.
+- 📜 **Chat History**: Effortlessly access and manage your conversation history.
+- 📤📥 **Import/Export Chat History**: Seamlessly move your chat data in and out of the platform.
+- 🗣️ **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.
+- ⚙️ **Fine-Tuned Control with Advanced Parameters**: Gain a deeper level of control by adjusting parameters such as temperature and defining your system prompts to tailor the conversation to your specific preferences and needs.
+- 🔗 **External Ollama Server Connection**: Seamlessly link to an external Ollama server hosted on a different address by configuring the environment variable.
+- 🔐 **Role-Based Access Control (RBAC)**: Ensure secure access with restricted permissions; only authorized individuals can access your Ollama, and exclusive model creation/pulling rights are reserved for administrators.
+- 🔒 **Backend Reverse Proxy Support**: Bolster security through direct communication between Open WebUI backend and Ollama. This key feature eliminates the need to expose Ollama over LAN. Requests made to the '/ollama/api' route from the web UI are seamlessly redirected to Ollama from the backend, enhancing overall system security.
+- 🌟 **Continuous Updates**: We are committed to improving Open WebUI with regular updates and new features.
+
+### 🔗 Also Check Out Open WebUI Community!
+
+Don't forget to explore our sibling project, [Open WebUI Community](https://openwebui.com/), where you can discover, download, and explore customized Modelfiles. Open WebUI Community offers a wide range of exciting possibilities for enhancing your chat interactions with Ollama! 🚀
+
+## Installing with Docker 🐳
 
 - **If Ollama is on your computer**, use this command:
 
   ```bash
   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
   ```
 
-- **To build the container yourself**, follow these steps:
-
-  ```bash
-  docker build -t open-webui .
-  docker run -d -p 3000:8080 --add-host=host.docker.internal:host-gateway -v open-webui:/app/backend/data --name open-webui --restart always open-webui
-  ```
-
 - After installation, you can access Open WebUI at [http://localhost:3000](http://localhost:3000).
 
 #### Using Ollama on a Different Server
@@ -47,11 +75,4 @@ hide_title: true
   docker run -d -p 3000:8080 -e OLLAMA_API_BASE_URL=https://example.com/api -v open-webui:/app/backend/data --name open-webui --restart always ghcr.io/open-webui/open-webui:main
   ```
 
-  Or for a self-built container:
-
-  ```bash
-  docker build -t open-webui .
-  docker run -d -p 3000:8080 -e OLLAMA_API_BASE_URL=https://example.com/api -v open-webui:/app/backend/data --name open-webui --restart always open-webui
-  ```
-
 Continue with the full [getting started guide](./getting-started.md).