Browse Source

update readme

eryajf 2 years ago
parent
commit
7241fcf6c1
3 changed files with 13 additions and 13 deletions
  1. 7 7
      README.md
  2. 3 3
      config.example.yml
  3. 3 3
      docker-compose.yml

+ 7 - 7
README.md

@@ -155,7 +155,7 @@ $ docker run -itd --name chatgpt -p 8090:8090 -v ./data:/app/data --add-host="ho
 `📢 注意:`如果使用docker部署,那么proxy地址可以直接使用如上方式部署,`host.docker.internal`会指向容器所在宿主机的IP,只需要更改端口为你的代理端口即可。参见:[Docker容器如何优雅地访问宿主机网络](https://wiki.eryajf.net/pages/674f53/)
 
 
-运行命令中映射的配置文件参考下边的配置文件说明。
+运行命令中映射的配置文件参考下边的[配置文件说明](#%E9%85%8D%E7%BD%AE%E6%96%87%E4%BB%B6%E8%AF%B4%E6%98%8E)
 
 ```
 第二种:基于配置文件挂载运行
@@ -355,14 +355,14 @@ port: "8090"
 service_url: "http://chat.eryajf.net"
 # 限定对话类型 0:不限 1:只能单聊 2:只能群聊
 chat_type: "0"
-# 哪些群组可以进行对话,如果留空,则表示允许所有群组,对话聊天是,如下三个满足其一即可通过校验
+# 哪些群组可以进行对话,如果留空,则表示允许所有群组,如果要限制,则写群组的名称,比如 ["aa","bb"]
+# 对话聊天时,如下三个满足其一即可通过校验
 allow_groups:
   - "学无止境"
-# 哪些用户可以进行对话,如果留空,则表示允许所有用户
-allow_users:
-  - "xxx"
-# 指定哪些人为此系统的管理员,如果留空,则表示没有人是管理员
-admin_users:
+# 哪些用户可以进行对话,如果留空,则表示允许所有用户,如果要限制,则列表中写用户的名称,比如 ["张三","李四"]
+allow_users: ["张三","李四"]
+# 指定哪些人为此系统的管理员,如果留空,则表示没有人是管理员,如果要限制,则列表中写用户的名称,比如 ["张三","李四"]
+admin_users: []
 ```
 
 ## 常见问题

+ 3 - 3
config.example.yml

@@ -18,9 +18,9 @@ port: "8090"
 service_url: "http://xxxxxx"
 # 限定对话类型 0:不限 1:只能单聊 2:只能群聊
 chat_type: "0"
-# 哪些群组可以进行对话,如果留空,则表示允许所有群组
+# 哪些群组可以进行对话,如果留空,则表示允许所有群组,如果要限制,则列表中写群组的名称,比如 ["aa","bb"]
 allow_groups: []
-# 哪些用户可以进行对话,如果留空,则表示允许所有用户
+# 哪些用户可以进行对话,如果留空,则表示允许所有用户,如果要限制,则列表中写用户的名称,比如 ["张三","李四"]
 allow_users: []
-# 指定哪些人为此系统的管理员,如果留空,则表示没有人是管理员
+# 指定哪些人为此系统的管理员,如果留空,则表示没有人是管理员,如果要限制,则列表中写用户的名称,比如 ["张三","李四"]
 admin_users: []

+ 3 - 3
docker-compose.yml

@@ -16,9 +16,9 @@ services:
       PORT: 8090 # 指定服务启动端口,默认为 8090,容器化部署时,不需要调整,一般在二进制宿主机部署时,遇到端口冲突时使用
       SERVICE_URL: ""  # 指定服务的地址,就是当前服务可供外网访问的地址(或者直接理解为你配置在钉钉回调那里的地址),用于生成图片时给钉钉做渲染
       CHAT_TYPE: "0" # 限定对话类型 0:不限 1:只能单聊 2:只能群聊
-      ALLOW_GROUPS: "学无止境,技术群" # 哪些群组可以进行对话,如果留空,则表示允许所有群组,如果有多个,则用英文逗号分割,docker-compose的语法不支持变量的值为数组
-      ALLOW_USERS: "xxx" # 哪些用户可以进行对话,如果留空,则表示允许所有用户,如果有多个,则用英文逗号分割
-      ADMIN_USERS: "" # 指定哪些人为此系统的管理员,如果留空,则表示没有人是管理员
+      ALLOW_GROUPS: "" # 哪些群组可以进行对话,如果留空,则表示允许所有群组,如果要限制,则填写群组的名字,比如 "aa,bb"
+      ALLOW_USERS: "" # 哪些用户可以进行对话,如果留空,则表示允许所有用户,如果要限制,则填写用户的名字,比如 "张三,李四"
+      ADMIN_USERS: "" # 指定哪些人为此系统的管理员,如果留空,则表示没有人是管理员,如果要限制,则填写用户的名字,比如 "张三,李四"
     volumes:
       - ./data:/app/data
     ports: