Configuration Guide

🚀 Initial Configuration

First-Time Setup

When you first install Hero Rabbit, you’ll need to configure it to work with your RabbitMQ instance:

Connection Settings

Host Configuration:

• Local Development: http://localhost:15672
• Remote Server: http://your-server:15672
• HTTPS: https://your-server:15672 (recommended for production)
• Custom Port: http://your-server:15673 (if using non-standard port)

Credential Management:

• Local Storage: Credentials stored securely in Chrome’s extension storage
• Auto-detection: Automatically detects RabbitMQ version
• Multiple Instances: Support for multiple RabbitMQ servers
• Credential Rotation: Easy to update when passwords change

🔧 Feature Configuration

Dashboard Features

Management Features

🎨 Interface Configuration

Theme Settings

Dark Mode:

• Automatic: Follows system theme preference
• Manual Toggle: Switch between light and dark themes
• Persistent: Remembers your preference across sessions

Visual Customization:

• Color Scheme: Consistent with your system theme
• Font Sizes: Optimized for readability
• Layout: Responsive design for different screen sizes

Display Options

Information Density:

• Compact: Show more information in less space
• Standard: Balanced layout for most users
• Detailed: Show additional metadata and details

Update Frequency:

• Real-time: Live updates (may use more resources)
• Standard: Updates every 30 seconds
• Manual: Refresh only when requested

🔒 Security Configuration

Access Control

User Permissions:

• Admin Users: Full access to all features
• Developer Users: Access to dashboard and basic management
• Read-only Users: Dashboard access only
• Restricted Users: Limited feature access

Feature Restrictions:

• Message Manipulation: Control who can download/upload messages
• Connection Management: Limit connection control capabilities
• Configuration Changes: Restrict who can modify settings
• Audit Access: Control access to usage logs

Network Security

Connection Security:

• HTTPS Only: Require secure connections
• Certificate Validation: Verify SSL certificates
• IP Restrictions: Limit access to specific networks
• VPN Requirements: Enforce VPN usage for remote access

Data Protection:

• Local Storage: All data stored locally in Chrome
• No External Calls: No data transmitted to external servers
• Encryption: Secure storage of sensitive information
• Access Logging: Track all configuration changes

📊 Performance Configuration

Resource Management

Memory Usage:

• Cache Size: Control how much data to cache
• Update Frequency: Balance between real-time data and performance
• Data Retention: How long to keep historical data
• Cleanup Intervals: Automatic cleanup of old data

Network Optimization:

• Request Batching: Group multiple API calls
• Connection Pooling: Reuse connections when possible
• Timeout Settings: Configure request timeouts
• Retry Logic: Handle failed requests gracefully

Monitoring Settings

Performance Tracking:

• Response Times: Monitor API response times
• Error Rates: Track failed requests and errors
• Resource Usage: Monitor memory and CPU usage
• User Activity: Track feature usage patterns

Alert Configuration:

• Performance Thresholds: Set alerts for slow responses
• Error Notifications: Get notified of connection issues
• Resource Warnings: Alert when approaching limits
• Maintenance Reminders: Schedule regular maintenance tasks

🌍 Multi-Environment Configuration

Environment-Specific Settings

Development Environment:

{
  "host": "http://localhost:15672",
  "username": "dev_user",
  "features": {
    "dashboard": true,
    "management": true,
    "connections": true
  },
  "performance": {
    "updateFrequency": "real-time",
    "cacheSize": "large"
  }
}

Staging Environment:

{
  "host": "https://staging-rabbitmq.company.com",
  "username": "staging_user",
  "features": {
    "dashboard": true,
    "management": false,
    "connections": true
  },
  "performance": {
    "updateFrequency": "standard",
    "cacheSize": "medium"
  }
}

Production Environment:

{
  "host": "https://rabbitmq.company.com",
  "username": "prod_user",
  "features": {
    "dashboard": true,
    "management": false,
    "connections": false
  },
  "performance": {
    "updateFrequency": "manual",
    "cacheSize": "small"
  }
}

Configuration Management

Best Practices:

• Environment Separation: Use different configurations for each environment
• Version Control: Store configurations in version control
• Documentation: Document all configuration changes
• Testing: Test configurations in lower environments first

Configuration Validation:

• Schema Validation: Ensure configuration format is correct
• Connection Testing: Verify RabbitMQ connectivity
• Feature Testing: Test enabled features work correctly
• Performance Testing: Validate performance settings

🔄 Advanced Configuration

Custom Integrations

Webhook Configuration:

• Event Notifications: Send alerts to external systems
• Data Export: Export data to external analytics platforms
• Integration APIs: Connect with monitoring tools
• Custom Dashboards: Integrate with existing dashboards

Plugin System:

• Custom Features: Add organization-specific functionality
• Data Sources: Integrate with additional data sources
• Export Formats: Support custom export formats
• Authentication: Custom authentication methods

Automation

Scheduled Tasks:

• Data Collection: Automated data gathering
• Report Generation: Scheduled report creation
• Maintenance Tasks: Automated cleanup and optimization
• Backup Operations: Automated configuration backups

API Access:

• REST API: Programmatic access to configuration
• CLI Tools: Command-line configuration management
• SDK Support: Software development kit for integrations
• Webhook Support: Real-time configuration updates

📝 Configuration Examples

Basic Configuration

{
  "rabbitmq": {
    "host": "https://rabbitmq.company.com",
    "username": "monitoring_user",
    "version": "3.13.3"
  },
  "features": {
    "dashboard": {
      "enabled": true,
      "updateFrequency": "30s",
      "charts": ["queues", "channels", "connections"]
    },
    "management": {
      "enabled": false
    }
  },
  "security": {
    "httpsOnly": true,
    "auditLogging": true
  }
}

Advanced Configuration

{
  "rabbitmq": {
    "host": "https://rabbitmq.company.com",
    "username": "admin_user",
    "version": "3.13.3",
    "timeout": 30000,
    "retries": 3
  },
  "features": {
    "dashboard": {
      "enabled": true,
      "updateFrequency": "real-time",
      "charts": ["queues", "channels", "connections"],
      "customMetrics": ["messageRate", "errorRate"]
    },
    "management": {
      "enabled": true,
      "restrictions": ["admin_only"],
      "auditLogging": true
    },
    "connections": {
      "enabled": true,
      "monitoring": true,
      "control": true
    }
  },
  "performance": {
    "cacheSize": "large",
    "updateFrequency": "real-time",
    "batchSize": 100,
    "timeout": 30000
  },
  "security": {
    "httpsOnly": true,
    "certificateValidation": true,
    "ipRestrictions": ["10.0.0.0/8", "192.168.0.0/16"],
    "auditLogging": true,
    "accessControl": "role_based"
  }
}

🔍 Troubleshooting Configuration

Common Issues

Configuration Validation

Validation Steps:

1. Check Format: Ensure JSON is valid
2. Test Connection: Verify RabbitMQ connectivity
3. Test Features: Verify enabled features work
4. Check Permissions: Ensure user has required access
5. Monitor Performance: Check resource usage

Debug Information:

• Connection Logs: Detailed connection information
• Feature Status: Which features are enabled/disabled
• Error Logs: Detailed error information
• Performance Metrics: Response times and resource usage