Chatbot UI

Chatbot UI is an open source chat UI for AI models.

See a demo.

Updates

Chatbot UI will be updated over time.

Expect frequent improvements.

Next up:

• Sharing
• "Bots"

Deploy

Vercel

Host your own live version of Chatbot UI with Vercel.

Docker Compose

Production (http://localhost:3000):

docker-compose -f docker-compose.yml --env-file .env.local up -d

Development (http://localhost:3001 & http://localhost:5984/_utils):

docker-compose -f docker-compose.dev.yml --env-file .env.local up --build

Docker

Build locally:

docker build -t chatgpt-ui .
docker run -e OPENAI_API_KEY=xxxxxxxx -p 3000:3000 chatgpt-ui

Pull from ghcr:

docker run -e OPENAI_API_KEY=xxxxxxxx -p 3000:3000 ghcr.io/itbm/chatbot-ui:latest

Running Locally

1. Clone Repo

git clone https://github.com/itbm/chatbot-ui.git

2. Install Dependencies

npm i

3. Provide OpenAI API Key

Create a .env.local file in the root of the repo with your OpenAI API Key:

OPENAI_API_KEY=YOUR_KEY

You can set OPENAI_API_HOST where access to the official OpenAI host is restricted or unavailable, allowing users to configure an alternative host for their specific needs.

Additionally, if you have multiple OpenAI Organizations, you can set OPENAI_ORGANIZATION to specify one.

4. Run App

npm run dev

5. Use It

You should be able to start chatting.

Configuration

When deploying the application, the following environment variables can be set:

Environment Variable	Default value	Description
OPENAI_API_KEY		The default API key used for authentication with OpenAI
OPENAI_API_HOST	https://api.openai.com	The base url, for Azure use https://<endpoint>.openai.azure.com
OPENAI_API_TYPE	openai	The API type, options are openai or azure
OPENAI_API_VERSION	2023-03-15-preview	Only applicable for Azure OpenAI
OPENAI_ORGANIZATION		Your OpenAI organization ID
DEFAULT_MODEL	gpt-3.5-turbo (OpenAI) gpt-35-turbo (Azure)	The default model to use on new conversations
NEXT_PUBLIC_DEFAULT_SYSTEM_PROMPT	see here	The default system prompt to use on new conversations
NEXT_PUBLIC_DEFAULT_TEMPERATURE	1	The default temperature to use on new conversations
GOOGLE_API_KEY		See Custom Search JSON API documentation
GOOGLE_CSE_ID		See Custom Search JSON API documentation
DATABASE_TYPE	localStorage	Options are localStorage and couchdb
COUCHDB_HOST	http://couchdb	The hostname of the CouchDB instance
COUCHDB_PORT	5984	The port of the CouchDB instance
COUCHDB_USERNAME	admin	The username of the CouchDB instance
COUCHDB_PASSWORD	password	The password of the CouchDB instance
COUCHDB_DATABASE	chatbot	The database name of the CouchDB instance

If you do not provide an OpenAI API key with OPENAI_API_KEY, users will have to provide their own key.

If you don't have an OpenAI API key, you can get one here.