HARVEST/.env.example at main · IntegrativeBioinformaticsLab/HARVEST · 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
# HARVEST Environment Variables
# Copy this file to .env and update with your credentials

# ============================================================================
# Email Verification Configuration (OTP)
# ============================================================================
# Enable in config.py: ENABLE_OTP_VALIDATION = True
# Documentation: docs/EMAIL_VERIFICATION_CONFIG_PLAN.md

# ---- SendPulse REST API (Recommended) ----
# Free tier: 15,000 emails/month
# Setup: https://sendpulse.com/ > Settings > API
# Get User ID and Secret from API credentials page

EMAIL_PROVIDER=sendpulse
SENDPULSE_USER_ID=your-sendpulse-user-id-here
SENDPULSE_SECRET=your-sendpulse-secret-here
SMTP_FROM_EMAIL=noreply@yourdomain.com
SMTP_FROM_NAME=HARVEST App

# ---- SendPulse SMTP (Alternative) ----
# Free tier: 12,000 emails/month
# Use this if you prefer SMTP over REST API

# EMAIL_PROVIDER=sendpulse_smtp
# SENDPULSE_SMTP_USERNAME=your-sendpulse-email@example.com
# SENDPULSE_SMTP_PASSWORD=your-sendpulse-password
# SMTP_FROM_EMAIL=noreply@yourdomain.com
# SMTP_FROM_NAME=HARVEST App

# ---- Gmail SMTP ----
# Free tier: 500 emails/day
# Requires App Password (not regular Gmail password)
# Setup: https://support.google.com/accounts/answer/185833

# EMAIL_PROVIDER=gmail
# GMAIL_USERNAME=your@gmail.com
# GMAIL_APP_PASSWORD=your-16-char-app-password
# SMTP_FROM_EMAIL=your@gmail.com
# SMTP_FROM_NAME=HARVEST App

# ---- SendGrid SMTP ----
# Free tier: 100 emails/day
# Setup: https://sendgrid.com/ > Settings > API Keys

# EMAIL_PROVIDER=sendgrid
# SENDGRID_API_KEY=your-sendgrid-api-key
# SMTP_FROM_EMAIL=verified-sender@yourdomain.com
# SMTP_FROM_NAME=HARVEST App

# ---- AWS SES ----
# Pay per email (~$0.10 per 1,000 emails)
# Setup: https://aws.amazon.com/ses/ > SMTP Settings

# EMAIL_PROVIDER=aws_ses
# AWS_SES_SMTP_HOST=email-smtp.us-east-1.amazonaws.com
# AWS_SES_SMTP_USERNAME=your-aws-ses-username
# AWS_SES_SMTP_PASSWORD=your-aws-ses-password
# SMTP_FROM_EMAIL=verified-email@yourdomain.com
# SMTP_FROM_NAME=HARVEST App

# ---- Custom SMTP ----
# For institutional or custom SMTP servers

# EMAIL_PROVIDER=custom
# CUSTOM_SMTP_HOST=smtp.youruniversity.edu
# CUSTOM_SMTP_PORT=587
# CUSTOM_SMTP_USE_SSL=false
# CUSTOM_SMTP_USE_TLS=true
# CUSTOM_SMTP_USERNAME=your-username
# CUSTOM_SMTP_PASSWORD=your-password
# SMTP_FROM_EMAIL=noreply@youruniversity.edu
# SMTP_FROM_NAME=HARVEST App

# ============================================================================
# ASReview Service Configuration (Literature Review)
# ============================================================================
# Enable in config.py: ENABLE_LITERATURE_REVIEW = True
# Documentation: docs/LITERATURE_REVIEW.md

# ASREVIEW_SERVICE_URL=http://asreview-server:5275
# ASREVIEW_API_KEY=your-api-key-if-required

# ============================================================================
# NCBI API Key (Optional, for Metapub PDF downloads)
# ============================================================================
# Sign up: https://www.ncbi.nlm.nih.gov/account/
# Enable in config.py: ENABLE_METAPUB_FALLBACK = True

# NCBI_API_KEY=your-ncbi-api-key-here

# ============================================================================
# Database Path (Optional Override)
# ============================================================================
# Override default database path from config.py

# DB_PATH=/path/to/custom/harvest.db