Skip to content

Commit 28f91c1

Browse files
committed
Merge branch 'pre-release-candidate' into feature/email-summarizer-plugin
2 parents b67f4ea + 8898b43 commit 28f91c1

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+1786
-624
lines changed

CLAUDE.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -325,6 +325,31 @@ OLLAMA_BASE_URL=http://ollama:11434
325325
SPEAKER_SERVICE_URL=http://speaker-recognition:8085
326326
```
327327

328+
### Plugin Security Architecture
329+
330+
**Three-File Separation**:
331+
332+
1. **backends/advanced/.env** - Secrets (gitignored)
333+
```bash
334+
SMTP_PASSWORD=abcdefghijklmnop
335+
OPENAI_API_KEY=sk-proj-...
336+
```
337+
338+
2. **config/plugins.yml** - Orchestration (uses env var references)
339+
```yaml
340+
plugins:
341+
email_summarizer:
342+
enabled: true
343+
smtp_password: ${SMTP_PASSWORD} # Reference, not actual value!
344+
```
345+
346+
3. **plugins/{plugin_id}/config.yml** - Non-secret defaults
347+
```yaml
348+
subject_prefix: "Conversation Summary"
349+
```
350+
351+
**CRITICAL**: Never hardcode secrets in `config/plugins.yml`. Always use `${ENV_VAR}` syntax.
352+
328353
## Quick API Reference
329354

330355
### Common Endpoints

backends/advanced/.env.template

Lines changed: 32 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -58,23 +58,49 @@ LANGFUSE_SECRET_KEY=
5858
# Tailscale auth key (for remote service access)
5959
TS_AUTHKEY=
6060

61-
# Home Assistant long-lived access token (for voice control plugin)
62-
HA_TOKEN=
63-
6461
# ========================================
65-
# Email Summarizer Plugin (Optional)
62+
# Plugin Configuration
6663
# ========================================
64+
# Plugin-specific configuration is in: backends/advanced/src/advanced_omi_backend/plugins/{plugin_id}/config.yml
65+
# Plugin orchestration (enabled, events) is in: config/plugins.yml
66+
# This section contains ONLY plugin secrets
67+
68+
# ---------------------------------------
69+
# Home Assistant Plugin
70+
# ---------------------------------------
71+
# Enable in config/plugins.yml
72+
# Configure in backends/advanced/src/advanced_omi_backend/plugins/homeassistant/config.yml
73+
74+
# Home Assistant server URL
75+
HA_URL=http://homeassistant.local:8123
76+
77+
# Home Assistant long-lived access token
78+
# Get from: Profile → Security → Long-Lived Access Tokens
79+
HA_TOKEN=
6780

68-
# SMTP Configuration for sending email summaries
81+
# Wake word for voice commands (optional, default: vivi)
82+
HA_WAKE_WORD=vivi
83+
84+
# Request timeout in seconds (optional, default: 30)
85+
HA_TIMEOUT=30
86+
87+
# ---------------------------------------
88+
# Email Summarizer Plugin
89+
# ---------------------------------------
90+
# Enable in config/plugins.yml
91+
# Configure in backends/advanced/src/advanced_omi_backend/plugins/email_summarizer/config.yml
92+
93+
# SMTP server configuration
6994
# For Gmail: Use App Password (requires 2FA enabled)
7095
# 1. Go to Google Account → Security → 2-Step Verification
7196
# 2. Scroll to "App passwords" → Generate password for "Mail"
7297
# 3. Use the 16-character password below (no spaces)
73-
7498
SMTP_HOST=smtp.gmail.com
7599
SMTP_PORT=587
76100
SMTP_USERNAME=your-email@gmail.com
77101
SMTP_PASSWORD=your-app-password-here
78102
SMTP_USE_TLS=true
103+
104+
# Email sender information
79105
FROM_EMAIL=noreply@chronicle.ai
80106
FROM_NAME=Chronicle AI

0 commit comments

Comments
 (0)