Repository navigation
Expand file tree
/
Copy pathconfig.example.yaml
More file actions
119 lines (109 loc) · 6.04 KB
/
Copy pathconfig.example.yaml
File metadata and controls
119 lines (109 loc) · 6.04 KB
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
114
115
116
117
118
119
# AtomicWatcherAquarium (AWA) Configuration Example
#
# Copy this file to config.yaml and customize it for your setup:
# cp config.example.yaml config.yaml
#
# Environment Variables Support:
# - AWA automatically loads .env file from the project root
# - Use ${VAR_NAME} syntax to reference environment variables
# - Use ${VAR_NAME:-default_value} to provide default values
# - Example: password: "${EMAIL_PASSWORD}" or password: "${EMAIL_PASSWORD:-fallback}"
#
# Security Best Practice:
# Store sensitive information (passwords, API keys, tokens) in .env file
# instead of committing them in config.yaml
# Log file configuration
log_file: "awa.log" # Path to log file
# Notification providers configuration
notifier:
# Console notifier - displays notifications in terminal with rich markdown formatting
console:
enabled: true
enable_rich_markdown_formatting: true
# Ntfy notifier - sends push notifications to ntfy.sh server
ntfy:
enabled: false # Set to true to enable ntfy notifications
url: "http://127.0.0.1:20403" # Your ntfy server URL (or use https://ntfy.sh)
topic: "awa" # Topic name for notifications
# Lark (Feishu) notifier - sends messages to Lark via webhook
lark:
enabled: false # Set to true to enable Lark notifications
webhook_url: "${LARK_WEBHOOK_URL}" # Your Lark webhook URL (recommended: store in .env)
# OneBot-11 notifier - sends messages to OneBot v11 servers (supports QQ, Discord, Lark, etc.)
# See: https://github.com/botuniverse/onebot-11
onebot-11:
enabled: false # Set to true to enable OneBot-11 notifications
url: "http://127.0.0.1:5700" # OneBot HTTP API server URL
access_token: "${ONEBOT_ACCESS_TOKEN}" # Access token for authentication (recommended: store in .env)
to_group_ids: [] # List of group IDs to send notifications to, e.g., ["1016792818", "1234567890"]
to_friend_ids: [] # List of friend/user IDs to send notifications to, e.g., ["2014709936", "9876543210"]
# Watchers configuration
watchers:
# IMAP Email Watcher
# Monitors email accounts for new messages with optional LLM-powered summarization
imap_watcher:
enabled: false # Set to true to enable this watcher
interval_seconds: 60 # Check for new emails every 60 seconds
watching:
# First email account example
- server: "mail.example.com" # IMAP server address
enabled: false # Set to true to enable this account
username: "your-email@example.com" # Your email address
password: "${EMAIL_PASSWORD}" # Your email password (recommended: store in .env)
enable_summary: false # Enable LLM summarization of email content. If
summary:
model_name: "gpt-4o-mini" # LLM model to use, requires plugins/configs/llm.json setup
prompt: "Please summarize this email in 1-2 sentences. Keep it concise and capture the main idea."
# Optional: Configure email body length limits (defaults shown below)
llm_body_limit: 10000 # Max characters sent to LLM for summarization (default: 10000)
display_body_limit: 2500 # Max characters displayed in notifications (default: 2500)
# System Resource Watcher
# Monitors CPU and RAM usage, sends alerts when thresholds are exceeded
system_watcher:
enabled: false # Set to true to enable this watcher
interval_seconds: 2 # Check system resources every 2 seconds
cpu_threshold: 95 # Alert when CPU usage exceeds 95%
ram_threshold: 95 # Alert when RAM usage exceeds 95%
cooldown_seconds: 60 # Wait 60 seconds between alerts to prevent spam
# RSS Feed Watcher
# Monitors RSS/Atom feeds with optional AI-powered content filtering
rss_watcher:
enabled: false # Set to true to enable this watcher
interval_seconds: 3600 # Check feeds every hour (3600 seconds)
watching:
# First RSS feed example
- url: "https://example.com/feed.xml" # RSS/Atom feed URL
name: "Example Blog" # Display name for this feed
enabled: false # Set to true to enable this feed
enable_digest: false # Use LLM to create a digest of relevant entries. If false, all new entries are notified.
digest:
model_name: "gpt-4" # LLM model to use
prompt: |
Review the following RSS feed entries and select only the most relevant and interesting ones.
Provide a concise digest with titles and links.
If no entries are relevant, respond with: "No relevant entries found."
enable_llm_filter: false # Use LLM to filter entries for relevance
llm_filter:
model_name: "gpt-4o-mini" # LLM model to use
prompt: |
Evaluate the recommendation score of the following RSS feed entry to current events.
The score ranges from 0 (not relevant) to 5 (highly relevant).
Respond with only the score in the format: \\boxed{score}.
max_concurrent_queries: 50 # Max concurrent LLM filter queries (default: 50)
score_threshold: 3 # Minimum score (0-5) to consider entry relevant
# OpenReview Watcher
# Monitors OpenReview submissions for new reviews, comments, and status changes
# Uses StateDiff plugin for persistent state tracking (stores in plugins/data/state_diff/)
openreview_watcher:
enabled: false # Set to true to enable this watcher
interval_seconds: 120 # Check every 2 minutes (120 seconds)
clients:
# First OpenReview account example
- username: "${OPENREVIEW_USERNAME}" # Your OpenReview username (recommended: store in .env)
password: "${OPENREVIEW_PASSWORD}" # Your OpenReview password (recommended: store in .env)
user_id: "~John_Doe1" # Your OpenReview user ID (e.g., ~First_Last1)
summary_model: "gpt-4o-mini" # LLM model for summarizing reviews/comments
# Note: State is automatically managed by StateDiff plugin, no manual cache configuration needed
# Plugins manage their own configuration files.
# For LLM features (email summaries, RSS digests, OpenReview summaries), edit ./plugins/configs/llm.json.
# State management is handled by StateDiff plugin, which stores data in ./plugins/data/state_diff/