.env.example

# ADK Confluence Documentation Connector Configuration
# Copy this file to .env and fill in your actual values

# =============================================================================
# CONFLUENCE CONFIGURATION
# =============================================================================

# Confluence instance URL (required)
# Example: https://your-company.atlassian.net
CONFLUENCE_BASE_URL=

# Authentication credentials (required)
# Use your Atlassian email and API token (not password)
# Generate API token at: https://id.atlassian.com/manage-profile/security/api-tokens
CONFLUENCE_USERNAME=
CONFLUENCE_API_TOKEN=

# Default space key for searches (optional)
# If set, searches will default to this space when no space is specified
# Example: SEC, DOCS, POLICY
CONFLUENCE_DEFAULT_SPACE=

# Space access list (optional)
# Comma-separated list of space keys the tool can access
# Leave empty to allow access to all spaces the user has permission for
# Example: SEC,POLICY,GCP,COMPLIANCE
CONFLUENCE_ALLOWED_SPACES=

# =============================================================================
# CACHE CONFIGURATION
# =============================================================================

# Cache database path (optional)
# Relative to project root or absolute path
# Default: backend/cache/confluence_cache.db
CONFLUENCE_CACHE_DB_PATH=backend/cache/confluence_cache.db

# Default cache TTL in hours (optional)
# How long to cache search results and document content
# Default: 24 hours for search results, 4 hours for content
CONFLUENCE_CACHE_TTL_SEARCH=24
CONFLUENCE_CACHE_TTL_CONTENT=4

# Enable cache cleanup on startup (optional)
# Removes expired cache entries when tool initializes
# Default: true
CONFLUENCE_CACHE_CLEANUP_ON_START=true

# =============================================================================
# RATE LIMITING CONFIGURATION
# =============================================================================

# API rate limit (calls per minute)
# Confluence Cloud standard limit is 100 requests per minute
# Set lower for conservative usage or higher if you have premium limits
# Default: 90 (conservative)
CONFLUENCE_RATE_LIMIT=90

# Circuit breaker threshold (optional)
# Number of consecutive failures before circuit breaker opens
# Default: 5
CONFLUENCE_CIRCUIT_BREAKER_THRESHOLD=5

# Circuit breaker timeout in minutes (optional)
# How long to wait before attempting to reset the circuit breaker
# Default: 5
CONFLUENCE_CIRCUIT_BREAKER_TIMEOUT=5

# =============================================================================
# SEARCH CONFIGURATION
# =============================================================================

# Default search limit (optional)
# Maximum number of results to return per search
# Default: 10, Maximum: 50
CONFLUENCE_DEFAULT_SEARCH_LIMIT=10

# Content expansion (optional)
# Whether to include full page content in search results by default
# Warning: Including content increases API usage and response time
# Default: false
CONFLUENCE_INCLUDE_CONTENT_DEFAULT=false

# Search timeout in seconds (optional)
# How long to wait for search API responses
# Default: 30
CONFLUENCE_SEARCH_TIMEOUT=30

# =============================================================================
# AUDIT AND LOGGING CONFIGURATION
# =============================================================================

# Audit logging enabled (optional)
# Whether to log all Confluence operations for audit purposes
# Default: true
CONFLUENCE_AUDIT_ENABLED=true

# Audit log level (optional)
# Logging level for Confluence operations: DEBUG, INFO, WARNING, ERROR
# Default: INFO
CONFLUENCE_LOG_LEVEL=INFO

# Audit log format (optional)
# Log format for audit events: json, text
# Default: json
CONFLUENCE_AUDIT_FORMAT=json

# =============================================================================
# SECURITY CONFIGURATION
# =============================================================================

# SSL verification (optional)
# Whether to verify SSL certificates for Confluence requests
# Should only be disabled for development/testing with self-signed certs
# Default: true
CONFLUENCE_SSL_VERIFY=true

# Request timeout in seconds (optional)
# Overall timeout for HTTP requests to Confluence
# Default: 30
CONFLUENCE_REQUEST_TIMEOUT=30

# User agent for API requests (optional)
# Custom user agent string for identification in Confluence logs
# Default: ADK-Confluence-Tool/1.0
CONFLUENCE_USER_AGENT=ADK-Confluence-Tool/1.0

# =============================================================================
# ADK INTEGRATION CONFIGURATION
# =============================================================================

# Tool name for ADK registration (optional)
# Name used when registering the tool with ADK agent
# Default: confluence_search
ADK_TOOL_NAME=confluence_search

# Tool category for ADK classification (optional)
# Category for organizing tools in ADK framework
# Default: documentation
ADK_TOOL_CATEGORY=documentation

# Enable tool in security agent (optional)
# Whether to automatically register this tool with the security agent
# Default: true
ADK_SECURITY_AGENT_ENABLED=true

# =============================================================================
# DEVELOPMENT CONFIGURATION
# =============================================================================

# Debug mode (optional)
# Enable verbose logging and debug features
# Should be false in production
# Default: false
CONFLUENCE_DEBUG=false

# Mock API responses (optional)
# Use mock responses instead of real API calls for testing
# Should be false in production
# Default: false
CONFLUENCE_USE_MOCK=false

# Test space key (optional)
# Space to use for integration tests
# Should be a dedicated test space
CONFLUENCE_TEST_SPACE=

# =============================================================================
# EXAMPLE CONFIGURATION FOR DEVELOPMENT
# =============================================================================

# Example values for a typical development setup:
# CONFLUENCE_BASE_URL=https://mycompany.atlassian.net
# CONFLUENCE_USERNAME=john.doe@mycompany.com
# CONFLUENCE_API_TOKEN=ATATT3xFfGF0T5zTBkTkN9iE8Fv...
# CONFLUENCE_DEFAULT_SPACE=DEV
# CONFLUENCE_ALLOWED_SPACES=DEV,TEST,DOCS
# CONFLUENCE_DEBUG=true

# =============================================================================
# PRODUCTION CHECKLIST
# =============================================================================

# Before deploying to production, ensure:
# ✅ CONFLUENCE_API_TOKEN is properly secured
# ✅ CONFLUENCE_DEBUG is set to false
# ✅ CONFLUENCE_USE_MOCK is set to false
# ✅ CONFLUENCE_SSL_VERIFY is set to true
# ✅ Appropriate rate limits are configured
# ✅ Audit logging is enabled
# ✅ Cache paths are writable by the application
# ✅ Only necessary spaces are in CONFLUENCE_ALLOWED_SPACES