NotifyMeMaybe/.env.example at main · keoy7am/NotifyMeMaybe · 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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
# ========================================
# NotifyMeMaybe Environment Configuration
# ========================================
# Copy this file to .env and fill in your actual values

# ========================================
# Core System Settings
# ========================================
# Default notification service (telegram, webhook)
DEFAULT_NOTIFICATION_SERVICE=telegram

# Language setting (en, zh-TW, zh-CN)
LANGUAGE=zh-TW

# Debug mode (true/false)
DEBUG=false

# ========================================
# Telegram Service Configuration (Required)
# ========================================
# Your Telegram bot token from @BotFather
TELEGRAM_BOT_TOKEN=your_bot_token_here

# Your Telegram chat ID (user or group)
TELEGRAM_CHAT_ID=your_chat_id_here

# Enable prompt receiving from Telegram (true/false)
TELEGRAM_ENABLE_PROMPT_RECEIVING=true

# ========================================
# Interaction Feature Settings
# ========================================
# Enable interaction functionality (true/false)
TELEGRAM_INTERACTION_ENABLED=true

# Interaction timeout in milliseconds (default: 60000 = 60 seconds)
TELEGRAM_INTERACTION_TIMEOUT=60000

# Maximum pending interaction requests (default: 5)
TELEGRAM_INTERACTION_MAX_PENDING=5

# Auto reject interactions after timeout (true/false)
INTERACTION_AUTO_REJECT=true

# ========================================
# Telegram Prompt Feature Settings
# ========================================
# Enable Telegram prompt receiving (true/false)
TELEGRAM_PROMPT_ENABLED=true

# Maximum prompt queue size (default: 10)
TELEGRAM_PROMPT_MAX_QUEUE=10

# Auto process prompts (true/false)
TELEGRAM_PROMPT_AUTO_PROCESS=true

# ========================================
# Custom Webhook Configuration (Optional)
# ========================================
# Webhook URL for custom integrations
# CUSTOM_WEBHOOK_URL=https://your-webhook-url.com/webhook

# Webhook secret for security (optional)
# CUSTOM_WEBHOOK_SECRET=your_secret_key

# Custom headers for webhook requests (JSON format or key=value,key2=value2)
# CUSTOM_WEBHOOK_HEADERS={"Authorization":"Bearer token","Content-Type":"application/json"}

# ========================================
# Advanced Configuration Notes
# ========================================
#
# 1. TELEGRAM_BOT_TOKEN: Get this from @BotFather on Telegram
#    - Start a chat with @BotFather
#    - Send /newbot command
#    - Follow the instructions to create your bot
#    - Copy the token provided
#
# 2. TELEGRAM_CHAT_ID: Your personal chat ID or group ID
#    - For personal chat: Send a message to your bot and check the logs
#    - For group: Add bot to group and check the logs
#    - Or use @userinfobot to get your chat ID
#
# 3. Interaction Timeout: Set appropriate timeout based on your use case
#    - Short timeouts (30-60s) for quick confirmations
#    - Longer timeouts (120-300s) for complex decisions
#
# 4. Webhook Configuration: Only needed if you want custom webhook integration
#    - Ensure your webhook endpoint can handle POST requests
#    - Consider security implications of webhook secret
#    - Test webhook connectivity before production use
#
# 5. Debug Mode: Enable for development and troubleshooting
#    - Provides detailed logging information
#    - May expose sensitive information in logs
#    - Disable in production environments
#
# ========================================
# Example Configuration for Development
# ========================================
# DEFAULT_NOTIFICATION_SERVICE=telegram
# LANGUAGE=en
# DEBUG=true
# TELEGRAM_BOT_TOKEN=1234567890:ABCdefGHIjklMNOpqrsTUVwxyz
# TELEGRAM_CHAT_ID=123456789
# TELEGRAM_ENABLE_PROMPT_RECEIVING=true
# TELEGRAM_INTERACTION_ENABLED=true
# TELEGRAM_INTERACTION_TIMEOUT=30000
# TELEGRAM_INTERACTION_MAX_PENDING=3
# INTERACTION_AUTO_REJECT=true
# TELEGRAM_PROMPT_ENABLED=true
# TELEGRAM_PROMPT_MAX_QUEUE=5
# TELEGRAM_PROMPT_AUTO_PROCESS=true