feat: 增加 MONGODB_URI 的配置项,并将所有env文件的注释单独放在一行(python的dotenv有时无法正确处理行内注释)
This commit is contained in:
@@ -1,8 +1,9 @@
|
||||
# 🔧 配置指南 喵~
|
||||
|
||||
## 👋 你好呀!
|
||||
## 👋 你好呀
|
||||
|
||||
让咱来告诉你我们要做什么喵:
|
||||
|
||||
1. 我们要一起设置一个可爱的AI机器人
|
||||
2. 这个机器人可以在QQ上陪你聊天玩耍哦
|
||||
3. 需要设置两个文件才能让机器人工作呢
|
||||
@@ -10,16 +11,19 @@
|
||||
## 📝 需要设置的文件喵
|
||||
|
||||
要设置这两个文件才能让机器人跑起来哦:
|
||||
|
||||
1. `.env.prod` - 这个文件告诉机器人要用哪些AI服务呢
|
||||
2. `bot_config.toml` - 这个文件教机器人怎么和你聊天喵
|
||||
|
||||
## 🔑 密钥和域名的对应关系
|
||||
|
||||
想象一下,你要进入一个游乐园,需要:
|
||||
|
||||
1. 知道游乐园的地址(这就是域名 base_url)
|
||||
2. 有入场的门票(这就是密钥 key)
|
||||
|
||||
在 `.env.prod` 文件里,我们定义了三个游乐园的地址和门票喵:
|
||||
|
||||
```ini
|
||||
# 硅基流动游乐园
|
||||
SILICONFLOW_KEY=your_key # 硅基流动的门票
|
||||
@@ -35,6 +39,7 @@ CHAT_ANY_WHERE_BASE_URL=https://api.chatanywhere.tech/v1 # ChatAnyWhere的地
|
||||
```
|
||||
|
||||
然后在 `bot_config.toml` 里,机器人会用这些门票和地址去游乐园玩耍:
|
||||
|
||||
```toml
|
||||
[model.llm_reasoning]
|
||||
name = "Pro/deepseek-ai/DeepSeek-R1"
|
||||
@@ -47,9 +52,10 @@ base_url = "SILICONFLOW_BASE_URL" # 还是去硅基流动游乐园
|
||||
key = "SILICONFLOW_KEY" # 用同一张门票就可以啦
|
||||
```
|
||||
|
||||
### 🎪 举个例子喵:
|
||||
### 🎪 举个例子喵
|
||||
|
||||
如果你想用DeepSeek官方的服务,就要这样改:
|
||||
|
||||
```toml
|
||||
[model.llm_reasoning]
|
||||
name = "Pro/deepseek-ai/DeepSeek-R1"
|
||||
@@ -62,7 +68,8 @@ base_url = "DEEP_SEEK_BASE_URL" # 也去DeepSeek游乐园
|
||||
key = "DEEP_SEEK_KEY" # 用同一张DeepSeek门票
|
||||
```
|
||||
|
||||
### 🎯 简单来说:
|
||||
### 🎯 简单来说
|
||||
|
||||
- `.env.prod` 文件就像是你的票夹,存放着各个游乐园的门票和地址
|
||||
- `bot_config.toml` 就是告诉机器人:用哪张票去哪个游乐园玩
|
||||
- 所有模型都可以用同一个游乐园的票,也可以去不同的游乐园玩耍
|
||||
@@ -88,19 +95,25 @@ CHAT_ANY_WHERE_KEY=your_key
|
||||
CHAT_ANY_WHERE_BASE_URL=https://api.chatanywhere.tech/v1
|
||||
|
||||
# 如果你不知道这是什么,那么下面这些不用改,保持原样就好啦
|
||||
HOST=127.0.0.1 # 如果使用Docker部署,需要改成0.0.0.0喵,不然听不见群友讲话了喵
|
||||
# 如果使用Docker部署,需要改成0.0.0.0喵,不然听不见群友讲话了喵
|
||||
HOST=127.0.0.1
|
||||
PORT=8080
|
||||
|
||||
# 这些是数据库设置,一般也不用改呢
|
||||
MONGODB_HOST=127.0.0.1 # 如果使用Docker部署,需要改成数据库容器的名字喵,默认是mongodb喵
|
||||
# 如果使用Docker部署,需要把MONGODB_HOST改成数据库容器的名字喵,默认是mongodb喵
|
||||
MONGODB_HOST=127.0.0.1
|
||||
MONGODB_PORT=27017
|
||||
DATABASE_NAME=MegBot
|
||||
MONGODB_USERNAME = "" # 如果数据库需要用户名,就在这里填写喵
|
||||
MONGODB_PASSWORD = "" # 如果数据库需要密码,就在这里填写呢
|
||||
MONGODB_AUTH_SOURCE = "" # 数据库认证源,一般不用改哦
|
||||
# 数据库认证信息,如果需要认证就取消注释并填写下面三行喵
|
||||
# MONGODB_USERNAME = ""
|
||||
# MONGODB_PASSWORD = ""
|
||||
# MONGODB_AUTH_SOURCE = ""
|
||||
|
||||
# 插件设置喵
|
||||
PLUGINS=["src2.plugins.chat"] # 这里是机器人的插件列表呢
|
||||
# 也可以使用URI连接数据库,取消注释填写在下面这行喵(URI的优先级比上面的高)
|
||||
# MONGODB_URI=mongodb://127.0.0.1:27017/MegBot
|
||||
|
||||
# 这里是机器人的插件列表呢
|
||||
PLUGINS=["src2.plugins.chat"]
|
||||
```
|
||||
|
||||
### 第二个文件:机器人配置 (bot_config.toml)
|
||||
@@ -198,10 +211,12 @@ key = "SILICONFLOW_KEY"
|
||||
- `topic`: 负责理解对话主题的能力呢
|
||||
|
||||
## 🌟 小提示
|
||||
|
||||
- 如果你刚开始使用,建议保持默认配置呢
|
||||
- 不同的模型有不同的特长,可以根据需要调整它们的使用比例哦
|
||||
|
||||
## 🌟 小贴士喵
|
||||
|
||||
- 记得要好好保管密钥(key)哦,不要告诉别人呢
|
||||
- 配置文件要小心修改,改错了机器人可能就不能和你玩了喵
|
||||
- 如果想让机器人更聪明,可以调整 personality 里的设置呢
|
||||
@@ -209,6 +224,7 @@ key = "SILICONFLOW_KEY"
|
||||
- QQ群号和QQ号都要用数字填写,不要加引号哦(除了机器人自己的QQ号)
|
||||
|
||||
## ⚠️ 注意事项
|
||||
|
||||
- 这个机器人还在测试中呢,可能会有一些小问题喵
|
||||
- 如果不知道怎么改某个设置,就保持原样不要动它哦~
|
||||
- 记得要先有AI服务的密钥,不然机器人就不能和你说话了呢
|
||||
|
||||
@@ -3,6 +3,7 @@
|
||||
## 简介
|
||||
|
||||
本项目需要配置两个主要文件:
|
||||
|
||||
1. `.env.prod` - 配置API服务和系统环境
|
||||
2. `bot_config.toml` - 配置机器人行为和模型
|
||||
|
||||
@@ -10,7 +11,8 @@
|
||||
|
||||
`.env.prod`和`bot_config.toml`中的API配置关系如下:
|
||||
|
||||
### 在.env.prod中定义API凭证:
|
||||
### 在.env.prod中定义API凭证
|
||||
|
||||
```ini
|
||||
# API凭证配置
|
||||
SILICONFLOW_KEY=your_key # 硅基流动API密钥
|
||||
@@ -23,7 +25,8 @@ CHAT_ANY_WHERE_KEY=your_key # ChatAnyWhere API密钥
|
||||
CHAT_ANY_WHERE_BASE_URL=https://api.chatanywhere.tech/v1 # ChatAnyWhere API地址
|
||||
```
|
||||
|
||||
### 在bot_config.toml中引用API凭证:
|
||||
### 在bot_config.toml中引用API凭证
|
||||
|
||||
```toml
|
||||
[model.llm_reasoning]
|
||||
name = "Pro/deepseek-ai/DeepSeek-R1"
|
||||
@@ -32,6 +35,7 @@ key = "SILICONFLOW_KEY" # 引用.env.prod中定义的密钥
|
||||
```
|
||||
|
||||
如需切换到其他API服务,只需修改引用:
|
||||
|
||||
```toml
|
||||
[model.llm_reasoning]
|
||||
name = "Pro/deepseek-ai/DeepSeek-R1"
|
||||
@@ -42,6 +46,7 @@ key = "DEEP_SEEK_KEY" # 使用DeepSeek密钥
|
||||
## 配置文件详解
|
||||
|
||||
### 环境配置文件 (.env.prod)
|
||||
|
||||
```ini
|
||||
# API配置
|
||||
SILICONFLOW_KEY=your_key
|
||||
@@ -52,22 +57,29 @@ CHAT_ANY_WHERE_KEY=your_key
|
||||
CHAT_ANY_WHERE_BASE_URL=https://api.chatanywhere.tech/v1
|
||||
|
||||
# 服务配置
|
||||
HOST=127.0.0.1 # 如果使用Docker部署,需要改成0.0.0.0,否则QQ消息无法传入
|
||||
# 如果使用Docker部署,需要改成0.0.0.0,否则QQ消息无法传入
|
||||
HOST=127.0.0.1
|
||||
PORT=8080
|
||||
|
||||
# 数据库配置
|
||||
MONGODB_HOST=127.0.0.1 # 如果使用Docker部署,需要改成数据库容器的名字,默认是mongodb
|
||||
# 如果使用Docker部署,需要改成数据库容器的名字,默认是mongodb
|
||||
MONGODB_HOST=127.0.0.1
|
||||
MONGODB_PORT=27017
|
||||
DATABASE_NAME=MegBot
|
||||
MONGODB_USERNAME = "" # 数据库用户名
|
||||
MONGODB_PASSWORD = "" # 数据库密码
|
||||
MONGODB_AUTH_SOURCE = "" # 认证数据库
|
||||
# 数据库认证信息,如果需要认证就取消注释并填写下面三行
|
||||
# MONGODB_USERNAME = ""
|
||||
# MONGODB_PASSWORD = ""
|
||||
# MONGODB_AUTH_SOURCE = ""
|
||||
|
||||
# 也可以使用URI连接数据库,取消注释填写在下面这行(URI的优先级比上面的高)
|
||||
# MONGODB_URI=mongodb://127.0.0.1:27017/MegBot
|
||||
|
||||
# 插件配置
|
||||
PLUGINS=["src2.plugins.chat"]
|
||||
```
|
||||
|
||||
### 机器人配置文件 (bot_config.toml)
|
||||
|
||||
```toml
|
||||
[bot]
|
||||
qq = "机器人QQ号" # 必填
|
||||
|
||||
13
template.env
13
template.env
@@ -5,13 +5,18 @@ PORT=8080
|
||||
PLUGINS=["src2.plugins.chat"]
|
||||
|
||||
# 默认配置
|
||||
MONGODB_HOST=127.0.0.1 # 如果工作在Docker下,请改成 MONGODB_HOST=mongodb
|
||||
# 如果工作在Docker下,请改成 MONGODB_HOST=mongodb
|
||||
MONGODB_HOST=127.0.0.1
|
||||
MONGODB_PORT=27017
|
||||
DATABASE_NAME=MegBot
|
||||
|
||||
MONGODB_USERNAME = "" # 默认空值
|
||||
MONGODB_PASSWORD = "" # 默认空值
|
||||
MONGODB_AUTH_SOURCE = "" # 默认空值
|
||||
# 也可以使用 URI 连接数据库(优先级比上面的高)
|
||||
# MONGODB_URI=mongodb://127.0.0.1:27017/MegBot
|
||||
|
||||
# MongoDB 认证信息,若需要认证,请取消注释以下三行并填写正确的信息
|
||||
# MONGODB_USERNAME=user
|
||||
# MONGODB_PASSWORD=password
|
||||
# MONGODB_AUTH_SOURCE=admin
|
||||
|
||||
#key and url
|
||||
CHAT_ANY_WHERE_BASE_URL=https://api.chatanywhere.tech/v1
|
||||
|
||||
Reference in New Issue
Block a user