open-webui/README.md

154 lines
5.7 KiB
Markdown
Raw Normal View History

2023-10-09 00:38:42 +02:00
# Ollama Web UI 👋
ChatGPT-Style Web Interface for Ollama 🦙
![Ollama Web UI Demo](./demo.gif)
## Features ⭐
- 🖥️ **Intuitive Interface**: Our chat interface takes inspiration from ChatGPT, ensuring a user-friendly experience.
2023-10-09 00:38:42 +02:00
- 📱 **Responsive Design**: Enjoy a seamless experience on both desktop and mobile devices.
2023-10-09 00:38:42 +02:00
-**Swift Responsiveness**: Enjoy fast and responsive performance.
2023-10-09 00:38:42 +02:00
- 🚀 **Effortless Setup**: Install seamlessly using Docker for a hassle-free experience.
2023-10-23 01:40:17 +02:00
- 📥🗑️ **Download/Delete Models**: Easily download or remove models directly from the web UI.
2023-10-09 00:38:42 +02:00
- 🤖 **Multiple Model Support**: Seamlessly switch between different chat models for diverse interactions.
- 📜 **Chat History**: Effortlessly access and manage your conversation history.
2023-10-19 08:00:26 +02:00
- 📤📥 **Import/Export Chat History**: Seamlessly move your chat data in and out of the platform.
2023-10-20 20:43:46 +02:00
- ⚙️ **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.
- 💻 **Code Syntax Highlighting**: Enjoy enhanced code readability with our syntax highlighting feature.
2023-10-22 21:41:20 +02:00
- 🔗 **External Ollama Server Connection**: You can seamlessly connect to an external Ollama server hosted on a different address by setting the environment variable during the Docker build process. Execute the following command to include the Ollama API base URL in the Docker image: `docker build --build-arg OLLAMA_API_BASE_URL='http://localhost:11434/api' -t ollama-webui .`.
2023-10-09 00:38:42 +02:00
- 🌟 **Continuous Updates**: We are committed to improving Ollama Web UI with regular updates and new features.
## How to Install 🚀
2023-10-16 10:38:06 +02:00
### 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/).
2023-10-18 03:21:39 +02:00
#### Checking Ollama
2023-10-18 03:08:54 +02:00
After installing, 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.
2023-10-18 03:21:39 +02:00
#### Accessing Ollama Web Interface over LAN
2023-10-18 03:08:54 +02:00
If you want to access the Ollama web interface over LAN, for example, from your phone, run Ollama using the following command:
```bash
OLLAMA_HOST=0.0.0.0 OLLAMA_ORIGINS=* ollama serve
```
2023-10-22 22:17:05 +02:00
If you're running Ollama via Docker:
2023-10-22 22:16:09 +02:00
```bash
docker run -d -v ollama:/root/.ollama -p 11434:11434 -e OLLAMA_ORIGINS="*" --name ollama ollama/ollama
```
2023-10-09 00:38:42 +02:00
### Using Docker 🐳
If Ollama is hosted on your local machine, run the following command:
```bash
docker build --build-arg OLLAMA_API_BASE_URL='' -t ollama-webui .
docker run -d -p 3000:8080 --name ollama-webui --restart always ollama-webui
2023-10-09 00:38:42 +02:00
```
Your Ollama Web UI should now be hosted at [http://localhost:3000](http://localhost:3000). Enjoy! 😄
2023-10-18 12:01:34 +02:00
#### Connecting to Ollama on a Different Server
If Ollama is hosted on a server other than your local machine, change `OLLAMA_API_BASE_URL` to match:
2023-10-18 12:01:34 +02:00
```bash
docker build --build-arg OLLAMA_API_BASE_URL='https://example.com/api' -t ollama-webui .
docker run -d -p 3000:8080 --name ollama-webui --restart always ollama-webui
2023-10-18 12:01:34 +02:00
```
2023-10-22 08:49:25 +02:00
## How to Build for Static Deployment
1. Install `node`
```sh
# Mac, Linux
curl https://webi.sh/node@lts | sh
source ~/.config/envman/PATH.env
```
```pwsh
# Windows
curl.exe https://webi.ms/node@lts | powershell
```
2. Clone & Enter the project
```sh
git clone https://github.com/ollama-webui/ollama-webui.git
pushd ./ollama-webui/
```
3. Create and edit `.env`
```sh
cp -RPp example.env .env
```
4. Run in dev mode, or build the site for deployment
- Test in Dev mode:
```sh
npm run dev
```
- Build for Deploy: \
(`PUBLIC_API_BASE_URL` will overwrite the value in `.env`)
```sh
PUBLIC_API_BASE_URL='https://example.com/api' npm run build
```
5. Test the build with `caddy` (or the server of your choice)
```sh
curl https://webi.sh/caddy | sh
PUBLIC_API_BASE_URL='https://localhost/api' npm run build
caddy run --envfile .env --config ./Caddyfile.localhost
```
2023-10-09 00:38:42 +02:00
## What's Next? 🚀
### To-Do List 📝
Here are some exciting tasks on our to-do list:
- 🌐 **Web Browser Extension**: Seamlessly integrate our services into your browsing experience with our convenient browser extension.
- 🚀 **Integration with Messaging Platforms**: Explore possibilities for integrating with popular messaging platforms like Slack and Discord.
2023-10-09 00:38:42 +02:00
- 🎨 **Customization**: Tailor your chat environment with personalized themes and styles.
- 📚 **Enhanced Documentation**: Elevate your setup and customization experience with improved, comprehensive documentation.
- 🌟 **User Interface Enhancement**: Elevate the user interface to deliver a smoother, more enjoyable interaction.
- 🧐 **User Testing and Feedback Gathering**: Conduct thorough user testing to gather insights and refine our offerings based on valuable user feedback.
Feel free to contribute and help us make Ollama Web UI even better! 🙌
## Contributors ✨
A big shoutout to our amazing contributors who have helped make this project possible! 🙏
2023-10-09 07:52:49 +02:00
- [Ollama Team](https://github.com/jmorganca/ollama)
2023-10-09 00:38:42 +02:00
- [Timothy J. Baek](https://github.com/tjbck)
2023-10-22 21:41:20 +02:00
- [AJ ONeal](https://github.com/coolaj86)
2023-10-09 00:38:42 +02:00
## 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 [Discord community](https://discord.gg/ollama) to connect with us! 🤝
---
Let's make Ollama Web UI even more amazing together! 💪