From 48a53bc248f02b710c331f68988e563b9fb2bf1d Mon Sep 17 00:00:00 2001 From: lijiahang Date: Mon, 27 May 2024 10:26:55 +0800 Subject: [PATCH] =?UTF-8?q?:pencil:=20=E4=BF=AE=E6=94=B9=E6=96=87=E6=A1=A3?= =?UTF-8?q?.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/README.md | 3 ++- docs/_coverpage.md | 2 +- docs/operator/asset.md | 4 ---- docs/operator/exec.md | 10 ++++---- docs/operator/host-ops.md | 1 + docs/operator/job.md | 4 ++-- docs/operator/system.md | 2 +- docs/quickstart/dev.md | 12 ++++------ docs/quickstart/docker-install.md | 14 +++++------ docs/quickstart/faq.md | 23 +++++++++---------- docs/quickstart/install.md | 12 ++++------ docs/update/v1.0.0.md | 4 ++-- docs/update/v1.0.1.md | 6 ++--- docs/update/v1.0.2.md | 6 ++--- docs/update/v1.0.3.md | 4 ++-- docs/update/v1.0.4.md | 6 ++--- docs/update/v1.0.5.md | 6 ++--- docs/update/v1.0.6.md | 9 ++++---- docs/update/v1.0.7.md | 6 ++--- docs/update/v1.0.8.md | 6 ++--- docs/update/v2.0.0.md | 20 ++++++++-------- docs/update/v2.0.3.md | 6 ++--- .../login/components/login-form.vue | 9 ++++++++ .../authentication/login/locale/zh-CN.ts | 1 + 24 files changed, 88 insertions(+), 88 deletions(-) diff --git a/docs/README.md b/docs/README.md index a6e90b96..04f8d385 100644 --- a/docs/README.md +++ b/docs/README.md @@ -43,7 +43,8 @@ **`orion-visor`** 提供一站式服务器运维解决方案。 * **资产管理**：支持对资产进行分组，实现对主机、密钥和身份的统一管理和授权。 -* **在线终端**：提供在线 Terminal 服务，支持快捷命令、大文件上传、在线编辑等操作。 +* **在线终端**：提供在线终端 SSH 服务，支持快捷命令、自定义快捷键和主题风格。 +* **文件管理**：支持远程主机 SFTP 大文件的批量上传、下载和在线编辑等操作。 * **批量操作**：支持批量执行主机命令、多主机文件分发等功能。 * **计划任务**：支持配置 cron 表达式，定时执行主机命令。 * **安全可靠**：动态配置权限，记录用户操作日志，提供简单的审计功能。 diff --git a/docs/_coverpage.md b/docs/_coverpage.md index 5f279646..b769b74d 100644 --- a/docs/_coverpage.md +++ b/docs/_coverpage.md @@ -1,6 +1,6 @@ # orion-visor 2.0.2 -> 一款开箱即用的运维平台。 +> 一款高颜值、现代化的智能运维&轻量堡垒机平台。 - 友好 易用 - 安全 稳定 diff --git a/docs/operator/asset.md b/docs/operator/asset.md index 8d88df17..b958c80f 100644 --- a/docs/operator/asset.md +++ b/docs/operator/asset.md @@ -34,7 +34,3 @@ ### 资产授权 给用户/角色授权资产数据, 若无授权则无法访问资产。 - -给用户授权时: 若当前选择的用户有管理员角色(admin)则无需配置, 管理员拥有全部权限。 -给角色授权时: 无需给管理员(admin)配置, 管理员拥有全部权限。 - diff --git a/docs/operator/exec.md b/docs/operator/exec.md index 18bb959a..f5463a86 100644 --- a/docs/operator/exec.md +++ b/docs/operator/exec.md @@ -21,7 +21,7 @@ * 命令: 查看执行时的命令 * 参数: 查看执行时的参数 * 中断: 中断命令执行 -* 日志: 查看执行日志, ctrl + 左键点击会用新页面打开 +* 日志: 查看执行日志 `ctrl + 左键` 点击会用新页面打开 * 下载: 下载执行日志 ### 批量上传 @@ -65,14 +65,14 @@ ### 日志面板快捷键 * 回车: `Enter` -* 向上滚动一行: `↑` -* 向上滚动一页: `Home` -* 向下滚动一行: `↓` -* 向下滚动一页: `End` * 全选: `ctrl` `A` * 复制: `ctrl` `C` * 搜索: `ctrl` `F` * 清空: `ctrl` `L` +* 向上滚动一行: `↑` +* 向上滚动一页: `Home` +* 向下滚动一行: `↓` +* 向下滚动一页: `End` ### 命令内置参数 diff --git a/docs/operator/host-ops.md b/docs/operator/host-ops.md index 36a2c024..574d656d 100644 --- a/docs/operator/host-ops.md +++ b/docs/operator/host-ops.md @@ -24,6 +24,7 @@ > 右侧状态栏 * 命令片段: 自定义快速执行的命令片段, 双击直接执行 +* 路径书签: 自定义快速进入的目录 * 传输列表: 打开文件传输列表, 当前会话下, 所有的文件上传下载传输都会显示在这里 * 截图: 截屏终端并且自动下载 diff --git a/docs/operator/job.md b/docs/operator/job.md index cdda3ab9..5bdaa79c 100644 --- a/docs/operator/job.md +++ b/docs/operator/job.md @@ -1,6 +1,6 @@ ### 任务列表 -⚡ 内置参数同 `批量执行 > 命令执行` [查看](/operator/exec.md?id=命令内置参数) +⚡ 内置参数同 `批量执行` > `命令执行` [查看](/operator/exec.md?id=命令内置参数) 维护计划任务, 定时执行命令。 @@ -22,5 +22,5 @@ * 命令: 查看执行时的命令 * 参数: 查看执行时的参数 * 中断: 中断命令执行 -* 日志: 查看执行日志, ctrl + 左键点击会用新页面打开 +* 日志: 查看执行日志 `ctrl + 左键` 点击会用新页面打开 * 下载: 下载执行日志 diff --git a/docs/operator/system.md b/docs/operator/system.md index ca9b6263..8d109845 100644 --- a/docs/operator/system.md +++ b/docs/operator/system.md @@ -13,7 +13,7 @@ * 新增: 添加一个字典项 * 刷新缓存: 强制刷新服务器缓存, 一般是手动修改了数据库后需要点击此按钮 -* 查看: 查看字典值的json +* 查看: 查看字典值的 json * 修改: 修改字典项 * 删除: 删除字典项以及字典值 diff --git a/docs/quickstart/dev.md b/docs/quickstart/dev.md index 3f634372..8ea7f94a 100644 --- a/docs/quickstart/dev.md +++ b/docs/quickstart/dev.md @@ -11,9 +11,7 @@ ⚡ npm 建议使用淘宝镜像 `npm config set registry https://registry.npmmirror.com/` ⚡ pnpm 建议使用淘宝镜像 `pnpm config set registry https://registry.npmmirror.com/` -### 配置 - -1. 拉取代码 +### 拉取代码 ``` # github @@ -22,7 +20,7 @@ git clone https://github.com/lijiahangmax/orion-visor git clone https://gitee.com/lijiahangmax/orion-visor ``` -2. 初始化数据库 +### 初始化数据库 ``` # 执行脚本 @@ -32,7 +30,7 @@ orion-visor/sql/init-3-schema-quartz.sql orion-visor/sql/init-4-data.sql ``` -3. 修改后端配置 +### 修改后端配置 ``` # 修改配置文件 (mysql, redis, secret-key) @@ -46,9 +44,9 @@ mvn -U clean install -DskipTests com.orion.visor.launch.LaunchApplication ``` -4. 修改前端配置 +### 修改前端配置 -``` +```shell # 进入代码目录 cd orion-visor/orion-visor-ui # 下载 pnpm diff --git a/docs/quickstart/docker-install.md b/docs/quickstart/docker-install.md index 2342508e..1dc4f3fd 100644 --- a/docs/quickstart/docker-install.md +++ b/docs/quickstart/docker-install.md @@ -19,7 +19,7 @@ Dashboard 修改) ### 拉取代码 -``` +```shell # github git clone https://github.com/lijiahangmax/orion-visor # gitee @@ -41,18 +41,18 @@ cd orion-visor ### 启动 -``` +```shell docker compose up -d ``` -### 连接 mysql (如果需要在 navicat 中连接) +### 修改加密方式 ``` 访问 adminer: http://localhost:8081 服务器: orion-visor-mysql 用户名: root -密码: Data@123456 -数据库: orion-visor +密 码: Data@123456 +数据库: orion_visor 点击左侧 SQL命令 输入: ALTER USER 'root'@'%' IDENTIFIED WITH mysql_native_password BY 'Data@123456'; @@ -62,5 +62,5 @@ ALTER USER 'root'@'%' IDENTIFIED WITH mysql_native_password BY 'Data@123456'; ### 测试访问 在浏览器中输入 http://localhost:1081/ 访问 -账号: admin -密码: admin +账号: `admin` +密码: `admin` diff --git a/docs/quickstart/faq.md b/docs/quickstart/faq.md index 65c3e0b7..00bfd197 100644 --- a/docs/quickstart/faq.md +++ b/docs/quickstart/faq.md @@ -1,27 +1,32 @@ -> ##### 1. 数据误删除怎么办? +### 数据误删除怎么办? 数据库的数据都采用了逻辑删除, 可以将已删除的数据中的 `deleted` 字段改为 `0` 如果不知道数据是哪一条, 可以查询用户操作日志, 点击 `参数` 寻找操作的id -> ##### 2. 执行命令时为什么会找不到环境变量? +### 执行命令时为什么会找不到环境变量? 可以在执行命令的第一行设置 `source /etc/profile` 来加载环境变量 -> ##### 3. 命令中途执行失败如何设置中断执行? +### 命令中途执行失败如何设置中断执行? 可以在执行命令的第一行设置 `set -e` 作用是: 当执行出现意料之外的情况时, 立即退出 -> ##### 4. 在调度任务、批量执行 命令执行成功的依据是什么? +### 在调度任务、批量执行 命令执行成功的依据是什么? 是获取命令的 `exitcode` 判断是否为 `0` 如果非0则代表命令执行失败 同理, 在命令的最后一行设置 `exit 1` 结果将会是失败, 可以用此来中断后续流程 -> ##### 5. 调度任务、批量执行 的日志文件中如何只保存原始输出? +### 调度任务、批量执行 的日志文件中如何只保存原始输出? 修改 `application.yaml` `app.exec-log.append-ansi` 为 `false` -> ##### 6. 为什么使用密钥认证还是无法连接机器? +### SFTP 为什么有些文件无法编辑? + +只有普通文件可以在线编辑, 也就是 attr 为 `-` 开头的文件, 且文件大小不超过 `2MB` (默认) +修改 `.env.production` `VITE_SFTP_PREVIEW_MB` 改为一个合适的大小(MB) 重新构建 + +### 为什么使用密钥认证还是无法连接机器? ``` # 升级 openssh @@ -41,9 +46,3 @@ AuthorizedKeysFile .ssh/authorized_keys # 重启 sshd 服务 service sshd restart ``` - -
- -⚡ 详细使用请参考操作手册~ - -
diff --git a/docs/quickstart/install.md b/docs/quickstart/install.md index b3b99af7..f316641e 100644 --- a/docs/quickstart/install.md +++ b/docs/quickstart/install.md @@ -12,9 +12,7 @@ ⚡ npm 建议使用淘宝镜像 `npm config set registry https://registry.npmmirror.com/` ⚡ pnpm 建议使用淘宝镜像 `pnpm config set registry https://registry.npmmirror.com/` -### 构建 - -1. 拉取代码 +### 拉取代码 ``` # github @@ -23,7 +21,7 @@ git clone https://github.com/lijiahangmax/orion-visor git clone https://gitee.com/lijiahangmax/orion-visor ``` -2. 初始化数据库 +### 初始化数据库 ``` # 执行脚本 @@ -33,7 +31,7 @@ orion-visor/sql/init-3-schema-quartz.sql orion-visor/sql/init-4-data.sql ``` -3. 构建后端代码 +### 构建后端代码 ``` # 修改配置文件 (mysql, redis, secret-key) @@ -45,7 +43,7 @@ cd orion-visor mvn -U clean install -DskipTests ``` -4. 构建前端代码 +### 构建前端代码 ``` # 进入代码目录 @@ -122,7 +120,7 @@ server { ``` 复制 orion-visor/orion-visor-ui/dist 到 /usr/share/nginx/html -复制 orion-visor/orion-visor-launch/target/orion-visor-launch.jar 到 /data/orion +复制 orion-visor/orion-visor-launch/target/orion-visor-launch.jar 到 /data/orion-visor-space # 启动后台服务 nohup java -jar orion-visor-launch.jar --spring.profiles.active=prod 2>&1 & # 启动 nginx diff --git a/docs/update/v1.0.0.md b/docs/update/v1.0.0.md index bc76c6db..c33a32c3 100644 --- a/docs/update/v1.0.0.md +++ b/docs/update/v1.0.0.md @@ -1,6 +1,6 @@ -## v1.0.0 +### v1.0.0 -> sql 脚本 - DML +### sql 脚本 - DML ```sql -- 字典配置项 diff --git a/docs/update/v1.0.1.md b/docs/update/v1.0.1.md index f16d863b..2eb75e4f 100644 --- a/docs/update/v1.0.1.md +++ b/docs/update/v1.0.1.md @@ -1,13 +1,13 @@ -## v1.0.1 +### v1.0.1 -> sql 脚本 - DDL +### sql 脚本 - DDL ```sql DROP TABLE IF EXISTS `command_template`; ALTER TABLE `operator_log` ADD INDEX `idx_type`(`type`); ``` -> sql 脚本 - DML +### sql 脚本 - DML ```sql -- 菜单配置 diff --git a/docs/update/v1.0.2.md b/docs/update/v1.0.2.md index 026ec55b..7467180f 100644 --- a/docs/update/v1.0.2.md +++ b/docs/update/v1.0.2.md @@ -1,6 +1,6 @@ -## v1.0.2 +### v1.0.2 -> sql 脚本 - DDL +### sql 脚本 - DDL ```sql ALTER TABLE `host_connect_log` @@ -83,7 +83,7 @@ CREATE TABLE `exec_template` ROW_FORMAT = Dynamic; ``` -> sql 脚本 - DML +### sql 脚本 - DML ```sql -- 菜单配置 diff --git a/docs/update/v1.0.3.md b/docs/update/v1.0.3.md index f7022ac4..47d86e43 100644 --- a/docs/update/v1.0.3.md +++ b/docs/update/v1.0.3.md @@ -1,6 +1,6 @@ -## v1.0.3 +### v1.0.3 -> sql 脚本 - DML +### sql 脚本 - DML ```sql DELETE FROM preference WHERE type = 'TERMINAL'; diff --git a/docs/update/v1.0.4.md b/docs/update/v1.0.4.md index 06ee92ca..ae2f212f 100644 --- a/docs/update/v1.0.4.md +++ b/docs/update/v1.0.4.md @@ -1,6 +1,6 @@ -## v1.0.4 +### v1.0.4 -> sql 脚本 - DDL +### sql 脚本 - DDL ```sql -- 修改字段 @@ -260,7 +260,7 @@ CREATE TABLE `QRTZ_SCHEDULER_STATE` ROW_FORMAT = Dynamic; ``` -> sql 脚本 - DML +### sql 脚本 - DML ```sql -- 操作日志修改 diff --git a/docs/update/v1.0.5.md b/docs/update/v1.0.5.md index c73a8eec..cc6b7b32 100644 --- a/docs/update/v1.0.5.md +++ b/docs/update/v1.0.5.md @@ -1,6 +1,6 @@ -## v1.0.5 +### v1.0.5 -> sql 脚本 - DDL +### sql 脚本 - DDL ```sql ALTER TABLE `system_user` @@ -22,7 +22,7 @@ ALTER TABLE `exec_host_log` ADD COLUMN `script_path` varchar(512) NULL COMMENT '脚本路径' AFTER `log_path`; ``` -> sql 脚本 - DML +### sql 脚本 - DML ```sql -- 初始化主机身份类型 diff --git a/docs/update/v1.0.6.md b/docs/update/v1.0.6.md index f4714f0a..f48f77b5 100644 --- a/docs/update/v1.0.6.md +++ b/docs/update/v1.0.6.md @@ -1,6 +1,6 @@ -## v1.0.6 +### v1.0.6 -> sql 脚本 - DDL +### sql 脚本 - DDL ```sql -- 数据分组添加 userId @@ -58,10 +58,9 @@ CREATE TABLE `path_bookmark` CHARACTER SET = utf8mb4 COLLATE = utf8mb4_general_ci COMMENT = '路径书签' ROW_FORMAT = Dynamic; - ``` -> sql 脚本 - DML +### sql 脚本 - DML ```sql -- 设置数据分组 user_id @@ -88,7 +87,7 @@ INSERT INTO `dict_value` VALUES (274, 39, 'pathBookmarkType', 'FILE', '文件', INSERT INTO `dict_value` VALUES (275, 39, 'pathBookmarkType', 'DIR', '文件夹', '{}', 20, '2024-04-24 13:43:39', '2024-04-24 13:43:39', '1', '1', 0); ``` -> sql 脚本 - 命令分组初始化 +### sql 脚本 - 命令分组初始化 ```sql -- 插入命令片段分组 diff --git a/docs/update/v1.0.7.md b/docs/update/v1.0.7.md index e888f7e1..18eda4d6 100644 --- a/docs/update/v1.0.7.md +++ b/docs/update/v1.0.7.md @@ -1,6 +1,6 @@ -## v1.0.7 +### v1.0.7 -> sql 脚本 - DDL +### sql 脚本 - DDL ```sql ALTER TABLE `data_permission` COMMENT = '数据权限表'; @@ -57,7 +57,7 @@ CREATE TABLE `upload_task_file` ROW_FORMAT = Dynamic; ``` -> sql 脚本 - DML +### sql 脚本 - DML ```sql -- 字典项 diff --git a/docs/update/v1.0.8.md b/docs/update/v1.0.8.md index 64d79312..8833fd3e 100644 --- a/docs/update/v1.0.8.md +++ b/docs/update/v1.0.8.md @@ -1,6 +1,6 @@ -## v1.0.8 +### v1.0.8 -> sql 脚本 - DDL +### sql 脚本 - DDL ```sql -- 修改字段名称 @@ -32,7 +32,7 @@ CREATE TABLE `system_message` ROW_FORMAT = Dynamic; ``` -> sql 脚本 - DML +### sql 脚本 - DML ```sql -- 菜单 diff --git a/docs/update/v2.0.0.md b/docs/update/v2.0.0.md index ff9f5f7d..3be3ac3c 100644 --- a/docs/update/v2.0.0.md +++ b/docs/update/v2.0.0.md @@ -1,22 +1,20 @@ -## v2.0.0 +### v2.0.0 ### ⚡ **本次升级提示 本次更新较大 请仔细查阅** ⚡ -##### 本次升级思路: - * 先执行以下 **`7`** 个脚本 * 容器下线 `docker compose down` * 删除原代码目录 `rm -rf orion-ops-pro` * 克隆改名后的项目 `git clone https://github.com/lijiahangmax/orion-visor.git` or `gitee` * 启动容器 `docker compose up -d` -```readme +```text sql 在 adminer/navicat 中执行, bash 脚本直接修改后粘贴执行 不要保存为文件执行否则会出错 本次升级包含数据库重命名操作。#3 创建新数据库, #4 进行数据迁移, #5 删除旧数据库。 [不推荐] 如果不想重命名可以修改 docker-compose.yml, 将 MYSQL_DATABASE 改为 orion-ops-pro 并且跳过步骤 #3 #4 #5 ``` -> #1 sql 脚本 - DDL +### 1. sql 脚本 - DDL ```sql -- 修改默认值 @@ -29,7 +27,7 @@ MODIFY COLUMN `key_id` bigint(0) NULL DEFAULT NULL COMMENT '密钥id' AFTER `pas ALTER TABLE `host_key` COMMENT = '主机密钥'; ``` -> #2 sql 脚本 - DML +### 2. sql 脚本 - DML ```sql -- 删除 quartz 配置 @@ -70,14 +68,14 @@ INSERT INTO `dict_value` VALUES (174, 26, 'hostExtraSshAuthType', 'CUSTOM_KEY', INSERT INTO `dict_value` VALUES (271, 37, 'hostIdentityType', 'KEY', '密钥', '{\"color\": \"arcoblue\"}', 20, '2024-04-16 17:18:12', '2024-05-17 12:49:16', '2', '2', 0); ``` -> #3 sql 脚本 - 创建数据库 orion_visor +### 3. sql 脚本 - 创建数据库 orion_visor ```sql -- 创建数据库 CREATE DATABASE IF NOT EXISTS `orion_visor` DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci; ``` -> #4 bash 脚本 - 数据迁移 +### 4. bash 脚本 - 数据迁移 ```bash # 可以使用 navicat 的数据迁移功能, 下面描述的是 bash 中执行, 注意下面的变量替换 @@ -97,14 +95,14 @@ rm -f /tmp/orion-ops-pro_dump.sql exit ``` -> #5 sql 脚本 - 删除数据库 +### 5. sql 脚本 - 删除数据库 ```sql -- 删除数据库 DROP DATABASE `orion-ops-pro`; ``` -> #6 bash 脚本 - 修改 nginx 配置 +### 6. bash 脚本 - 修改 nginx 配置 ```bash pro_container_id=41dfd6aff736; @@ -118,7 +116,7 @@ nginx -s reload exit ``` -> #7 bash 脚本 - 工作空间迁移 +### 7. bash 脚本 - 工作空间迁移 ```bash # 迁移工作空间 diff --git a/docs/update/v2.0.3.md b/docs/update/v2.0.3.md index 42fd5a2e..f4d9d399 100644 --- a/docs/update/v2.0.3.md +++ b/docs/update/v2.0.3.md @@ -1,11 +1,11 @@ -## v2.0.3 +### v2.0.3 -> sql 脚本 - DDL +### sql 脚本 - DDL ```sql ``` -> sql 脚本 - DML +### sql 脚本 - DML ```sql ``` diff --git a/orion-visor-ui/src/views/authentication/login/components/login-form.vue b/orion-visor-ui/src/views/authentication/login/components/login-form.vue index 0760927f..868c5df8 100644 --- a/orion-visor-ui/src/views/authentication/login/components/login-form.vue +++ b/orion-visor-ui/src/views/authentication/login/components/login-form.vue @@ -1,7 +1,14 @@