-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy path.env.example
More file actions
196 lines (166 loc) · 9.88 KB
/
.env.example
File metadata and controls
196 lines (166 loc) · 9.88 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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
# OpenTask Environment Configuration
# Docker: add variables to .env (loaded via env_file in docker-compose.yml)
# Bare metal: copy this file to .env.local and fill in your values.
# ═══════════════════════════════════════════════════════════════
# REQUIRED
# ═══════════════════════════════════════════════════════════════
# Session secret key — generate with: openssl rand -base64 32
AUTH_SECRET=your-secret-key-here
# ═══════════════════════════════════════════════════════════════
# OPTIONAL — Common Settings
# ═══════════════════════════════════════════════════════════════
# Custom database path (default: ./data/tasks.db)
# OPENTASK_DB_PATH=/path/to/tasks.db
# Base URL for the app (set when behind a reverse proxy)
# AUTH_URL=http://localhost:3000
# Data retention periods (all in days)
# OPENTASK_RETENTION_UNDO_DAYS=30 # Undo log (default: 30)
# OPENTASK_RETENTION_TRASH_DAYS=30 # Trash (default: 30)
# OPENTASK_RETENTION_COMPLETIONS_DAYS=30 # Completion records (default: 30)
# OPENTASK_RETENTION_STATS_DAYS=365 # Daily stats (default: 365)
# ═══════════════════════════════════════════════════════════════
# OPTIONAL — AI Features
# ═══════════════════════════════════════════════════════════════
# AI is entirely optional. When disabled (the default), all AI
# UI elements are hidden and no AI code runs.
# OPENTASK_AI_ENABLED=false
# Global AI provider: 'anthropic', 'openai', or 'sdk'
# Used as the default when per-feature provider is not set.
# Auto-detected from which API key is set if not specified.
# OPENTASK_AI_PROVIDER=anthropic
# Global API keys (used by all features unless overridden per-feature)
# ANTHROPIC_API_KEY=sk-ant-...
# OPENAI_API_KEY=sk-...
# OPENAI_BASE_URL=https://api.openai.com/v1 # Change for non-OpenAI endpoints
# Per-feature API model (required for API mode — provider-specific model names)
# OPENTASK_AI_ENRICHMENT_MODEL=claude-haiku-4-5-20251001
# OPENTASK_AI_QUICKTAKE_MODEL=claude-haiku-4-5-20251001
# OPENTASK_AI_WHATS_NEXT_MODEL=claude-haiku-4-5-20251001
# OPENTASK_AI_INSIGHTS_MODEL=claude-haiku-4-5-20251001
# SDK model (used for SDK mode — Claude model names only, default: sonnet)
# OPENTASK_AI_SDK_MODEL=sonnet # Global default for all SDK features
# OPENTASK_AI_ENRICHMENT_SDK_MODEL=sonnet # Per-feature override
# OPENTASK_AI_QUICKTAKE_SDK_MODEL=haiku # Per-feature override
# OPENTASK_AI_WHATS_NEXT_SDK_MODEL=sonnet # Per-feature override
# OPENTASK_AI_INSIGHTS_SDK_MODEL=sonnet # Per-feature override
# Per-feature provider routing (optional — override global provider per feature)
# Each feature can independently target a different API provider/key/URL.
# OPENTASK_AI_ENRICHMENT_PROVIDER=anthropic
# OPENTASK_AI_ENRICHMENT_API_KEY=sk-ant-...
# OPENTASK_AI_ENRICHMENT_BASE_URL=
# OPENTASK_AI_QUICKTAKE_PROVIDER=anthropic
# OPENTASK_AI_QUICKTAKE_API_KEY=
# OPENTASK_AI_QUICKTAKE_BASE_URL=
# OPENTASK_AI_WHATS_NEXT_PROVIDER=openai
# OPENTASK_AI_WHATS_NEXT_API_KEY=xai-...
# OPENTASK_AI_WHATS_NEXT_BASE_URL=https://api.x.ai/v1
# OPENTASK_AI_INSIGHTS_PROVIDER=openai
# OPENTASK_AI_INSIGHTS_API_KEY=
# OPENTASK_AI_INSIGHTS_BASE_URL=
# Max queries per warm enrichment subprocess before recycling (default: 8)
# OPENTASK_AI_MAX_REUSES=8
# SDK query timeout in ms (default: 60000)
# OPENTASK_AI_QUERY_TIMEOUT_MS=60000
# Max concurrent SDK subprocesses (default: 4)
# OPENTASK_AI_MAX_CONCURRENT=4
# Max wait time for a semaphore slot in ms (default: 30000)
# OPENTASK_AI_QUEUE_TIMEOUT_MS=30000
# Path to Claude Code CLI (only needed in standalone/bundled builds)
# OPENTASK_AI_CLI_PATH=/path/to/claude-code/cli.js
# AI activity log retention in days (default: 90)
# OPENTASK_RETENTION_AI_ACTIVITY_DAYS=90
# --- AI Quick-Start Examples ---
#
# Option A: Anthropic API
# OPENTASK_AI_ENABLED=true
# ANTHROPIC_API_KEY=sk-ant-api03-...
# OPENTASK_AI_ENRICHMENT_MODEL=claude-haiku-4-5-20251001
# OPENTASK_AI_QUICKTAKE_MODEL=claude-haiku-4-5-20251001
# OPENTASK_AI_WHATS_NEXT_MODEL=claude-haiku-4-5-20251001
# OPENTASK_AI_INSIGHTS_MODEL=claude-haiku-4-5-20251001
#
# Option B: xAI (Grok)
# OPENTASK_AI_ENABLED=true
# OPENAI_API_KEY=xai-...
# OPENAI_BASE_URL=https://api.x.ai/v1
# OPENTASK_AI_ENRICHMENT_MODEL=grok-4-1-fast-non-reasoning
# OPENTASK_AI_QUICKTAKE_MODEL=grok-4-1-fast-non-reasoning
# OPENTASK_AI_WHATS_NEXT_MODEL=grok-4-1-fast-non-reasoning
# OPENTASK_AI_INSIGHTS_MODEL=grok-4-1-fast-non-reasoning
#
# Option C: Mixed providers (enrichment on Anthropic, insights on Grok)
# OPENTASK_AI_ENABLED=true
# ANTHROPIC_API_KEY=sk-ant-...
# OPENTASK_AI_ENRICHMENT_PROVIDER=anthropic
# OPENTASK_AI_ENRICHMENT_MODEL=claude-haiku-4-5-20251001
# OPENTASK_AI_QUICKTAKE_PROVIDER=anthropic
# OPENTASK_AI_QUICKTAKE_MODEL=claude-haiku-4-5-20251001
# OPENTASK_AI_WHATS_NEXT_PROVIDER=openai
# OPENTASK_AI_WHATS_NEXT_API_KEY=xai-...
# OPENTASK_AI_WHATS_NEXT_BASE_URL=https://api.x.ai/v1
# OPENTASK_AI_WHATS_NEXT_MODEL=grok-4-1-fast-non-reasoning
# OPENTASK_AI_INSIGHTS_PROVIDER=openai
# OPENTASK_AI_INSIGHTS_API_KEY=xai-...
# OPENTASK_AI_INSIGHTS_BASE_URL=https://api.x.ai/v1
# OPENTASK_AI_INSIGHTS_MODEL=grok-4-1-fast-non-reasoning
#
# Option D: Claude Code SDK (no API key needed — uses your Claude Code auth)
# OPENTASK_AI_ENABLED=true
# OPENTASK_AI_SDK_MODEL=sonnet # All SDK features use Sonnet
# OPENTASK_AI_QUICKTAKE_SDK_MODEL=haiku # Quick take uses cheaper model
#
# Option E: Mixed SDK + API (SDK for some users, API for others, or mixed per feature)
# OPENTASK_AI_ENABLED=true
# OPENTASK_AI_SDK_MODEL=sonnet # SDK-mode users get Claude Sonnet
# OPENTASK_AI_QUICKTAKE_SDK_MODEL=haiku # SDK quick take uses Haiku
# OPENAI_API_KEY=xai-...
# OPENAI_BASE_URL=https://api.x.ai/v1
# OPENTASK_AI_ENRICHMENT_MODEL=grok-4-1-fast-non-reasoning
# OPENTASK_AI_QUICKTAKE_MODEL=grok-4-1-fast-non-reasoning
# OPENTASK_AI_WHATS_NEXT_MODEL=grok-4-1-fast-non-reasoning
# OPENTASK_AI_INSIGHTS_MODEL=grok-4-1-fast-reasoning
# ═══════════════════════════════════════════════════════════════
# OPTIONAL — Push Notifications
# ═══════════════════════════════════════════════════════════════
# Web Push (VAPID keys for browser push notifications)
# Generate with: npx web-push generate-vapid-keys
# VAPID_PUBLIC_KEY=
# VAPID_PRIVATE_KEY=
# VAPID_EMAIL=mailto:you@example.com
# APNs (iOS native app push notifications)
# Requires Apple Developer Program ($99/year) and a p8 key file
# APNS_KEY_ID= # Key ID from Apple Developer portal
# APNS_TEAM_ID= # Team ID from Apple Developer portal
# APNS_KEY_PATH= # Path to .p8 key file (e.g., /path/to/AuthKey_XXXXXXXXXX.p8)
# APNS_BUNDLE_ID= # App bundle ID (e.g., io.mcnitt.opentask)
# ═══════════════════════════════════════════════════════════════
# PRODUCTION ONLY — Not needed for development
# ═══════════════════════════════════════════════════════════════
# Web Analytics (Umami — self-hosted, privacy-focused, cookie-free)
# These are NEXT_PUBLIC_ vars — inlined at build time, not read at runtime.
# Set in .env.local before building; systemd env overrides do NOT work for these.
# NEXT_PUBLIC_UMAMI_WEBSITE_ID= # Website ID from Umami dashboard
# NEXT_PUBLIC_UMAMI_SCRIPT_URL=https://your-umami-instance.example.com # Umami instance URL
# Demo mode: show demo credentials hint on login page and demo banner in-app
# NEXT_PUBLIC_DEMO_MODE=1
# Error alerting via ntfy (mobile push notification)
# Sends a notification for server errors, client JS errors, AI failures, and cron failures.
# Disabled when OPENTASK_NTFY_TOPIC is empty.
# OPENTASK_NTFY_URL=https://ntfy.sh # ntfy server URL (default: ntfy.sh)
# OPENTASK_NTFY_TOPIC= # Topic name (e.g., opentask-errors)
# Demo engagement notifications (Pushover — optional)
# Sends a notification when the demo user interacts with tasks
# OPENTASK_DEMO_PUSHOVER_APP_TOKEN= # Pushover app token
# OPENTASK_DEMO_PUSHOVER_USER_KEY= # Pushover user key
# Docker first-run user creation
# These are used by docker-entrypoint.sh to create the initial user on first start.
# OPENTASK_INIT_USERNAME=admin
# OPENTASK_INIT_PASSWORD=changeme
# OPENTASK_INIT_EMAIL=admin@localhost
# OPENTASK_INIT_TIMEZONE=America/New_York # Required when INIT_USERNAME/PASSWORD are set
# Reverse Proxy Authentication
# Set to the header name your reverse proxy uses to pass the authenticated username.
# Common values: X-Forwarded-User, Remote-User, X-Auth-User
# SECURITY: Your reverse proxy MUST strip this header from external requests.
# If external clients can set this header, they can authenticate as any user.
# OPENTASK_PROXY_AUTH_HEADER=