Start Buster Services
Thebuster start
command launches the Buster services locally using Docker Compose. This creates a fully functional local instance of Buster for development and testing.
Basic Usage
Command Options
Option | Description |
---|---|
--no-track | Disable telemetry tracking (default: false) |
Prerequisites
Before running the start command, ensure you have:- Docker and Docker Compose installed on your system
- Authenticated with
buster auth
(if needed for your setup) - Configured LLM and Reranker settings with
buster config
(will be prompted if not configured)
What Happens When You Start
Thestart
command performs these steps:
- Environment Setup: Creates a
.buster
directory in your home folder to store configuration - Configuration Check: Verifies LLM and Reranker settings, prompting you if needed
- Docker Container Setup: Launches containers for all Buster services
- Service Initialization: Configures the services for first use
- Extracts embedded assets (Docker Compose files, environment templates)
- Creates necessary directories for persistent data
- Sets up the configuration in
.env
files - Launches Docker Compose with the
up -d
command
Configuration Management
The command handles several configuration aspects:- Prompts for OpenAI API key if not already configured
- Manages Reranker settings for improved search results
- Updates LiteLLM configuration for the AI components
- Creates Docker volumes for persistent data storage
Example Output
Telemetry Options
By default, Buster collects anonymous usage data to improve the product. You can disable this by using the--no-track
flag:
TELEMETRY_ENABLED=false
in the environment configuration.
Accessing Buster Services
After starting the services:- The Buster web interface is available at http://localhost:3000
- The API is accessible at http://localhost:3001
Troubleshooting
Common issues and solutions:- Docker connection errors: Ensure Docker is running on your system
- Port conflicts: Check if other services are using ports 3000-3001
- API key issues: Run
buster config
to update your API keys - Slow startup: The first start may take longer to download Docker images
Stopping the Services
To stop the Buster services, use thebuster stop
command.
If you need to reset the services to a clean state, use buster reset
.
Best Practices
- Check Docker First: Ensure Docker is running before starting Buster
- Manage API Keys: Keep your API keys up to date with
buster config
- Stop When Not in Use: Use
buster stop
when you’re done to free system resources - Monitor Logs: Use Docker’s logging commands for troubleshooting
Related Commands
buster stop
- Stop the Buster servicesbuster reset
- Reset the Buster services to a clean statebuster config
- Configure LLM and Reranker settings