# Chatbot UI

Chatbot UI is an open-source chatbot kit for OpenAI's chat models that mimics ChatGPT's interface and functionality; add your OpenAI API key and start chatting with GPT-3.5 or GPT-4. It is open source and self-hosted, installable on ZimaOS and Umbrel.

Canonical page: https://ourlocalhost.com/app/3644/chatbot-ui

## Description

Chatbot UI is an open-source chatbot kit for OpenAI's chat models that mimics ChatGPT's interface and functionality; add your OpenAI API key and start chatting with GPT-3.5 or GPT-4. Conversations are stored locally in your browser, with export and import to safeguard against data loss. The packaged version has since been removed from the Umbrel App Store because it is no longer maintained and is not compatible with the current upstream app architecture, but existing installs continue to work.

## Platform availability

Available on 2 of 10 platforms: Umbrel, ZimaOS.

## Health score

41/100 (Fair), based on 4 of 5 factors.
- Maintained: 0 (last commit 882 days ago)
- Popular: 90 (33,307 GitHub stars)
- Easy to install: 45 (2 install platforms, install notes, Docker image)
- Security check: 60 (no serious findings, 26 minor, tests)

## Links

- GitHub: https://github.com/mckaywrigley/chatbot-ui
- Official website: https://chatbotui.com
- ZimaOS: https://github.com/IceWhaleTech/CasaOS-AppStore/tree/main/Apps/ChatbotUI
- Umbrel: https://apps.umbrel.com/app/chatbot-ui

## Common questions

### How do I update a deployed Chatbot UI instance and apply database changes?

Run npm run update in the local repository. If you run a hosted instance, also run npm run db-push to apply the latest migrations to the live database.

### Do I need Docker and Supabase for the local quickstart?

Yes, the local quickstart says to install Docker and the Supabase CLI. Then run supabase start in the repository root.

### Where is the Chatbot UI 1.0 code after the 2.0 update?

The 1.0 code is on the legacy branch.

### Where should self-hosters ask setup questions?

Use the Discussions tab for setup questions. Issues are restricted to codebase problems, and setup help is directed to Discussions.

### What Azure .env API variable problem is reported in the self-hosting discussion?

The discussion reports problems with Azure and .env API variables in Chatbot UI. It says onboarding fields should close when variables are set, but there are issues with selected models and talking to Azure models using environment API keys.

---
Source: Our Local Host (https://ourlocalhost.com/app/3644/chatbot-ui), the self-hosted and open-source app directory.
