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!