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…

  • AI
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

  • Unraid (not listed)
  • TrueNAS (not listed)
  • Umbrel
  • ZimaOS
  • Proxmox (not listed)
  • Helm (not listed)
  • Mac (not listed)
  • Windows (not listed)
  • Linux (not listed)
  • Any server (not listed)

Health score?A 0-100 score computed nightly from four factors: maintained (40%: recent commits and steady activity), popular (25%: GitHub stars, log scale), easy to install (20%: platforms, install notes, setup guides, Docker image) and light to run (15%: minimum RAM, ARM support). When the source code has been checked, a fifth factor, security check (20%: automated scan for committed secrets, unsafe desktop-app settings, known-vulnerable dependencies and project hygiene; any serious finding caps it at 20), is added. Factors without data are left out and the rest are rescaled.

41/100 Fair

Maintained
0last commit 882 days ago
Popular
9033,307 GitHub stars
Easy to install
452 install platforms, install notes, Docker image
Light to run
No data
Security check
60no serious findings, 26 minor, tests

Based on 4 of 5 factors.

Availability: platform listings confirmed today, links checked yesterday

GitHub stars
33,307
Open issues
246
Last commit
2024-06-22
License
MIT
Activity
stale

Checked 5 days ago - source: GitHub (mckaywrigley/chatbot-ui)

Resources & Compatibility

Requirements not published yet.

Checked 54 days ago - source: Docker Hub image tags and published docs

First-install notes

  • Add the ChatBot UI package to your project Run `npm install @patternfly/chatbot --save` in your project folder. npm is the tool that downloads code packages; this adds the ChatBot UI code your app needs, so imports don't fail. source
  • Install extra packages if you use analytics If your analytics setup uses Segment or PostHog, also add the matching npm packages listed in the docs. Without these libraries, the analytics code cannot run even if your keys are correct. source
  • Fill in analytics keys before using them If you enable analytics, replace the placeholder API keys (the access codes for analytics services) and host values for Segment, Umami, or PostHog. Leaving placeholder keys in place can make the browser log errors or send data nowhere. source
  • OpenAI API key An OpenAI API key is required: add it when you set up the app, then you can chat with GPT-3.5 and GPT-4 models. Conversations are stored locally in your browser and can be exported or imported. source

Fetched 39 days ago - each note links to its source

Alternatives

No alternatives collected yet.

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.

Answers sourced from github.com, github.com

Community

Collected 49 days ago - public community threads