📝 doc.

docs/operator/asset.md

@@ -0,0 +1,40 @@
+### 主机管理
+
+管理和维护可操作的主机。
+
+* 主机分组: 设置主机分组以及组内数据
+* 角色授权: 跳转页面到主机授权页面(角色)
+* 用户授权: 跳转页面到主机授权页面(用户)
+* 新增: 添加一台主机
+* 修改: 修改主机信息
+* 配置: 修改主机配置信息
+* 删除: 删除这台主机以及主机关联的数据
+
+### 主机秘钥
+
+统一管理和维护用于连接主机的秘钥。
+
+* 角色授权: 跳转页面到主机秘钥授权页面(角色)
+* 用户授权: 跳转页面到主机秘钥授权页面(用户)
+* 新增: 添加一个主机秘钥
+* 修改: 修改主机秘钥信息
+* 详情: 查看主机秘钥信息
+* 删除: 删除当前主机秘钥
+
+### 主机身份
+
+统一管理和维护用于连接主机的身份。这里同时维护了用户名,密码/秘钥。
+
+* 角色授权: 跳转页面到主机身份授权页面(角色)
+* 用户授权: 跳转页面到主机身份授权页面(用户)
+* 新增: 添加一个主机身份
+* 修改: 修改主机身份信息
+* 删除: 删除当前主机身份
+
+### 资产授权
+
+给用户/角色授权资产数据, 若无授权则无法访问资产。
+
+给用户授权时: 若当前选择的用户有管理员角色(admin)则无需配置, 管理员拥有全部权限。  
+给角色授权时: 无需给管理员(admin)配置, 管理员拥有全部权限。  
+

docs/operator/host_audit.md

@@ -0,0 +1,3 @@
+### 连接日志
+
+在主机终端页面打开的 `SSH` `SFTP` 连接都会记录下来, 这里默认只展示 `SSH` 连接记录, 可以展开条件进行修改。  

docs/operator/host_ops.md

@@ -0,0 +1,35 @@
+### 主机终端
+
+主机终端页面 支持 SSH, SFTP。  
+打开后默认会进入新建连接页面, 页面的主机数据是用户授权的资产数据。  
+鼠标移入列表内的主机上时, 右侧会出现 `打开 SSH` `打开 SFTP` `连接设置` `收藏` 的按钮。  
+点击 `连接设置` 后, 会弹出模态框, 可以自定义配置连接主机的 密码/秘钥/身份, 仅对自己生效, 不会修改全局配置, `秘钥` `身份` 数据是用户授权的资产数据。
+
+> 顶部状态栏
+
+* 全屏: 开启或关闭全屏
+
+> 左侧状态栏
+
+* 新建连接: 新建主机连接 `SSH` `SFTP`
+* 快捷键设置: 配置 `全局` `会话` `终端` 的快捷键
+* 显示设置: 配置终端 `显示偏好` `操作栏按钮` `右键菜单` 设置
+* 主题设置: 修改终端主题配色
+* 终端设置: 配置终端 `交互` `插件` `会话` 设置
+
+> 右侧状态栏
+
+* 命令片段: 自定义快速执行的命令片段, 双击直接执行
+* 传输列表: 打开文件传输列表, 当前会话下, 所有的文件上传下载传输都会显示在这里
+* 截图: 截屏终端并且自动下载
+
+> 文件传输
+
+点击上传或者下载后会自动添加到传输列表。
+
+* 上传: 关闭页面自动清除
+* 下载: 下载完成后自动下载, 关闭页面自动清除
+
+> SFTP
+
+* 预览: 默认只能预览 2MB 以内的普通文件, 这个大小可以在前端 env 文件中修改 `VITE_SFTP_PREVIEW_MB`

docs/operator/system.md

@@ -0,0 +1,27 @@
+### 系统菜单
+
+管理系统菜单。点击 `状态` 可以快速切换 启用/停用 和 显示/隐藏。
+
+* 新增: 添加一个菜单
+* 刷新缓存: 强制刷新服务器缓存, 一般是手动修改了数据库后需要点击此按钮
+* 修改: 修改菜单信息
+* 删除: 删除菜单以及子菜单
+
+### 数据字典项
+
+维护数据字典项, 前端统一显示。
+
+* 新增: 添加一个字典项
+* 刷新缓存: 强制刷新服务器缓存, 一般是手动修改了数据库后需要点击此按钮
+* 查看: 查看字典值的json
+* 修改: 修改字典项
+* 删除: 删除字典项以及字典值
+
+### 数据字典值
+
+维护数据字典项对应的值。
+
+* 新增: 新增字典值
+* 修改: 修改字典值
+* 历史: 查询当前字典值的修改历史
+* 删除: 删除字典值

docs/operator/user.md

@@ -0,0 +1,27 @@
+### 角色管理
+
+定义以及维护系统内的角色。 `admin` 是管理员角色, 无法删除/停用/分配菜单。
+
+* 新增: 新增角色
+* 启用/停用: 启用/停用角色, 停用后授权的数据/菜单将无法使用
+* 分配菜单: 给角色分配菜单
+* 修改: 修改角色名称
+* 删除: 删除当前角色, 如果已被关联则移除用户关联
+
+### 用户管理
+
+维护系统内的用户。
+
+* 新增: 新增用户
+* 启用/停用: 启用/停用角色, 停用后则无法登录系统
+* 修改: 修改用户的基本信息
+* 详情: 查看用户的基本信息, 登录日志, 当前登录设备, 操作日志
+* 重置密码: 重置用户密码
+* 分配角色: 设置用户绑定的角色
+* 删除: 删除当前用户以及用户数据
+
+### 操作日志
+
+记录用户在系统内的操作日志。
+
+* 详情: 查看操作的参数以及留痕信息