From af9782bda668090ee3f09b6ad39e83fe6df08c3c Mon Sep 17 00:00:00 2001 From: qiaofeng1227 <76487013@qq.com> Date: Tue, 30 May 2023 17:04:58 +0800 Subject: [PATCH] edit docs --- README.md | 7 +++++++ docs/administrator.md | 2 +- docs/architecture.md | 3 --- docs/developer.md | 2 +- 4 files changed, 9 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index d4bc14e8..617bb457 100644 --- a/README.md +++ b/README.md @@ -41,3 +41,10 @@ wget -N https://websoft9.github.io/StackHub/scripts/install.sh; bash install.sh sudo su # when you have no root privileges curl https://websoft9.github.io/StackHub/install/install.sh | bash ``` + +## Upgrade + +``` +sudo su # when you have no root privileges +curl https://websoft9.github.io/StackHub/install/update.sh | bash +``` diff --git a/docs/administrator.md b/docs/administrator.md index 243c8939..cd19bd0c 100644 --- a/docs/administrator.md +++ b/docs/administrator.md @@ -24,7 +24,7 @@ StackHub 的 release 的版本号由项目主版本号和各微服务和插件 ## 日志 -Appmanage 日志采用 logging 生成,按自然日分割日志文件。日志路径:/var/lib/docker/volumes/w9appmanage_logs/\_data +Appmanage 日志采用 logging 生成,按自然日分割日志文件。日志路径:/var/lib/docker/volumes/w9appmanage_logs/\_data 其他微服务采用 Dockhub 公开镜像,用 docker 容器的日志访问命令即可查看。 ## 更新与升级 diff --git a/docs/architecture.md b/docs/architecture.md index 7757adcb..5f01ce6f 100644 --- a/docs/architecture.md +++ b/docs/architecture.md @@ -2,7 +2,6 @@ ![image](https://github.com/Websoft9/StackHub/assets/43192516/3b52f27a-8dff-477b-acea-cf971096540c) - ## 详细 ### 微服务 @@ -18,8 +17,6 @@ - API gateway: Kong(待定) - CLI(待定) -![image](https://user-images.githubusercontent.com/16741975/216497356-3913abd2-0b75-4619-8c40-512079e35f5b.png) - ### 基础组件 技术选型如下: diff --git a/docs/developer.md b/docs/developer.md index facec756..ce32e1a9 100644 --- a/docs/developer.md +++ b/docs/developer.md @@ -71,6 +71,6 @@ cancel_jobs = cancel.get_job_ids() [FastAPI 文档](https://github.com/Websoft9/StackHub/blob/main/appmanage/docs/developer.md) 使用 swagger 自动生成,访问地址:http://IP:PORT/docs。 -### Cockpit 插件 +## Cockpit 插件 待补充。。。