Quick Start Guide
Get CoAI.Dev up and running in 5 minutes
Quick Start Guide
Get your CoAI.Dev instance running in under 5 minutes with this streamlined setup guide.
Prerequisites
Before starting, ensure you have:
- Docker and Docker Compose installed
- At least 2GB RAM and 1GB disk space
- An API key from at least one AI provider (OpenAI, Anthropic, etc.)
Setup Process
Download and Deploy
Clone the repository and start with Docker Compose:
Your CoAI.Dev instance will be available at http://localhost:8000
Initial Login
- Open your browser and navigate to your CoAI.Dev instance
- Use the default admin credentials:
- Username:
root
- Password:
chatnio123456
- Username:
Security Notice
Important: Change the default password immediately after first login for security reasons.
Configure Your First AI Channel
Navigate to the admin panel and set up your first AI provider:
- Access Admin Panel: Click on the admin/settings icon in the navigation
- Go to Channel Management: Find "Channels" in the admin sidebar
- Add New Channel: Click the "Add Channel" button
- Select Provider Type: Choose your AI provider (e.g., OpenAI, Anthropic)
- Configure Settings:
- Test Connection: Use the test button to verify your configuration
- Save Channel: Click save to activate the channel
Add Models to Workspace
Configure which AI models appear in your chat interface:
- Navigate to Model Market: Go to "Model Market" in the main navigation
- Browse Available Models: View all configured models
- Add to Workspace: Click "Add to Workspace" on models you want to use
- Customize Display: Configure model names, descriptions, and tags as needed
Popular model configurations:
- GPT-4: For complex reasoning and analysis
- GPT-3.5 Turbo: For fast, cost-effective conversations
- Claude: For detailed writing and analysis
- Gemini: For multimodal capabilities
Test Your Setup
Verify everything is working correctly:
- Start a Conversation: Go to the main chat interface
- Select a Model: Choose from your workspace models
- Send a Test Message: Try "Hello, can you help me test this AI service?"
- Monitor Logs: Check the admin panel for request logs and analytics
Success!
If you receive a response, congratulations! Your CoAI.Dev instance is fully operational.
Next Steps
Now that CoAI.Dev is running, explore these advanced features:
🔧 Configure Additional Channels
- Add Multiple AI Providers for redundancy
- Set Up Load Balancing across channels
- Configure Regional Routing
💰 Set Up Billing
- Configure Token-Based Billing for usage tracking
👥 Manage Users
- Create User Accounts and assign permissions
- Set Usage Quotas and rate limits
- Configure Access Controls
📊 Monitor Performance
- Set Up Analytics for usage insights
- Configure Analytics for usage insights
- Review Logs for troubleshooting
Common Issues
Database Connection Error
Problem: "Cannot connect to database"
Solution: Ensure MySQL is running and accessible. Check the connection parameters in your environment variables or configuration file.
API Key Invalid
Problem: "Invalid API key" when testing channels
Solution: Verify your API key is correct and has proper permissions. Some providers require specific scopes or billing setup.
Models Not Appearing
Problem: Models don't show up in the chat interface
Solution: Make sure you've added models to your workspace in the Model Market section. Only workspace models appear in the chat interface.
Production Deployment
For production use, consider these additional configurations:
- Security: Configure security settings and content moderation
- High Availability: Deploy with Kubernetes for production
- Analytics: Set up monitoring and usage tracking
- Scaling: Deploy with Kubernetes for high availability
Need help? Check the troubleshooting guide or visit our GitHub repository for community support.