Ver código fonte

doc: update the container name in doc

yrluke 1 ano atrás
pai
commit
150eec4585

+ 4 - 4
FAQ.md

@@ -24,9 +24,9 @@ As shown, you shall install `docker` first. Try `curl -fLsS https://get.docker.c
 
 As shown, you shall install `docker compose v2`. Try `[Install Docker Compose](https://docs.docker.com/compose/install/)`
 
-### safeline-postgres: Operation not permitted
+### safeline-pg: Operation not permitted
 
-`docker logs -f safeline-postgres` with error `Operation not permitted`
+`docker logs -f safeline-pg` with error `Operation not permitted`
 
 Upgrade your docker engine and retry.
 
@@ -94,9 +94,9 @@ As shown, you shall start docker first. Try `systemctl start docker`.
 
 端口冲突,根据报错信息中的端口号,排查是哪个服务占用了,手动处理冲突。
 
-### safeline-postgres 出现 Operation not permitted
+### safeline-pg 出现 Operation not permitted
 
-`docker logs -f safeline-postgres` 容器日志中看到 `Operation not permitted` 报错
+`docker logs -f safeline-pg` 容器日志中看到 `Operation not permitted` 报错
 
 可能是您的 docker 版本过低,升级 docker 到最新版本尝试一下。
 

+ 2 - 2
documents/docs/03-faq/01-install.md

@@ -61,9 +61,9 @@ security_opt:
   - seccomp=./seccomp.json
 ```
 
-#### 报错:safeline-postgres 出现 Operation not permitted
+#### 报错:safeline-pg 出现 Operation not permitted
 
-`docker logs -f safeline-postgres` 容器日志中看到 `Operation not permitted` 报错。
+`docker logs -f safeline-pg` 容器日志中看到 `Operation not permitted` 报错。
 
 可能是您的 docker 版本过低,升级 docker 到最新版本尝试一下。
 

+ 1 - 1
documents/docs/03-faq/02-login.md

@@ -30,7 +30,7 @@ TOTP 动态口令只有 30 秒的有效期,如果认证失败,请在动态
 命令执行完成后打开雷池页面重新绑定即可。
 
 ```
-docker exec safeline-mgt-api resetadmin
+docker exec safeline-mgt resetadmin
 ```
 
 **注意:重置动态口令后要尽快完成绑定,别被其他人捷足先登了。**

+ 2 - 2
documents/docs/03-faq/06-other.md

@@ -42,7 +42,7 @@ location /xxx {
 **_注意:该操作会清除所有日志信息,且不可恢复_**
 
 ```shell
-docker exec safeline-mgt-api cleanlogs
+docker exec safeline-mgt cleanlogs
 ```
 
 ## 将雷池的日志导出到 XXX
@@ -55,7 +55,7 @@ docker exec safeline-mgt-api cleanlogs
 <source>
   @type sql
 
-  host safeline-postgres // 默认数据库地址,如果在 compose.yml 中改过,请使用改后值
+  host safeline-pg // 默认数据库地址,如果在 compose.yml 中改过,请使用改后值
   port 5432
   database safeline-ce // 数据库名
   adapter postgresql

+ 3 - 4
documents/docs/05-about/03-framework.md

@@ -12,14 +12,13 @@ title: "雷池技术架构"
 
 | 名称              | 定义         | 详情                                                    |
 | ----------------- | ------------ | ------------------------------------------------------- |
-| safeline-mgt-api  | 管理容器     | 接收管理后台行为,向其他服务或容器推送消息              |
+| safeline-mgt  | 管理容器     | 接收管理后台行为,向其他服务或容器推送消息              |
 | safeline-detector | 检测容器     | 执行检测的容器,从 Tengine 进入的流量会转发到该节点检测 |
 | safeline-mario    | 日志容器     | 记录与统计恶意行为的节点                                |
 | safeline-tengine  | 网关         | 转发网关,有简单的过滤功能                              |
-| safeline-postgres | 关系型数据库 | 存储攻击日志、保护站点、黑白名单配置的数据库            |
-| safeline-redis    | 缓存数据库   | -                                                       |
+| safeline-pg | 关系型数据库 | 存储攻击日志、保护站点、黑白名单配置的数据库            |
 
-对于后台管理人员,可以直接通信的节点为管理服务 `safeline-mgt-api`,该节点负责:
+对于后台管理人员,可以直接通信的节点为管理服务 `safeline-mgt`,该节点负责:
 
 - 向 Tengine 网关推送自定义配置并利用 NGINX 命令进行 reload 热更新
 - 自定义检测规则(黑白名单等)并向检测引擎 `safeline-detector` 推送