Skip to content

Latest commit

 

History

History
53 lines (34 loc) · 3.27 KB

vercel.md

File metadata and controls

53 lines (34 loc) · 3.27 KB

Vercel Deployment Guide

The easiest way to get started with better-chatbot is to deploy it directly to Vercel. You only need one AI Provider API Key (OpenAI, Gemini, Claude, etc.) to run the app. Database, file storage, and caching are all available on free tiers.

Steps

  1. Click this button to start the deployment process: Deploy with Vercel

  2. Click the "Create" button on Vercel to begin setting up your project.

    step2

  3. Add all required resources. When prompted, add:

    • Database (Neon Postgres)
    • Blob Storage (Vercel Blob)
    • Redis (Upstash KV) All of these are available with free-tier plans.
    step3

  4. Set Environment Variables.

    • You must enter a value for BETTER_AUTH_SECRET (any random string is fine). You can generate one here.
    • Enter your AI Provider API Key(s). Only one is required to start (OpenAI, Google Gemini, or Anthropic Claude).
    • You can use placeholder values and update them later in Project Settings > Environments after deployment.
    step4

  5. Deploy your project. Once everything is set, Vercel will automatically build and deploy your project.

  6. Update API Keys and Settings (optional). After deployment, go to Settings > Environments to add or update your API keys and configuration.

    • Example environment file: example.env
    • You can customize authentication, signup/login, and other options by editing your environment variables here.
    step6

Notes

  • To enable web search, you can request an API key from Exa. A free tier is available.
  • Only Remote (SSE, Streamable) MCP servers are supported. STDIO-based servers are not supported on Vercel (consider Docker or Render if needed).
  • Check .env.example for all available settings.