"...lm-evaluation-harness.git" did not exist on "e495e3a099dec85cf046511309c6dc49e8752d18"
README.md 4.37 KB
Newer Older
Timothy J. Baek's avatar
Timothy J. Baek committed
1
2
3
4
5
6
7
8
9
10
11
12
13
# 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.
- 📱 **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.
- 🤖 **Multiple Model Support**: Seamlessly switch between different chat models for diverse interactions.
14
- 📜 **Chat History**: Effortlessly access and manage your conversation history.
Timothy J. Baek's avatar
Timothy J. Baek committed
15
- 📤📥 **Import/Export Chat History**: Seamlessly move your chat data in and out of the platform.
Timothy J. Baek's avatar
Timothy J. Baek committed
16
- ⚙️ **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.
17
- 💻 **Code Syntax Highlighting**: Enjoy enhanced code readability with our syntax highlighting feature.
Timothy J. Baek's avatar
Timothy J. Baek committed
18
- 🔗 **External Ollama Server Connection**: Link to the model when Ollama is hosted on a different server via the environment variable -e OLLAMA_ENDPOINT="http://[insert your Ollama address]".
Timothy J. Baek's avatar
Timothy J. Baek committed
19
20
21
22
- 🌟 **Continuous Updates**: We are committed to improving Ollama Web UI with regular updates and new features.

## How to Install 🚀

Timothy J. Baek's avatar
Timothy J. Baek committed
23
24
25
26
### 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/).

Timothy J. Baek's avatar
Timothy J. Baek committed
27
#### Checking Ollama
Timothy J. Baek's avatar
Timothy J. Baek committed
28
29
30

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.

Timothy J. Baek's avatar
Timothy J. Baek committed
31
#### Accessing Ollama Web Interface over LAN
Timothy J. Baek's avatar
Timothy J. Baek committed
32
33
34
35
36
37
38

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
```

Timothy J. Baek's avatar
Timothy J. Baek committed
39
40
41
42
### Using Docker 🐳

```bash
docker build -t ollama-webui .
Timothy J. Baek's avatar
Timothy J. Baek committed
43
docker run -d -p 3000:3000 --add-host=host.docker.internal:host-gateway --name ollama-webui --restart always ollama-webui
Timothy J. Baek's avatar
Timothy J. Baek committed
44
45
46
47
```

Your Ollama Web UI should now be hosted at [http://localhost:3000](http://localhost:3000). Enjoy! 😄

Timothy J. Baek's avatar
Timothy J. Baek committed
48
49
50
51
52
53
54
55
56
#### Connecting to Ollama on a Different Server

If Ollama is hosted on a server other than your local machine, you can connect to it using the following environment variable:

```bash
docker build -t ollama-webui .
docker run -d -p 3000:3000 --add-host=host.docker.internal:host-gateway -e OLLAMA_ENDPOINT="http://[insert your ollama url]" --name ollama-webui --restart always ollama-webui
```

Timothy J. Baek's avatar
Timothy J. Baek committed
57
58
59
60
61
62
## What's Next? 🚀

### To-Do List 📝

Here are some exciting tasks on our to-do list:

63
64
- 🌐 **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.
Timothy J. Baek's avatar
Timothy J. Baek committed
65
66
67
68
69
70
71
72
73
74
75
76
- 🎨 **Customization**: Tailor your chat environment with personalized themes and styles.
- 📥🗑️ **Download/Delete Models**: Easily acquire or remove models directly from the web UI.
- 📚 **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! 🙏

Timothy Jaeryang Baek's avatar
Timothy Jaeryang Baek committed
77
- [Ollama Team](https://github.com/jmorganca/ollama)
Timothy J. Baek's avatar
Timothy J. Baek committed
78
79
80
81
82
83
84
85
86
87
88
89
90
- [Timothy J. Baek](https://github.com/tjbck)

## 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! 💪