README.md 5.7 KB
Newer Older
Timothy J. Baek's avatar
Timothy J. Baek committed
1
2
3
4
5
6
7
8
9
# 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.
10

Timothy J. Baek's avatar
Timothy J. Baek committed
11
- 📱 **Responsive Design**: Enjoy a seamless experience on both desktop and mobile devices.
12

Timothy J. Baek's avatar
Timothy J. Baek committed
13
-**Swift Responsiveness**: Enjoy fast and responsive performance.
14

Timothy J. Baek's avatar
Timothy J. Baek committed
15
- 🚀 **Effortless Setup**: Install seamlessly using Docker for a hassle-free experience.
16

Timothy J. Baek's avatar
Timothy J. Baek committed
17
- 🤖 **Multiple Model Support**: Seamlessly switch between different chat models for diverse interactions.
18

19
- 📜 **Chat History**: Effortlessly access and manage your conversation history.
20

Timothy J. Baek's avatar
Timothy J. Baek committed
21
- 📤📥 **Import/Export Chat History**: Seamlessly move your chat data in and out of the platform.
22

Timothy J. Baek's avatar
Timothy J. Baek committed
23
- ⚙️ **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.
24

25
- 💻 **Code Syntax Highlighting**: Enjoy enhanced code readability with our syntax highlighting feature.
26

27
- 🔗 **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 .`.
28

Timothy J. Baek's avatar
Timothy J. Baek committed
29
30
31
32
- 🌟 **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
33
34
35
36
### 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
37
#### Checking Ollama
Timothy J. Baek's avatar
Timothy J. Baek committed
38
39
40

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
41
#### Accessing Ollama Web Interface over LAN
Timothy J. Baek's avatar
Timothy J. Baek committed
42
43
44
45
46
47
48

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
49
50
51
52
53
54
If your running Ollama via Docker:

```bash
docker run -d -v ollama:/root/.ollama -p 11434:11434 -e OLLAMA_ORIGINS="*" --name ollama ollama/ollama
```

Timothy J. Baek's avatar
Timothy J. Baek committed
55
56
### Using Docker 🐳

57
If Ollama is hosted on your local machine, run the following command:
58

59
60
```bash
docker build --build-arg OLLAMA_API_BASE_URL='' -t ollama-webui .
61
docker run -d -p 3000:8080 --name ollama-webui --restart always ollama-webui
Timothy J. Baek's avatar
Timothy J. Baek committed
62
63
64
65
```

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
66
67
#### Connecting to Ollama on a Different Server

68
If Ollama is hosted on a server other than your local machine, change `OLLAMA_API_BASE_URL` to match:
Timothy J. Baek's avatar
Timothy J. Baek committed
69
70

```bash
71
docker build --build-arg OLLAMA_API_BASE_URL='https://example.com/api' -t ollama-webui .
72
docker run -d -p 3000:8080 --name ollama-webui --restart always ollama-webui
Timothy J. Baek's avatar
Timothy J. Baek committed
73
74
```

75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
## 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
   ```

Timothy J. Baek's avatar
Timothy J. Baek committed
118
119
120
121
122
123
## What's Next? 🚀

### To-Do List 📝

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

124
125
- 🌐 **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
126
127
128
129
130
131
132
133
134
135
136
137
- 🎨 **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
138
- [Ollama Team](https://github.com/jmorganca/ollama)
Timothy J. Baek's avatar
Timothy J. Baek committed
139
- [Timothy J. Baek](https://github.com/tjbck)
140
- [AJ ONeal](https://github.com/coolaj86)
Timothy J. Baek's avatar
Timothy J. Baek committed
141
142
143
144
145
146
147
148
149
150
151
152

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