template.env

# Required Variables
# The base url of the server. example: `example.com`
BASE_URL=

# The token of the telegram bot.
TELEGRAM_BOT_TOKEN=

# The chat id of the telegram bot.
TELEGRAM_CHAT_ID=

# Telegram Bot Mode: "webhook" or "polling" (default: polling)
# In webhook mode, BASE_URL must route to the telegram-bot service on port 10451
TELEGRAM_BOT_MODE=polling

# Optional Variables

# FastAPI
# Default: `10450`
PORT=10450

# Telegram Bot -> API Server URL (internal Docker network)
# Default: `http://localhost:10450`
API_SERVER_URL=http://api:10450

# API Server -> Telegram Bot callback URL (for Inoreader notifications)
# Default: `http://localhost:10451`
TELEGRAM_BOT_CALLBACK_URL=http://telegram-bot:10451

# The api key for the FastAPI server. It would be generated automatically if not set.
API_KEY=

# Telegram
# The host of the telegram bot api server. Default: `telegram-bot-api`
TELEBOT_API_SERVER_HOST=telegram-bot-api

# The port of the telegram bot api server. Default: `8081`
TELEBOT_API_SERVER_PORT=8081

# The channel id of the telegram bot. Default: `None`
TELEGRAM_CHANNEL_ID=

# The id list of the users who can send message to targeted telegram channel, divided by `,`. 
# You cannot send message to the channel if you are not in the list. Default: `None`
TELEGRAM_CHANNEL_ADMIN_LIST=

# Twitter
# The ct0 cookie of twitter. Default: `None`
TWITTER_CT0=

# The auth token of twitter. Default: `None`
TWITTER_AUTH_TOKEN=

# Reddit
# The client id of reddit. Default: `None`
REDDIT_CLIENT_ID=

# The client secret of reddit. Default: `None`
REDDIT_CLIENT_SECRET=

# The username of reddit. Default: `None`
REDDIT_USERNAME=

# The password of reddit. Default: `None`
REDDIT_PASSWORD=

# Weibo
# The cookie of weibo. For some unknown reasons, some weibo posts may be not accessible 
# if you don't are not logged in. Just copy the cookie from your browser and set it. Default: `None`
WEIBO_COOKIES=

# Xiaohongshu
# The a1 cookie of xiaohongshu. Default: `None`
XIAOHONGSHU_A1=

# The webid cookie of xiaohongshu. Default: `None`
XIAOHONGSHU_WEBID=

# The websession cookie of xiaohongshu. Default: `None`
XIAOHONGSHU_WEBSESSION=

# XHS Sign Server URL for the signing proxy. Default: `http://localhost:8989`
SIGN_SERVER_URL=

# Path to a file containing XHS cookies as a single-line string.
# Default: conf/xhs_cookies.txt (relative to apps/api). Override with an absolute path if needed.
# Takes priority over XIAOHONGSHU_A1/WEBID/WEBSESSION when the file exists.
XHS_COOKIE_PATH=

# OpenAI
# The api key of OpenAI. Default: `None`
OPENAI_API_KEY=

# Amazon S3 Picture Storage
# The access key id of Amazon S3. Default: `None`
AWS_ACCESS_KEY_ID=

# The secret access key of Amazon S3. Default: `None`
AWS_SECRET_ACCESS_KEY=

# The bucket name of Amazon S3. Default: `None`
AWS_S3_BUCKET_NAME=

# The region name of Amazon S3. Default: `None`
AWS_S3_REGION_NAME=

# The domain bound to the bucket. The picture upload function would generate images url 
# by bucket name if customized host not set. Default: `None`
AWS_DOMAIN_HOST=


PORT=10450
API_KEY=examplekey
TEMPLATE_LANGUAGE=
X_RAPIDAPI_KEY=
DOWNLOAD_DIR=/tmp
INOREADER_APP_ID=
INOREADER_APP_KEY=
INOREADER_EMAIL=
INOREADER_PASSWORD=
XHS_PHONE_LIST=
REDDIT_CLIENT_ID=
REDDIT_CLIENT_SECRET=
REDDIT_PASSWORD=
REDDIT_USERNAME=
FXZHIHU_HOST=

# Zhihu z_c0 cookie for direct API authentication. Extract from browser cookies.
# Takes priority over conf/zhihu_cookies.json when set.
ZHIHU_Z_C0=

# General Webpage Scraping
# Enable general webpage scraping for unrecognized URLs. Default: `false`
GENERAL_SCRAPING_ON=false

# The scraping API backend to use. Options: `FIRECRAWL`, `ZYTE`. Default: `FIRECRAWL`
GENERAL_SCRAPING_API=FIRECRAWL

# Firecrawl API
# The URL of the Firecrawl API server. Default: ``
FIRECRAWL_API_URL=

# The API key for Firecrawl. Default: ``
FIRECRAWL_API_KEY=

# Time in milliseconds to wait for JS rendering before scraping. Default: `3000`
FIRECRAWL_WAIT_FOR=3000

# Use Firecrawl's built-in LLM JSON extraction instead of markdown+HTML+OpenAI pipeline. Default: `false`
FIRECRAWL_USE_JSON_EXTRACTION=false

# Zyte API
# The API key for Zyte. Default: `None`
ZYTE_API_KEY=

# User Settings Database
# SQLAlchemy async database URL for user settings.
# SQLite (default): sqlite+aiosqlite:///data/fastfetchbot.db
# PostgreSQL: postgresql+asyncpg://user:password@host:5432/dbname
SETTINGS_DATABASE_URL=sqlite+aiosqlite:///data/fastfetchbot.db

# MongoDB (Scraped Content Cache)
# Enable MongoDB storage and caching of scraped metadata. Default: `false`
DATABASE_ON=false

# Cache TTL in seconds. Cached results older than this are re-scraped.
# Set to 0 to never expire (always use cache). Default: `86400` (24 hours)
DATABASE_CACHE_TTL=86400

# MongoDB host. Default: `localhost`. Use `mongodb` in Docker.
MONGODB_HOST=localhost

# MongoDB port. Default: `27017`
MONGODB_PORT=27017

# MongoDB credentials (used by async worker to build the connection URL).
# Leave empty for unauthenticated connections.
MONGODB_USERNAME=
MONGODB_PASSWORD=

# Full MongoDB connection URI. Overrides MONGODB_HOST/PORT/USERNAME/PASSWORD if set.
# Example: mongodb://user:password@host:27017
MONGODB_URL=

# Celery Worker
# Redis URL for Celery message broker. Default: `redis://localhost:6379/0`
CELERY_BROKER_URL=redis://redis:6379/0

# Redis URL for Celery result backend. Default: `redis://localhost:6379/1`
CELERY_RESULT_BACKEND=redis://redis:6379/1

# Async Scraping Worker (ARQ)
# Scrape mode: "api" (sync via API server) or "queue" (async via ARQ worker). Default: `api`
SCRAPE_MODE=api

# Redis URL for ARQ task queue. Default: `redis://localhost:6379/2`
ARQ_REDIS_URL=redis://redis:6379/2

# Redis URL for the result outbox. Default: `redis://localhost:6379/3`
OUTBOX_REDIS_URL=redis://redis:6379/3