Try Adsterra Earnings, itโs 100% Authentic to make money more and more.
The open-source AI chat app for everyone.
View the latest demo here.
Hey everyone! I’ve heard your feedback and am working hard on a big update.
Things like simpler deployment, better backend compatibility, and improved mobile layouts are on their way.
Be back soon.
— Mckay
Use Chatbot UI without having to host it yourself!
Find the official hosted version of Chatbot UI here.
If you find Chatbot UI useful, please consider sponsoring me to support my open-source work ๐
We restrict “Issues” to actual issues related to the codebase.
We’re getting excessive amounts of issues that amount to things like feature requests, cloud provider issues, etc.
If you are having issues with things like setup, please refer to the “Help” section in the “Discussions” tab above.
Issues unrelated to the codebase will likely be closed immediately.
We highly encourage you to participate in the “Discussions” tab above!
Discussions are a great place to ask questions, share ideas, and get help.
Odds are if you have a question, someone else has the same question.
Chatbot UI was recently updated to its 2.0 version.
The code for 1.0 can be found on the legacy branch.
In your terminal at the root of your local Chatbot UI repository, run:
If you run a hosted instance you’ll also need to run:
to apply the latest migrations to your live database.
Follow these steps to get your own Chatbot UI instance running locally.
You can watch the full video tutorial here.
git clone https://github.com/mckaywrigley/chatbot-ui.git
Open a terminal in the root directory of your local Chatbot UI repository and run:
3. Install Supabase & Run Locally
Previously, we used local browser storage to store data. However, this was not a good solution for a few reasons:
- Security issues
- Limited storage
- Limits multi-modal use cases
We now use Supabase because it’s easy to use, it’s open-source, it’s Postgres, and it has a free tier for hosted instances.
We will support other providers in the future to give you more options.
You will need to install Docker to run Supabase locally. You can download it here for free.
MacOS/Linux
brew install supabase/tap/supabase
Windows
scoop bucket add supabase https://github.com/supabase/scoop-bucket.git scoop install supabase
In your terminal at the root of your local Chatbot UI repository, run:
In your terminal at the root of your local Chatbot UI repository, run:
cp .env.local.example .env.local
Get the required values by running:
Note: Use API URL from supabase status for NEXT_PUBLIC_SUPABASE_URL
Now go to your .env.local file and fill in the values.
If the environment variable is set, it will disable the input in the user settings.
In the 1st migration file supabase/migrations/20240108234540_setup.sql you will need to replace 2 values with the values you got above:
- project_url (line 53): http://supabase_kong_chatbotui:8000 (default) can remain unchanged if you don’t change your project_id in the config.toml file
- service_role_key (line 54): You got this value from running supabase status
This prevents issues with storage files not being deleted properly.
5. Install Ollama (optional for local models)
Follow the instructions here.
In your terminal at the root of your local Chatbot UI repository, run:
Your local instance of Chatbot UI should now be running at http://localhost:3000. Be sure to use a compatible node version (i.e. v18).
You can view your backend GUI at http://localhost:54323/project/default/editor.
Follow these steps to get your own Chatbot UI instance running in the cloud.
Video tutorial coming soon.
1. Follow Local Quickstart
Repeat steps 1-4 in “Local Quickstart” above.
You will want separate repositories for your local and hosted instances.
Create a new repository for your hosted instance of Chatbot UI on GitHub and push your code to it.
2. Setup Backend with Supabase
Go to Supabase and create a new project.
Once you are in the project dashboard, click on the “Project Settings” icon tab on the far bottom left.
Here you will get the values for the following environment variables:
While still in “Settings” click on the “API” text tab on the left.
Here you will get the values for the following environment variables:
-
Project URL: Found in “API Settings” as “Project URL”
-
Anon key: Found in “Project API keys” as “anon public”
-
Service role key: Found in “Project API keys” as “service_role” (Reminder: Treat this like a password!)
Next, click on the “Authentication” icon tab on the far left.
In the text tabs, click on “Providers” and make sure “Email” is enabled.
We recommend turning off “Confirm email” for your own personal instance.
Open up your repository for your hosted instance of Chatbot UI.
In the 1st migration file supabase/migrations/20240108234540_setup.sql you will need to replace 2 values with the values you got above:
- project_url (line 53): Use the Project URL value from above
- service_role_key (line 54): Use the Service role key value from above
Now, open a terminal in the root directory of your local Chatbot UI repository. We will execute a few commands here.
Login to Supabase by running:
Next, link your project by running the following command with the “Project ID” you got above:
supabase link –project-ref
Your project should now be linked.
Finally, push your database to Supabase by running:
Your hosted database should now be set up!
3. Setup Frontend with Vercel
Go to Vercel and create a new project.
In the setup page, import your GitHub repository for your hosted instance of Chatbot UI. Within the project Settings, in the “Build & Development Settings” section, switch Framework Preset to “Next.js”.
In environment variables, add the following from the values you got above:
- NEXT_PUBLIC_SUPABASE_URL
- NEXT_PUBLIC_SUPABASE_ANON_KEY
- SUPABASE_SERVICE_ROLE_KEY
- NEXT_PUBLIC_OLLAMA_URL (only needed when using local Ollama models; default: http://localhost:11434)
You can also add API keys as environment variables.
- OPENAI_API_KEY
- AZURE_OPENAI_API_KEY
- AZURE_OPENAI_ENDPOINT
- AZURE_GPT_45_VISION_NAME
For the full list of environment variables, refer to the ‘.env.local.example’ file. If the environment variables are set for API keys, it will disable the input in the user settings.
Click “Deploy” and wait for your frontend to deploy.
Once deployed, you should be able to use your hosted instance of Chatbot UI via the URL Vercel gives you.
We are working on a guide for contributing.
Message Mckay on Twitter/X
Published By
Latest entries
Dillard's - The Style of Your Life.
1 reply on “mckaywrigley/chatbot-ui: Come join the best place on the internet to learn AI skills. Use code “chatbotui” for an extra 20% off.”
1kw4u1