.env.example•2.97 kB
# Salesforce MCP Connector - Environment Configuration Template
# Copy this file to .env and fill in your actual credentials
# ==============================================================================
# OAuth 2.0 Client Credentials (from Connected App)
# ==============================================================================
# Get these from your Salesforce Connected App
SALESFORCE_CLIENT_ID=your_consumer_key_here
SALESFORCE_CLIENT_SECRET=your_consumer_secret_here
# ==============================================================================
# User Authentication Credentials
# ==============================================================================
# Your Salesforce login credentials
SALESFORCE_USERNAME=your_username@domain.com
SALESFORCE_PASSWORD=your_password_here
SALESFORCE_SECURITY_TOKEN=your_security_token_here
# ==============================================================================
# Environment Configuration
# ==============================================================================
# Set to "true" for sandbox, "false" for production
SALESFORCE_SANDBOX=true
# ==============================================================================
# Optional: Direct Token Authentication (Alternative Method)
# ==============================================================================
# Use these if you want to skip username/password and use tokens directly
# SALESFORCE_ACCESS_TOKEN=your_access_token_here
# SALESFORCE_INSTANCE_URL=https://your-instance.my.salesforce.com
# ==============================================================================
# Setup Instructions:
# ==============================================================================
# 1. Create a Connected App in Salesforce:
# Setup → Apps → App Manager → New Connected App
# - Enable OAuth Settings
# - Set callback URL: http://localhost:8080/callback (not used but required)
# - OAuth Scopes: Access basic info, API access, Refresh token
#
# 2. Get your Consumer Key and Consumer Secret from the Connected App
#
# 3. Fill in your Salesforce username, password, and security token
# - Security token: Setup → My Personal Information → Reset Security Token
#
# 4. Set SALESFORCE_SANDBOX=true for sandbox, false for production
#
# 5. Save this file as .env (remove the .example extension)
#
# 6. Test with: npm run start
# ==============================================================================
# Docker Setup (Optional)
# ==============================================================================
# Used for docker-compose and docker-publish.sh scripts
DOCKER_HUB_USERNAME=your_dockerhub_username
# ==============================================================================
# MCP Server Configuration (Optional)
# ==============================================================================
# Configure the Model Context Protocol server settings
MCP_SERVER_PORT=3000
MCP_SERVER_HOST=0.0.0.0