Update template.env

template.env

@@ -1,35 +1,105 @@
-BASE_URL=example.com
-PORT=10450
-API_KEY=examplekey
-TEMPLATE_LANGUAGE=
+# Required Variables
+# The base url of the server. example: `example.com`
+BASE_URL=
+
+# The token of the telegram bot.
 TELEGRAM_BOT_TOKEN=
-X_RAPIDAPI_KEY=
-DOWNLOAD_DIR=/tmp
+
+# The chat id of the telegram bot.
+TELEGRAM_CHAT_ID=
+
+# Optional Variables
+
+# FastAPI
+# Default: `10450`
+PORT=10450
+
+# 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
-TELEBOT_DEBUG_CHANNEL=
-# separate by comma
+
+# The channel id of the telegram bot. Default: `None`
 TELEGRAM_CHANNEL_ID=
-# separate by comma
+
+# 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=
+
+# OpenAI
+# The api key of OpenAI. Default: `None`
 OPENAI_API_KEY=
-AWS_S3_BUCKET_NAME=
-AWS_REGION_NAME=
+
+# 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=
-XIAOHONGSHU_A1=
-XIAOHONGSHU_WEBID=
-XIAOHONGSHU_WEBSESSION=
 REDDIT_CLIENT_ID=
 REDDIT_CLIENT_SECRET=
 REDDIT_PASSWORD=
 REDDIT_USERNAME=
-FXZHIHU_HOST=
+FXZHIHU_HOST=