.env.example

# PaperFlow environment template.
# Copy this file to .env and fill in the values you need. Anything not set
# falls back to per-provider defaults; with no .env at all, PaperFlow runs
# in deterministic-mock mode so the pipeline is end-to-end testable offline.

# ---------------------------------------------------------------------------
# Provider selection (the only knobs most users will touch)
# ---------------------------------------------------------------------------
# LLM provider: openai | anthropic | ollama | mock
PAPERFLOW_LLM_PROVIDER=openai
PAPERFLOW_LLM_MODEL=

# Embedding provider: openai | sentence_transformers | ollama | hash.
# The template defaults to hash so first-run demos never download local model
# weights. For normal recommendation quality, set PAPERFLOW_EMBED_PROVIDER to
# openai (API embedding) or sentence_transformers (local embedding).
# If using sentence_transformers with BAAI/bge-m3, expect an initial download
# of about 2.3GB.
PAPERFLOW_EMBED_PROVIDER=hash
PAPERFLOW_EMBED_MODEL=
PAPERFLOW_EMBED_DIMENSIONS=

# ---------------------------------------------------------------------------
# OpenAI-compatible API (used when PAPERFLOW_LLM_PROVIDER=openai or
# PAPERFLOW_EMBED_PROVIDER=openai). Any OpenAI-compatible gateway works
# (OpenAI, DashScope, Azure, vLLM, etc.) by setting OPENAI_BASE_URL.
# ---------------------------------------------------------------------------
OPENAI_API_KEY=
OPENAI_BASE_URL=
OPENAI_API_TIMEOUT=60

# ---------------------------------------------------------------------------
# Anthropic API (used when PAPERFLOW_LLM_PROVIDER=anthropic).
# ---------------------------------------------------------------------------
ANTHROPIC_API_KEY=
ANTHROPIC_BASE_URL=
ANTHROPIC_API_TIMEOUT=60

# ---------------------------------------------------------------------------
# Ollama (used when PAPERFLOW_LLM_PROVIDER=ollama or
# PAPERFLOW_EMBED_PROVIDER=ollama). Set OLLAMA_BASE_URL if Ollama is on a
# different host or port.
# ---------------------------------------------------------------------------
OLLAMA_BASE_URL=http://localhost:11434
OLLAMA_API_TIMEOUT=120

# ---------------------------------------------------------------------------
# Optional upstream data sources
# ---------------------------------------------------------------------------
IEEE_API_KEY=
OPENREVIEW_USERNAME=
OPENREVIEW_PASSWORD=
OPENREVIEW_TOKEN=

# ---------------------------------------------------------------------------
# Runtime storage and logging
# ---------------------------------------------------------------------------
DATABASE_PATH=./data/paperflow.db
LOG_LEVEL=INFO
PAPERFLOW_SUPPRESS_HTTP_RETRY_WARNINGS=true
PAPERFLOW_ALLOW_MOCK_PAPERS=false

# Local export roots. Set these four to an upper-level folder. PaperFlow will
# create <root>/<role-name>/{pdf,reading_reports,monthly_reports,topic_index}/.
# PDFs and reading reports are additionally grouped by paper month.
PAPERFLOW_PDF_DIR=./data/exports
PAPERFLOW_READING_REPORTS_DIR=./data/exports
PAPERFLOW_MONTHLY_REPORT_DIR=./data/exports
PAPERFLOW_TOPIC_INDEX_DIR=./data/exports
PAPERFLOW_STORAGE_ROLE_SUBDIR=true
PAPERFLOW_STORAGE_CATEGORY_SUBDIR=true
PAPERFLOW_STORAGE_MONTHLY_SUBDIR=true
PAPERFLOW_WRITE_FEISHU=false

# ---------------------------------------------------------------------------
# Local PaperFlow Wiki
# ---------------------------------------------------------------------------
# Keep runtime events, reading reports, feedback, and drift snapshots mirrored
# into SQLite wiki tables plus Markdown files under PAPERFLOW_WIKI_DIR.
PAPERFLOW_WIKI_INGEST=true
PAPERFLOW_WIKI_DIR=./data/wiki

# ---------------------------------------------------------------------------
# Interest-drift defaults (rarely touched)
# ---------------------------------------------------------------------------
PAPERFLOW_DRIFT_LONG_WINDOW_SIZE=30
PAPERFLOW_DRIFT_LONG_WINDOW_DAYS=60
PAPERFLOW_DRIFT_SHORT_WINDOW_SIZE=8
PAPERFLOW_DRIFT_SHORT_WINDOW_DAYS=14
PAPERFLOW_DRIFT_THRESHOLD=0.35
PAPERFLOW_DRIFT_RECOVER_THRESHOLD=0.20
PAPERFLOW_DRIFT_ALPHA_BASE=0.08
PAPERFLOW_DRIFT_ALPHA_MAX=0.35
PAPERFLOW_TOPIC_DECAY=0.01
PAPERFLOW_AUTHOR_DECAY=0.005
PAPERFLOW_INSTITUTION_DECAY=0.005

# ---------------------------------------------------------------------------
# Feishu / Lark integration (optional).
# Fill this block only if you want Feishu document export or the
# webhook/ngrok bot deployment. Local CLI/GUI users who do not use Feishu can
# leave it empty.
# ---------------------------------------------------------------------------
# FEISHU_APP_ID, FEISHU_APP_SECRET:
#   open.feishu.cn/app -> your app -> Credentials & Basic Info
# FEISHU_VERIFICATION_TOKEN:
#   open.feishu.cn/app -> your app -> Development Config -> Events & Callbacks
#   -> Event Configuration tab -> top "Verification Token" field
# FEISHU_USER_ID (your personal open_id, NOT user_id):
#   easiest: start the webhook, DM the bot once, copy `sender open_id=ou_...`
#   from the local webhook terminal log. It begins with `ou_`.
# FEISHU_CLI_CMD:
#   optional path to lark-cli / lark-cli.cmd, used for Feishu doc creation.
FEISHU_APP_ID=
FEISHU_APP_SECRET=
FEISHU_BOT_NAME=PaperFlow Bot
FEISHU_USER_ID=
FEISHU_CLI_CMD=
FEISHU_IM_IDENTITY=bot
FEISHU_VERIFICATION_TOKEN=

# ngrok tunnel (used by deployments/feishu/webhook-server/start-with-ngrok.py).
# Sign up   : https://dashboard.ngrok.com/signup
# Authtoken : https://dashboard.ngrok.com/get-started/your-authtoken
#             one-time setup -> ngrok config add-authtoken <token>
# Reserve a free static domain (URL never rotates, configure Feishu only once):
#   https://dashboard.ngrok.com/domains
# Then paste the reserved domain into NGROK_DOMAIN below, e.g.
#   NGROK_DOMAIN=paperflow-bot.ngrok-free.app
NGROK_AUTHTOKEN=
NGROK_PATH=
NGROK_DOMAIN=