.env.example•3.47 kB
# Ignition MCP Server Configuration Template
# Copy this file to .env and customize with your settings
# =============================================================================
# GATEWAY CONNECTION SETTINGS
# =============================================================================
# Base URL for your Ignition Gateway
# Examples:
# - Local development: http://localhost:8088
# - Production HTTPS: https://gateway.company.com:8043
# - Custom port: http://192.168.1.100:9088
IGNITION_MCP_IGNITION_GATEWAY_URL=http://localhost:8088
# =============================================================================
# AUTHENTICATION SETTINGS
# Choose ONE of the following authentication methods:
# =============================================================================
# Option 1: API Key Authentication (RECOMMENDED for production)
# Generate from Ignition Gateway: Config → Security → Users, Roles → [User] → API Keys
# Leave empty to use username/password instead
IGNITION_MCP_IGNITION_API_KEY=
# Option 2: Basic Authentication
# Only used if no API key is provided above
# Default Ignition Gateway credentials (change these!)
IGNITION_MCP_IGNITION_USERNAME=admin
IGNITION_MCP_IGNITION_PASSWORD=password
# =============================================================================
# MCP SERVER SETTINGS (Optional)
# =============================================================================
# Host address to bind the MCP server
# Options:
# - 127.0.0.1 (localhost only, default)
# - 0.0.0.0 (all interfaces)
# - Specific IP address
IGNITION_MCP_SERVER_HOST=127.0.0.1
# Port for the MCP server
# Default: 8000
# Range: 1024-65535 (unprivileged ports)
IGNITION_MCP_SERVER_PORT=8000
# =============================================================================
# ENVIRONMENT-SPECIFIC EXAMPLES
# =============================================================================
# Development Environment
# IGNITION_MCP_IGNITION_GATEWAY_URL=http://localhost:8088
# IGNITION_MCP_IGNITION_USERNAME=admin
# IGNITION_MCP_IGNITION_PASSWORD=password
# Production Environment
# IGNITION_MCP_IGNITION_GATEWAY_URL=https://production-gateway.company.com:8043
# IGNITION_MCP_IGNITION_API_KEY=IGN-API-KEY-1234567890abcdef
# Testing Environment
# IGNITION_MCP_IGNITION_GATEWAY_URL=http://test-gateway:8088
# IGNITION_MCP_IGNITION_API_KEY=test_api_key_here
# =============================================================================
# SECURITY NOTES
# =============================================================================
# 1. Never commit this file with real credentials to version control
# 2. Use API keys instead of username/password when possible
# 3. Rotate API keys regularly in production
# 4. Use HTTPS URLs in production environments
# 5. Restrict network access to the gateway as needed
# =============================================================================
# CLAUDE DESKTOP INTEGRATION
# =============================================================================
# For Claude Desktop integration, add these settings to your
# claude_desktop_config.json file:
#
# {
# "mcpServers": {
# "ignition-mcp": {
# "command": "python",
# "args": ["-m", "ignition_mcp.main"],
# "cwd": "/path/to/ignition-mcp",
# "env": {
# "IGNITION_MCP_IGNITION_GATEWAY_URL": "http://localhost:8088",
# "IGNITION_MCP_IGNITION_API_KEY": "your_api_key"
# }
# }
# }
# }