readme

README.md

@@ -4,7 +4,7 @@
 
 测试版可前往 Release 下载
 
-# 兼容性
+## 兼容性
 
 #### 接口
 - [x] HTTP API
@@ -90,6 +90,31 @@
 
 </details>
 
-# 性能
+## 性能
 
 在关闭数据库的情况下, 加载25个好友128个群运行24小时后内存使用为10MB左右. 开启数据库后内存使用将根据消息量增加10-20MB, 如果系统内存小于128M建议关闭数据库使用. 
+
+## Docker 镜像
+
+本项目的 Docker 镜像位于 `nanahira/go-cqhttp` 。可以直接 pull 之后使用。
+
+## 端口
+
+以下端口使用1个即可，更建议将业务容器和本项目容器放置于同一 `docker-compose.yml` 文件下，直接互通使用。
+
+* `5700` HTTP 端口
+* `6700` websocket 端口
+
+## 数据卷目录
+
+* `/data` 本项目相关数据，也可以直接把 `config.json` 放入该目录进行配置。
+
+## 环境变量
+
+配置方法使用下列环境变量**或** `config.json` 文件均可。
+
+* `UIN` QQ 号。
+* `PASS` QQ 密码。
+* `HTTP_POST` 后端路径。
+* `HTTP_SECRET` 后端密钥。这两个环境变量若使用 websocket 则不必需。
+* `DEBUG` 若为 `true` 则输出更多的调试信息。