Skip to main content

Zero-Config Setup (15 seconds!)

1. Start Bifrost (No config needed!)

2. Open the Web Interface

🎉 That’s it! Configure providers visually, monitor requests in real-time, and get analytics - all through the web interface!

📂 File-Based Configuration (Optional)

Want to use a config file instead? Bifrost automatically looks for config.json in your app directory:

1. Create config.json in your app directory

2. Set environment variables and start


📁 Understanding App Directory & Docker Volumes

How the -app-dir Flag Works

The -app-dir flag tells Bifrost where to store and look for data:
What Bifrost stores in the app directory:
  • config.json - Configuration file (if using file-based config)
  • logs/ - Database logs and request history
  • Any other persistent data

How Docker Volumes Work with App Directory

Docker volumes map your host directory to Bifrost’s app directory:

Persistence Scenarios

Best Practices

  • 🔧 Development: Use -v $(pwd):/app/data to persist config between restarts
  • 🚀 Production: Mount dedicated volume for data persistence
  • 🧪 Testing: Run without volume for clean ephemeral instances
  • 👥 Teams: Share config.json in version control, mount directory with volume

3. Test the API

🎉 Success! You should see an AI response in JSON format.
📋 Note: All Bifrost responses follow OpenAI’s response structure, regardless of the underlying provider. This ensures consistent integration across different AI providers.

🔄 Drop-in Integrations (Zero Code Changes!)

Already using OpenAI, Anthropic, or Google GenAI? Get instant benefits with zero code changes:

🤖 OpenAI SDK Replacement

🧠 Anthropic SDK Replacement

🔍 Google GenAI Replacement


🚀 Next Steps (30 seconds each)

🖥️ Add Multiple Providers via Web UI

  1. Open http://localhost:8080 in your browser
  2. Click “Add Provider”
  3. Select OpenAI, enter your API key, choose models
  4. Click “Add Provider” again
  5. Select Anthropic, enter your API key, choose models
  6. Done! Your providers are now load-balanced automatically

📡 Or Add Multiple Providers via API

⚡ Test Different Providers

🔄 Add Automatic Fallbacks


🔗 Language Examples

Python

JavaScript/Node.js

Go


🔧 Setup Methods Comparison

Note: When using file-based config, Bifrost only looks for config.json in your specified app directory.

Need Help?

Join our Discord for real-time setup assistance and HTTP integration support!