diff --git a/README-EN.md b/README-EN.md index ba6fb20..26cd034 100644 --- a/README-EN.md +++ b/README-EN.md @@ -296,22 +296,32 @@ Copy the `.env.example` file in the project root directory to `.env` Edit the `.env` file and fill in your API keys (you can also choose your own models and search proxies; see the `.env.example` file in the project root directory or the `config.py` file for details): -```python -# MySQL Database Configuration -DB_HOST = "localhost" -DB_PORT = 3306 -DB_USER = "your_username" -DB_PASSWORD = "your_password" -DB_NAME = "your_db_name" -DB_CHARSET = "utf8mb4" +```yml +# ====================== Database Configuration ====================== +# Database host, e.g., localhost or 127.0.0.1 +DB_HOST=your_db_host +# Database port number, default is 3306 +DB_PORT=3306 +# Database username +DB_USER=your_db_user +# Database password +DB_PASSWORD=your_db_password +# Database name +DB_NAME=your_db_name +# Database character set, utf8mb4 is recommended for emoji compatibility +DB_CHARSET=utf8mb4 +# Database type: mysql or postgresql +DB_DIALECT=postgresql # LLM configuration # You can switch each Engine's LLM provider as long as it follows the OpenAI-compatible request format # Insight Agent -INSIGHT_ENGINE_API_KEY = "your_api_key" -INSIGHT_ENGINE_BASE_URL = "https://api.moonshot.cn/v1" -INSIGHT_ENGINE_MODEL_NAME = "kimi-k2-0711-preview" +INSIGHT_ENGINE_API_KEY= +# Insight Agent LLM API BaseUrl, customize API provider +INSIGHT_ENGINE_BASE_URL= +# Insight Agent LLM Model Name, e.g., kimi-k2-0711-preview +INSIGHT_ENGINE_MODEL_NAME= # Media Agent ... ``` diff --git a/README.md b/README.md index 8a2ee3e..5876813 100644 --- a/README.md +++ b/README.md @@ -297,22 +297,32 @@ playwright install chromium 编辑 `.env` 文件,填入您的API密钥(您也可以选择自己的模型、搜索代理,详情见根目录.env.example文件内或根目录config.py中的说明): -```python -# MySQL数据库配置 -DB_HOST = "localhost" -DB_PORT = 3306 -DB_USER = "your_username" -DB_PASSWORD = "your_password" -DB_NAME = "your_db_name" -DB_CHARSET = "utf8mb4" +```yml +# ====================== 数据库配置 ====================== +# 数据库主机,例如localhost 或 127.0.0.1 +DB_HOST=your_db_host +# 数据库端口号,默认为3306 +DB_PORT=3306 +# 数据库用户名 +DB_USER=your_db_user +# 数据库密码 +DB_PASSWORD=your_db_password +# 数据库名称 +DB_NAME=your_db_name +# 数据库字符集,推荐utf8mb4,兼容emoji +DB_CHARSET=utf8mb4 +# 数据库类型mysql或postgresql +DB_DIALECT=postgresql # LLM配置 # 您可以更改每个部分LLM使用的API,只要兼容OpenAI请求格式都可以 # Insight Agent -INSIGHT_ENGINE_API_KEY = "your_api_key" -INSIGHT_ENGINE_BASE_URL = "https://api.moonshot.cn/v1" -INSIGHT_ENGINE_MODEL_NAME = "kimi-k2-0711-preview" +INSIGHT_ENGINE_API_KEY= +# Insight Agent LLM接口BaseUrl,可自定义厂商API +INSIGHT_ENGINE_BASE_URL= +# Insight Agent LLM模型名称,如kimi-k2-0711-preview +INSIGHT_ENGINE_MODEL_NAME= # Media Agent ... ```