diff --git a/README.md b/README.md index 61999f94..faec9c93 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ `orion-ops` 一站式自动化运维及自动化部署平台, 使用多环境的概念, 提供了机器管理、机器监控报警、Web终端、WebSftp、机器批量执行、机器批量上传、在线查看日志、定时调度任务、应用环境维护、应用构建及发布任务、操作流水线等功能, 帮助企业实现一站式轻量化运维治理, 致力于企业级应用的智能运维。 -
+
diff --git a/docs/README.md b/docs/README.md
index f2cf9dbe..4797119d 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -2,7 +2,7 @@
`orion-ops` 一站式自动化运维及自动化部署平台, 使用多环境的概念, 提供了机器管理、机器监控报警、Web终端、WebSftp、机器批量执行、机器批量上传、在线查看日志、定时调度任务、应用环境维护、应用构建及发布任务、操作流水线等功能, 帮助企业实现一站式轻量化运维治理, 致力于企业级应用的智能运维。
-
+
diff --git a/docs/_sidebar.md b/docs/_sidebar.md
index 0d6a1bcd..e09b0b4b 100644
--- a/docs/_sidebar.md
+++ b/docs/_sidebar.md
@@ -3,12 +3,10 @@
* [更新日志](about/change-log.md)
* [如何升级](about/update.md)
* [设计概念](about/concepts.md)
-
* 快速开始
* [docker安装](quickstart/docker-install.md)
* [普通安装](quickstart/install.md)
* [常见问题](quickstart/faq.md)
-
* 操作手册
* [机器管理](operator/machine.md)
* [执行管理](operator/exec.md)
@@ -18,10 +16,8 @@
* [用户管理](operator/user.md)
* [信息管理](operator/content.md)
* [系统管理](operator/system.md)
-
* 进阶指南
* [二次开发](advance/second-dev.md)
- *
* 配置模板
* [java-springboot 项目](template/java-springboot-template.md)
* [java-tomcat 项目](template/java-tomcat-template.md)
diff --git a/docs/advance/second-dev.md b/docs/advance/second-dev.md
index 5dccab01..0ac7f1e1 100644
--- a/docs/advance/second-dev.md
+++ b/docs/advance/second-dev.md
@@ -13,38 +13,42 @@
### 配置
1. 拉取代码
- ```
- # github
- git clone https://github.com/lijiahangmax/orion-ops
- # gitee
- git clone https://gitee.com/lijiahangmax/orion-ops
- ```
+
+```
+# github
+git clone https://github.com/lijiahangmax/orion-ops
+# gitee
+git clone https://gitee.com/lijiahangmax/orion-ops
+```
2. 初始化数据库
- ```
- # 执行DDL脚本
- orion-ops/sql/init-schema.sql
- # 执行默认数据脚本 [默认用户, 默认应用环境, 常用命令模板] (可选)
- orion-ops/sql/init-data.sql
- ```
+
+```
+# 执行DDL脚本
+orion-ops/sql/init-schema.sql
+# 执行默认数据脚本 [默认用户, 默认应用环境, 常用命令模板] (可选)
+orion-ops/sql/init-data.sql
+```
3. 修改后端配置
- ```
- # 修改配置文件
- orion-ops/orion-ops-api/orion-ops-web/src/main/resources/application-dev.properties
- # 修改全局加密秘钥, 为了密码安全考虑 (推荐修改)
- orion-ops/orion-ops-api/orion-ops-web/src/main/resources/application.properties value.mix.secret.key
- ```
+
+```
+# 修改配置文件
+orion-ops/orion-ops-api/orion-ops-web/src/main/resources/application-dev.properties
+# 修改全局加密秘钥, 为了密码安全考虑 (推荐修改)
+orion-ops/orion-ops-api/orion-ops-web/src/main/resources/application.properties value.mix.secret.key
+```
4. 修改前端配置
- ```
- # 进入代码目录
- cd orion-ops/orion-ops-vue
- # 下载依赖
- npm i 或 yarn
- # 运行
- npm run serve:dev
- ```
+
+```
+# 进入代码目录
+cd orion-ops/orion-ops-vue
+# 下载依赖
+npm i 或 yarn
+# 运行
+npm run serve:dev
+```
5. 运行
后端服务启动时需要设置启动参数 `--generator-admin` 来生成默认管理员用户 (已执行 `init-data.sql` 则可以忽略)
diff --git a/docs/quickstart/docker-install.md b/docs/quickstart/docker-install.md
index ce853c28..5d768408 100644
--- a/docs/quickstart/docker-install.md
+++ b/docs/quickstart/docker-install.md
@@ -10,47 +10,63 @@
### 编译Docker镜像
1. 拉取代码
- ```
- # github
- git clone https://github.com/lijiahangmax/orion-ops
- # gitee
- git clone https://gitee.com/lijiahangmax/orion-ops
- ```
+
+```
+# github
+git clone https://github.com/lijiahangmax/orion-ops
+# gitee
+git clone https://gitee.com/lijiahangmax/orion-ops
+```
+
2. 构建后端代码
- ```
- # 修改全局加密秘钥, 为了密码安全考虑 (推荐修改)
- orion-ops/orion-ops-api/orion-ops-web/src/main/resources/application.properties value.mix.secret.key
- # 进入代码目录
- cd orion-ops/orion-ops-api
- # 编译
- mvn -U clean install -DskipTests
- ```
+
+```
+# 修改全局加密秘钥, 为了密码安全考虑 (推荐修改)
+orion-ops/orion-ops-api/orion-ops-web/src/main/resources/application.properties value.mix.secret.key
+# 进入代码目录
+cd orion-ops/orion-ops-api
+# 编译
+mvn -U clean install -DskipTests
+```
+
3. 构建前端代码
- ```
- # 进入代码目录
- cd orion-ops/orion-ops-vue
- # 下载依赖
- npm i 或 yarn
- # 编译
- npm run build:prod
- ```
+
+```
+# 进入代码目录
+cd orion-ops/orion-ops-vue
+# 下载依赖
+npm i 或 yarn
+# 编译
+npm run build:prod
+```
+
4. 构建 Docker 镜像
- ```
- # 进入仓库目录
- cd orion-ops
- # 构建镜像
- docker compose build
- ```
- 由于访问 DockerHub 镜像比较慢, 可以修改一下配置加速镜像 /etc/docker/daemon.json, 如果没有此文件可以创建此文件 (Linux系统, Window 和 Mac 直接可以通过 Docker 的 Dashboard 修改)
- ```json
- {
- "registry-mirrors": ["https://registry.docker-cn.com", "https://registry.cn-hangzhou.aliyuncs.com", "https://mirror.ccs.tencentyun.com", "https://docker.mirrors.ustc.edu.cn"]
- }
- ```
+
+```
+# 进入仓库目录
+cd orion-ops
+# 构建镜像
+docker compose build
+```
+
+由于访问 DockerHub 镜像比较慢, 可以修改一下配置加速镜像 /etc/docker/daemon.json, 如果没有此文件可以创建此文件 (Linux系统, Window 和 Mac 直接可以通过 Docker 的 Dashboard 修改)
+
+ ```json
+ {
+ "registry-mirrors": [
+ "https://registry.docker-cn.com",
+ "https://registry.cn-hangzhou.aliyuncs.com",
+ "https://mirror.ccs.tencentyun.com",
+ "https://docker.mirrors.ustc.edu.cn"
+ ]
+}
+ ```
+
5. 启动镜像
- ```
- docker compose up -d
- ```
+
+```
+docker compose up -d
+```
### 测试访问
diff --git a/docs/quickstart/install.md b/docs/quickstart/install.md
index 528d8640..8ab06c9c 100644
--- a/docs/quickstart/install.md
+++ b/docs/quickstart/install.md
@@ -13,42 +13,46 @@
### 构建
1. 拉取代码
- ```
- # github
- git clone https://github.com/lijiahangmax/orion-ops
- # gitee
- git clone https://gitee.com/lijiahangmax/orion-ops
- ```
+
+```
+# github
+git clone https://github.com/lijiahangmax/orion-ops
+# gitee
+git clone https://gitee.com/lijiahangmax/orion-ops
+```
2. 初始化数据库
- ```
- # 执行DDL脚本
- orion-ops/sql/init-schema.sql
- # 执行默认数据脚本 [默认用户, 默认应用环境, 常用命令模板] (可选)
- orion-ops/sql/init-data.sql
- ```
+
+```
+# 执行DDL脚本
+orion-ops/sql/init-schema.sql
+# 执行默认数据脚本 [默认用户, 默认应用环境, 常用命令模板] (可选)
+orion-ops/sql/init-data.sql
+```
3. 构建后端代码
- ```
- # 修改配置文件 (mysql, redis)
- orion-ops/orion-ops-api/orion-ops-web/src/main/resources/application-prod.properties
- # 修改全局加密秘钥, 为了密码安全考虑 (推荐修改)
- orion-ops/orion-ops-api/orion-ops-web/src/main/resources/application.properties value.mix.secret.key
- # 进入代码目录
- cd orion-ops/orion-ops-api
- # 编译
- mvn -U clean install -DskipTests
- ```
+
+```
+# 修改配置文件 (mysql, redis)
+orion-ops/orion-ops-api/orion-ops-web/src/main/resources/application-prod.properties
+# 修改全局加密秘钥, 为了密码安全考虑 (推荐修改)
+orion-ops/orion-ops-api/orion-ops-web/src/main/resources/application.properties value.mix.secret.key
+# 进入代码目录
+cd orion-ops/orion-ops-api
+# 编译
+mvn -U clean install -DskipTests
+```
4. 构建前端代码
- ```
- # 进入代码目录
- cd orion-ops/orion-ops-vue
- # 下载依赖
- npm i 或 yarn
- # 编译
- npm run build:prod
- ```
+
+```
+# 进入代码目录
+cd orion-ops/orion-ops-vue
+# 下载依赖
+npm i 或 yarn
+# 编译
+npm run build:prod
+```
### 修改 nginx 配置