zammad-ai/.env.example at main · it-at-m/zammad-ai · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
# ============================================================================
# Zammad-AI Environment Variables Template
# ============================================================================
# Copy this file to .env and fill in your actual values
# These variables are required for the application to function properly

# ============================================================================
# OpenAI SDK Configuration
# ============================================================================
# These environment variables are used by the OpenAI SDK (langchain-openai)
# They are NOT part of the Pydantic settings schema but are required

# Your OpenAI API key (required)
OPENAI_API_KEY=

# Optional: Custom base URL for OpenAI-compatible endpoints (e.g., proxy)
# Remove or leave empty to use the default OpenAI endpoint
OPENAI_BASE_URL=

# Optional: OpenAI organization ID
# OPENAI_ORGANIZATION=

# ============================================================================
# Langfuse SDK Configuration
# ============================================================================
# These environment variables are used by the Langfuse SDK
# They are NOT part of the Pydantic settings schema
# Only required if langfuse_enabled=true in config.yaml

# Langfuse secret key (required if Langfuse is enabled)
LANGFUSE_SECRET_KEY=

# Langfuse public key (required if Langfuse is enabled)
LANGFUSE_PUBLIC_KEY=

# Langfuse host URL (required if Langfuse is enabled)
# Example: https://cloud.langfuse.com or https://your-langfuse-instance.com
LANGFUSE_HOST=

# ============================================================================
# Zammad-AI Settings - Zammad
# ============================================================================
# These are part of the Pydantic settings schema with prefix ZAMMAD_AI_

# Zammad authentication token (required)
ZAMMAD_AI_ZAMMAD__AUTH_TOKEN=

# Zammad RSS feed token (optional, for accessing knowledge base RSS feed)
ZAMMAD_AI_ZAMMAD__RSS_FEED_TOKEN=

# Alternative: For EAI-based Zammad integration, use this instead:
# ZAMMAD_AI_ZAMMAD__SECRET=

# ============================================================================
# Zammad-AI Settings - Qdrant
# ============================================================================

# Qdrant API key (required)
ZAMMAD_AI_QDRANT__API_KEY=

# ============================================================================
# Zammad-AI Settings - Kafka mTLS Security
# ============================================================================
# Two approaches are available for Kafka mTLS configuration:
#
# Option 1: File-based (recommended for local development)
# Uncomment and set paths to your certificate files:
# ZAMMAD_AI_KAFKA__SECURITY__CA_FILE_PATH=/path/to/ca.pem
# ZAMMAD_AI_KAFKA__SECURITY__CLIENT_CERT_PATH=/path/to/client.crt
# ZAMMAD_AI_KAFKA__SECURITY__CLIENT_KEY_PATH=/path/to/client.key
#
# Option 2: Environment/base64-encoded (recommended for production/CI)
# Uncomment and set values (password is cleartext):
# ZAMMAD_AI_KAFKA__SECURITY__CA_FILE_BASE64=
# ZAMMAD_AI_KAFKA__SECURITY__PKCS12_BASE64=
# ZAMMAD_AI_KAFKA__SECURITY__PKCS12_PW=  # cleartext PKCS#12 password (if using env-based PKCS#12)

# Kafka event processing filters
# JSON-encoded array of allowed request types, e.g. '["support"]'
# ZAMMAD_AI_KAFKA__EVENT_PROCESSING__VALID_REQUEST_TYPES=
# JSON-encoded array of allowed action types, e.g. '["created","updated"]'
# ZAMMAD_AI_KAFKA__EVENT_PROCESSING__VALID_ACTION_TYPES=