Hopping-Mad-Games-ComfyUI_LiteLLM/ENVIRONMENT.md

Environment Configuration for ComfyUI_LiteLLM

This document explains how to configure environment variables and API keys for ComfyUI_LiteLLM.

Important: This addon follows best practices and never pollutes the global environment. It only reads environment variables and won't interfere with other ComfyUI custom node packages.

Quick Setup

For Production ComfyUI Use

Set environment variables at the system level:

export OPENAI_API_KEY="your-openai-api-key"
export KLUSTER_API_KEY="your-kluster-api-key"

For Development/Testing Only

1. Copy the example environment file:

   cp .env.example .env
   

2. Edit .env with your actual API keys:

   nano .env  # or use your preferred editor
   

3. Set your API keys in the .env file:

   KLUSTER_API_KEY=your-actual-kluster-api-key-here
   OPENAI_API_KEY=your-actual-openai-api-key-here
   

Note: The .env file is only used when system environment variables are not available. This makes it perfect for testing without affecting production.

Environment Variables

API Keys (Set at System Level for Production)

• OPENAI_API_KEY - OpenAI API key
• ANTHROPIC_API_KEY - Anthropic (Claude) API key
• COHERE_API_KEY - Cohere API key
• KLUSTER_API_KEY - Your Kluster.ai API key

API Base URLs (Configured in config.yaml)

• KLUSTER_BASE_URL - Kluster.ai API base URL (default: https://api.kluster.ai/v1)
• OPENAI_BASE_URL - OpenAI API base URL (default: https://api.openai.com/v1)

Test Configuration (Development Only)

• RUN_INTEGRATION_TESTS - Set to true to run integration tests (default: false)

Development Settings (Development Only)

• DEBUG - Enable debug mode (default: false)
• LOG_LEVEL - Set logging level (default: INFO)

Security Best Practices

✅ DO

• Use system environment variables for production API keys
• Keep your .env file local and never commit it (development only)
• Use the .env.example file as a template
• Rotate API keys regularly
• Use different keys for development and production
• Trust that this addon won't interfere with other ComfyUI packages

❌ DON'T

• Hardcode API keys in source code
• Put API keys in config.yaml files
• Commit .env files to version control
• Share API keys in plain text
• Use production keys for testing
• Worry about environment pollution - this addon is clean!

File Structure

ComfyUI_LiteLLM/
├── .env.example          # Template for environment variables (dev/test only)
├── .env                  # Your actual environment variables (dev/test only, gitignored)
├── .gitignore           # Ensures .env files are not committed
├── config.yaml          # Non-sensitive configuration (base URLs, paths)
└── utils/
    └── env_config.py    # Safe environment reading utility

Architecture

This addon uses a clean, non-polluting architecture:

• System environment: Primary source for API keys in production
• .env file: Fallback for development/testing only
• config.yaml: Non-sensitive settings only (never API keys)
• No global pollution: Never sets or modifies environment variables

Usage in Code

Loading Environment Variables

from utils.env_config import get_env_var, get_api_config

# Get a single environment variable
api_key = get_env_var('KLUSTER_API_KEY', required=True)

# Get all API configuration
config = get_api_config()
kluster_key = config['kluster']['api_key']

Kluster.ai Configuration

from utils.env_config import get_kluster_config

try:
    config = get_kluster_config()
    # Use config['api_key'], config['base_url'], config['model']
except ValueError as e:
    print(f"Kluster configuration error: {e}")

Testing

Running Tests with Environment Variables

# Set environment variables and run tests
export KLUSTER_API_KEY="your-key-here"
python -m pytest tests/

# Or use .env file (recommended)
echo "KLUSTER_API_KEY=your-key-here" > .env
python -m pytest tests/

Skipping Tests Without API Keys

Tests will automatically skip if required API keys are not configured:

SKIPPED [1] Kluster API key not configured. Set KLUSTER_API_KEY environment variable.

Integration Tests

Set RUN_INTEGRATION_TESTS=true in your .env file to enable tests that make real API calls:

RUN_INTEGRATION_TESTS=true
KLUSTER_API_KEY=your-actual-key

Troubleshooting

Common Issues

1. "Kluster API key not configured"

   • Ensure KLUSTER_API_KEY is set in your environment or .env file
   • Check that the .env file is in the project root directory

2. "Tests are skipped"

   • This is normal behavior when API keys are not configured
   • Add the required API keys to run integration tests

3. "Environment file not found"

   • Create a .env file based on .env.example
   • Ensure the file is in the correct location (project root)

Debug Environment Loading

from utils.env_config import load_env_file
import os

# Check what's loaded from .env file
env_vars = load_env_file()
print("Loaded from .env:", env_vars)

# Check what's in the actual environment
print("KLUSTER_API_KEY in env:", os.environ.get('KLUSTER_API_KEY'))

Migration from Hardcoded Keys

If you're migrating from an older version with hardcoded API keys:

1. Find hardcoded keys in your code:

   grep -r "46b1a513-72b6-4549-aac3-0d2f8ae16db9" .
   

2. Replace with environment variables:

   # Old (insecure)
   api_key = "46b1a513-72b6-4549-aac3-0d2f8ae16db9"
   
   # New (secure)
   api_key = os.environ.get('KLUSTER_API_KEY')
   

3. Add keys to .env file:

   KLUSTER_API_KEY=46b1a513-72b6-4549-aac3-0d2f8ae16db9
   

4. Test the migration:

   python -m pytest tests/ -v
   

Production Deployment

For production environments:

1. Set system environment variables - Don't rely on .env files in production
2. Use secrets management - Tools like HashiCorp Vault, AWS Secrets Manager, etc.
3. Monitor key usage - Set up alerts for API key usage and errors
4. Implement key rotation - Regularly rotate API keys
5. Trust the clean architecture - This addon won't interfere with other packages

Example production setup:

# Set environment variables in your deployment/container
export KLUSTER_API_KEY="prod-key-here"
export OPENAI_API_KEY="prod-openai-key"
# Other ComfyUI packages can safely use the same environment variables

Compatibility with Other ComfyUI Packages

This addon is designed to be a good citizen in the ComfyUI ecosystem:

• ✅ Never modifies global environment variables
• ✅ Reads from system environment first, .env second
• ✅ Won't override API keys that other packages expect
• ✅ Uses namespaced internal variables when needed
• ✅ Safe to use alongside any other ComfyUI custom nodes

You can safely install this alongside other packages that use OpenAI, Anthropic, or other APIs without any conflicts.