forked from open-webui/open-webui
290 lines
14 KiB
Markdown
290 lines
14 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 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.
|
|
|
|
- 📥🗑️ **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 enter Ollama, and exclusive model creation/pulling rights are reserved for administrators.
|
|
|
|
- 🔒 **Backend Reverse Proxy Support**: Strengthen security by enabling direct communication between Ollama Web UI backend and Ollama, eliminating the need to expose Ollama over LAN.
|
|
|
|
- 🌟 **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 🚀
|
|
|
|
### Installing Both Ollama and Ollama Web UI Using Docker Compose
|
|
|
|
If you don't have Ollama installed yet, you can use the provided Docker Compose file for a hassle-free installation. Simply run the following command:
|
|
|
|
```bash
|
|
docker compose up -d --build
|
|
```
|
|
|
|
This command will install both Ollama and Ollama Web UI on your system.
|
|
|
|
#### Enable GPU
|
|
|
|
Use the additional Docker Compose file designed to enable GPU support by running the following command:
|
|
|
|
```bash
|
|
docker compose -f docker-compose.yml -f docker-compose.gpu.yml up -d --build
|
|
```
|
|
|
|
#### Expose Ollama API outside the container stack
|
|
|
|
Deploy the service with an additional Docker Compose file designed for API exposure:
|
|
|
|
```bash
|
|
docker compose -f docker-compose.yml -f docker-compose.api.yml up -d --build
|
|
```
|
|
|
|
### Installing Ollama Web UI Only
|
|
|
|
#### Prerequisites
|
|
|
|
Make sure you have the latest version of Ollama installed before proceeding with the installation. You can find the latest version of Ollama at [https://ollama.ai/](https://ollama.ai/).
|
|
|
|
##### Checking Ollama
|
|
|
|
After installing Ollama, verify that Ollama is running by accessing the following link in your web browser: [http://127.0.0.1:11434/](http://127.0.0.1:11434/). Note that the port number may differ based on your system configuration.
|
|
|
|
#### Using Docker 🐳
|
|
|
|
If Ollama is hosted on your local machine and accessible at [http://127.0.0.1:11434/](http://127.0.0.1:11434/), run the following command:
|
|
|
|
```bash
|
|
docker run -d -p 3000:8080 --add-host=host.docker.internal:host-gateway -v ollama-webui:/app/backend --name ollama-webui --restart always ghcr.io/ollama-webui/ollama-webui:main
|
|
```
|
|
|
|
Alternatively, if you prefer to build the container yourself, use the following command:
|
|
|
|
```bash
|
|
docker build -t ollama-webui .
|
|
docker run -d -p 3000:8080 --add-host=host.docker.internal:host-gateway -v ollama-webui:/app/backend --name ollama-webui --restart always ollama-webui
|
|
```
|
|
|
|
Your Ollama Web UI should now be hosted at [http://localhost:3000](http://localhost:3000) and accessible over LAN (or Network). Enjoy! 😄
|
|
|
|
#### Accessing External Ollama on a Different Server
|
|
|
|
Change `OLLAMA_API_BASE_URL` environment variable to match the external Ollama Server url:
|
|
|
|
```bash
|
|
docker run -d -p 3000:8080 -e OLLAMA_API_BASE_URL=https://example.com/api -v ollama-webui:/app/backend --name ollama-webui --restart always ghcr.io/ollama-webui/ollama-webui:main
|
|
```
|
|
|
|
Alternatively, if you prefer to build the container yourself, use the following command:
|
|
|
|
```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 --name ollama-webui --restart always ollama-webui
|
|
```
|
|
|
|
## 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.
|
|
|
|
**Warning: Backend Dependency for Proper Functionality**
|
|
|
|
In order to ensure the seamless operation of our application, it is crucial to run both the backend and frontend components simultaneously. Serving only the frontend in isolation is not supported and may lead to unpredictable outcomes, rendering the application inoperable. Attempting to raise an issue when solely serving the frontend will not be addressed, as it falls outside the intended usage. To achieve optimal results, please strictly adhere to the specified steps outlined in this documentation. Utilize the frontend solely for building static files, and subsequently run the complete application with the provided backend commands. Failure to follow these instructions may result in unsupported configurations, and we may not be able to provide assistance in such cases. Your cooperation in following the prescribed procedures is essential for a smooth user experience and effective issue resolution.
|
|
|
|
### TL;DR 🚀
|
|
|
|
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
|
|
npm i
|
|
npm run build
|
|
|
|
# Serving Frontend with the Backend
|
|
cd ./backend
|
|
pip install -r requirements.txt
|
|
sh start.sh
|
|
```
|
|
|
|
You should have the Ollama Web UI up and running at http://localhost:8080/. Enjoy! 😄
|
|
|
|
### 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 using `npm run dev`. Alternatively, you can set the `PUBLIC_API_BASE_URL` during the build process to have the frontend connect directly to your Ollama instance or build the frontend as static files and serve them with the backend.
|
|
|
|
### Prerequisites
|
|
|
|
1. **Clone and Enter the Project:**
|
|
|
|
```sh
|
|
git clone https://github.com/ollama-webui/ollama-webui.git
|
|
cd ollama-webui/
|
|
```
|
|
|
|
2. **Create and Edit `.env`:**
|
|
|
|
```sh
|
|
cp -RPp example.env .env
|
|
```
|
|
|
|
### Building Ollama Web UI Frontend
|
|
|
|
1. **Install Node Dependencies:**
|
|
|
|
```sh
|
|
npm install
|
|
```
|
|
|
|
2. **Run in Dev Mode or Build for Deployment:**
|
|
|
|
- Dev Mode (requires the backend to be running simultaneously):
|
|
|
|
```sh
|
|
npm run dev
|
|
```
|
|
|
|
- Build for Deployment:
|
|
|
|
```sh
|
|
# `PUBLIC_API_BASE_URL` overwrites the value in `.env`
|
|
PUBLIC_API_BASE_URL='https://example.com/api' npm run build
|
|
```
|
|
|
|
3. **Test the Build with `Caddy` (or your preferred server):**
|
|
|
|
```sh
|
|
curl https://webi.sh/caddy | sh
|
|
|
|
PUBLIC_API_BASE_URL='https://localhost/api' npm run build
|
|
caddy run --envfile .env --config ./Caddyfile.localhost
|
|
```
|
|
|
|
### Running Ollama Web UI Backend
|
|
|
|
If you wish to run the backend for deployment, ensure that the frontend is built so that the backend can serve the frontend files along with the API route.
|
|
|
|
#### Setup Instructions
|
|
|
|
1. **Install Python Requirements:**
|
|
|
|
```sh
|
|
cd ./backend
|
|
pip install -r requirements.txt
|
|
```
|
|
|
|
2. **Run Python Backend:**
|
|
|
|
- Dev Mode with Hot Reloading:
|
|
|
|
```sh
|
|
sh dev.sh
|
|
```
|
|
|
|
- Deployment:
|
|
|
|
```sh
|
|
sh start.sh
|
|
```
|
|
|
|
Now, you should have the Ollama Web UI up and running at [http://localhost:8080/](http://localhost:8080/). Feel free to explore the features and functionalities of Ollama! If you encounter any issues, please refer to the instructions above or reach out to the community for assistance.
|
|
|
|
## 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:
|
|
|
|
- 📚 **RAG Integration**: Experience first-class retrieval augmented generation support, enabling chat with your documents.
|
|
- 🧪 **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 🤍
|
|
|
|
- [Prof. Lawrence Kim @ SFU](https://www.lhkim.com/)
|
|
|
|
## 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! 💪
|