mirror of
https://github.com/open-webui/open-webui
synced 2024-11-16 13:40:55 +00:00
303 lines
16 KiB
Markdown
303 lines
16 KiB
Markdown
# Ollama Web UI: A User-Friendly Web Interface for Chat Interactions 👋
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
[](https://discord.gg/5rJgQTnV4s)
|
|
[](https://github.com/sponsors/tjbck)
|
|
|
|
ChatGPT-Style Web Interface for Ollama 🦙
|
|
|
|
**Disclaimer:** _ollama-webui is a community-driven project and is not affiliated with the Ollama team in any way. This initiative is independent, and any inquiries or feedback should be directed to [our community on Discord](https://discord.gg/5rJgQTnV4s). We kindly request users to refrain from contacting or harassing the Ollama team regarding this project._
|
|
|
|
|
|
|
|
Also check our sibling project, [OllamaHub](https://ollamahub.com/), where you can discover, download, and explore customized Modelfiles for Ollama! 🦙🔍
|
|
|
|
## 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.
|
|
|
|
- 📜 **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 [OllamaHub](https://ollamahub.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.
|
|
|
|
- 📥🗑️ **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 [OllamaHub](https://ollamahub.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.
|
|
|
|
- 🤝 **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 Ollama Web UI 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 Ollama Web UI with regular updates and new features.
|
|
|
|
## 🔗 Also Check Out OllamaHub!
|
|
|
|
Don't forget to explore our sibling project, [OllamaHub](https://ollamahub.com/), where you can discover, download, and explore customized Modelfiles. OllamaHub offers a wide range of exciting possibilities for enhancing your chat interactions with Ollama! 🚀
|
|
|
|
## How to Install 🚀
|
|
|
|
🌟 **Important Note on User Roles and Privacy:**
|
|
|
|
- **Admin Creation:** The very first account to sign up on the Ollama Web UI 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 the Ollama Web UI 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 Ollama Web UI
|
|
|
|
#### 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.
|
|
- 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.ai/](https://ollama.ai/).
|
|
|
|
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 Ollama Web UI, make sure to include the `-v ollama-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 ollama-webui:/app/backend/data --name ollama-webui --restart always \
|
|
ghcr.io/ollama-webui/ollama-webui:main
|
|
```
|
|
|
|
- **To build the container yourself**, follow these steps:
|
|
|
|
```bash
|
|
docker build -t ollama-webui .
|
|
docker run -d -p 3000:8080 --add-host=host.docker.internal:host-gateway \
|
|
-v ollama-webui:/app/backend/data --name ollama-webui --restart always \
|
|
ollama-webui
|
|
```
|
|
|
|
- After installation, you can access Ollama Web UI 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 ollama-webui:/app/backend/data --name ollama-webui --restart always \
|
|
ghcr.io/ollama-webui/ollama-webui:main
|
|
```
|
|
|
|
Or for a self-built container:
|
|
|
|
```bash
|
|
docker build -t ollama-webui .
|
|
docker run -d -p 3000:8080 -e OLLAMA_API_BASE_URL=https://example.com/api \
|
|
-v ollama-webui:/app/backend/data --name ollama-webui --restart always \
|
|
ollama-webui
|
|
```
|
|
|
|
### Installing Ollama and Ollama Web UI 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 [Ollama Web UI Discord community](https://discord.gg/5rJgQTnV4s) for more help and information.
|
|
|
|
## How to Install Without Docker
|
|
|
|
While we strongly recommend using our convenient Docker container installation for optimal support, we understand that some situations may require a non-Docker setup, especially for development purposes. Please note that non-Docker installations are not officially supported, and you might need to troubleshoot on your own.
|
|
|
|
### Project Components
|
|
|
|
The Ollama Web UI consists of two primary components: the frontend and the backend (which serves as a reverse proxy, handling static frontend files, and additional features). Both need to be running concurrently for the development environment.
|
|
|
|
> [!IMPORTANT]
|
|
> The backend is required for proper functionality
|
|
|
|
### Requirements 📦
|
|
|
|
- 🐰 [Bun](https://bun.sh) >= 1.0.21 or 🐢 [Node.js](https://nodejs.org/en) >= 20.10
|
|
- 🐍 [Python](https://python.org) >= 3.11
|
|
|
|
### Build and Install 🛠️
|
|
|
|
Run the following commands to install:
|
|
|
|
```sh
|
|
git clone https://github.com/ollama-webui/ollama-webui.git
|
|
cd ollama-webui/
|
|
|
|
# Copying required .env file
|
|
cp -RPp example.env .env
|
|
|
|
# Building Frontend Using Node
|
|
npm i
|
|
npm run build
|
|
|
|
# or Building Frontend Using Bun
|
|
# bun install
|
|
# bun run build
|
|
|
|
# Serving Frontend with the Backend
|
|
cd ./backend
|
|
pip install -r requirements.txt -U
|
|
sh start.sh
|
|
```
|
|
|
|
You should have the Ollama Web UI up and running at http://localhost:8080/. Enjoy! 😄
|
|
|
|
## Troubleshooting
|
|
|
|
See [TROUBLESHOOTING.md](/TROUBLESHOOTING.md) for information on how to troubleshoot and/or join our [Ollama Web UI Discord community](https://discord.gg/5rJgQTnV4s).
|
|
|
|
## What's Next? 🚀
|
|
|
|
### Roadmap 📝
|
|
|
|
Here are some exciting tasks on our roadmap:
|
|
|
|
- 💬 **Group Conversations**: Witness the dynamic synergy of multiple Language Models engaging in collaborative discussions. In this unique feature, you can orchestrate interactions between various models, opening up avenues for diverse and intriguing dialogues. Experience the power of collective intelligence within your chat environment.
|
|
- 🌐 **Web Browsing Capability**: Experience the convenience of seamlessly integrating web content directly into your chat. Easily browse and share information without leaving the conversation.
|
|
- 🔄 **Function Calling**: Empower your interactions by running code directly within the chat. Execute functions and commands effortlessly, enhancing the functionality of your conversations.
|
|
- ⚙️ **Custom Python Backend Actions**: Empower your Ollama Web UI by creating or downloading custom Python backend actions. Unleash the full potential of your web interface with tailored actions that suit your specific needs, enhancing functionality and versatility.
|
|
- 🧠 **Long-Term Memory**: Witness the power of persistent memory in our agents. Enjoy conversations that feel continuous as agents remember and reference past interactions, creating a more cohesive and personalized user experience.
|
|
- 🧪 **Research-Centric Features**: Empower researchers in the fields of LLM and HCI with a comprehensive web UI for conducting user studies. Stay tuned for ongoing feature enhancements (e.g., surveys, analytics, and participant tracking) to facilitate their research.
|
|
- 📈 **User Study Tools**: Providing specialized tools, like heat maps and behavior tracking modules, to empower researchers in capturing and analyzing user behavior patterns with precision and accuracy.
|
|
- 📚 **Enhanced Documentation**: Elevate your setup and customization experience with improved, comprehensive documentation.
|
|
|
|
Feel free to contribute and help us make Ollama Web UI even better! 🙌
|
|
|
|
## Supporters ✨
|
|
|
|
A big shoutout to our amazing supporters who's helping to make this project possible! 🙏
|
|
|
|
### Platinum Sponsors 🤍
|
|
|
|
- We're looking for Sponsors!
|
|
|
|
### Acknowledgments
|
|
|
|
Special thanks to [Prof. Lawrence Kim @ SFU](https://www.lhkim.com/) and [Prof. Nick Vincent @ SFU](https://www.nickmvincent.com/) for their invaluable support and guidance in shaping this project into a research endeavor. Grateful for your mentorship throughout the journey! 🙌
|
|
|
|
## License 📜
|
|
|
|
This project is licensed under the [MIT License](LICENSE) - see the [LICENSE](LICENSE) file for details. 📄
|
|
|
|
## Support 💬
|
|
|
|
If you have any questions, suggestions, or need assistance, please open an issue or join our
|
|
[Ollama Web UI Discord community](https://discord.gg/5rJgQTnV4s) or
|
|
[Ollama Discord community](https://discord.gg/ollama) to connect with us! 🤝
|
|
|
|
---
|
|
|
|
Created by [Timothy J. Baek](https://github.com/tjbck) - Let's make Ollama Web UI even more amazing together! 💪
|