From 562bb3f0d12c8100ff58b0c5610ad5228aedea28 Mon Sep 17 00:00:00 2001 From: lijiahang Date: Tue, 27 Feb 2024 17:03:38 +0800 Subject: [PATCH] :pencil: doc. --- README.md | 183 +++++++++++++++++++++++++++++-------------------- docs/README.md | 15 ++-- 2 files changed, 120 insertions(+), 78 deletions(-) diff --git a/README.md b/README.md index e5c45a49..4482e817 100644 --- a/README.md +++ b/README.md @@ -1,88 +1,125 @@ -### orion-ops-pro (orion-ops重构版) +

+ orion-ops-pro 是什么 +

-### 开发中 +`orion-ops-pro` 一款开箱即用的运维平台, 提供了资产管理、资产授权、Web终端、WebSftp、角色管理、系统管理等功能。为运维团队提供轻量化的运维治理平台。它是根据 `orion-ops` +的产品思路完全重构的一套系统, 重新设计了架构并优化交互逻辑, 操作更快捷友好。 -##### 项目结构 -``` -orion-ops-pro 仓库主目录 - orion-ops-dependencies 依赖模块 项目依赖版本的统一管理 - orion-ops-framework 架构模块 包含了项目所有的配置 - orion-ops-launch 启动模块 项目主容器用于服务的启动 - orion-ops-module-asset 资产模块 - orion-ops-module-infra 基建模块 - orion-ops-ui 前端代码 -``` +

+ + quality + + + jdk8 + + + License + + + star + + + fork + + +

+
-##### sql脚本 -``` -orion-ops-pro - - sql - - init-schema.sql (初始化表结构) - - init-data.sql (初始化数据, 用户, 角色, 菜单) - - 常用.sql (创建基本表结构) -``` +当前版本: **1.0.0-beta.1** +github: https://github.com/lijiahangmax/orion-ops-pro +gitee: https://gitee.com/lijiahangmax/orion-ops-pro +文档: https://lijiahangmax.gitee.io/orion-ops-pro/#/ +demo: http://101.43.254.243:1081/#/ +演示账号: `orionuser` +演示密码: `orionuser` +留个小星星再走吧⭐ -##### 本地启动 +## 特性 -``` -在 release 1.0.0 之前不准备发布 orion-kit 1.0.6 -需要开发者在本地拉取 orion-kit/dev 并且手动构建 -https://gitee.com/lijiahangmax/orion-kit +* 易用便捷: 极简配置, 开箱即用, 并兼容 Docker 部署方式。 +* 资产管理: 支持灵活配置主机分组, 统一管理主机、秘钥和身份。 +* 资产授权: 可将资产数据授权给指定角色和用户。 +* 权限控制: 全面管理用户角色, 支持动态菜单配置和强制下线等功能。 +* 在线终端: 提供便捷的在线 Web 终端服务, 支持自定义快捷键和主题风格。 +* 文件管理: 实现远程主机文件的批量上传、下载和在线编辑等操作。 +* 可扩展性: 前后端代码规范统一, 代码质量高、健壮且易于阅读和扩展。 -# 构建 orion-kit -切换 dev 分支 -mvn clean install -U -DskipTests +[comment]: <> ( FIXME * 批量操作: 支持远程主机批量执行命令 以及 批量执行上传文件) -# 配置后端 -修改 application-dev.yaml 的 mysql, redis 配置 +[comment]: <> ( FIXME * 调度任务: 维护 cron 表达式, 定时执行主机命令) -# 启动后端 -orion-ops-launch -IDEA 启动 com.orion.ops.launch.LaunchApplication +[comment]: <> ( FIXME * 功能强大: 命令批量执行, 任务定时调度, 远程日志查看, 操作日志全记录等) -# 启动前端 -orion-ops-ui -npm i -npm run dev -``` +## 快速开始 -#### 代码生成器 -``` -生成通用 controller entity service dao api convert http vue ts sql junit +docker安装: https://lijiahangmax.gitee.io/orion-ops-pro/#/quickstart/docker-install +安装文档: https://lijiahangmax.gitee.io/orion-ops-pro/#/quickstart/install +开发文档: https://lijiahangmax.gitee.io/orion-ops-pro/#/advance/dev +操作手册: https://lijiahangmax.gitee.io/orion-ops-pro/#/operator/asset +常见问题: https://lijiahangmax.gitee.io/orion-ops-pro/#/quickstart/faq +roadmap: https://lijiahangmax.gitee.io/orion-ops-pro/#/about/roadmap -代码位置 -com.orion.ops.framework.mybatis.core.generator.CodeGenerators +## 技术栈 -// 生成的表为 system_role, 业务注释为 '角色', 业务包为 role -Template.create("system_role", "角色", "role") - // 生成 api - .enableProviderApi() - // 不生成单元测试 - .disableUnitTest() - // 生成缓存 - .cache("user:role", "角色缓存") - // 缓存过期时间 1 DAY - .expire(1, TimeUnit.DAYS) - // 生成 vue 文件, 一级业务包为 user, 二级业务包为 role (前端命名只能使用脊柱命名法) - .vue("user", "role") - // 前端使用抽屉表单 (多字段使用) - .enableDrawerForm() - // 前端支持卡片或 (多字段使用) - .enableCardView() - // 前端支持多选 - .enableRowSelection() - // 生成字典配置 配置项为 'dictValueType', 替换的字段为 'value_type' - .dict("dictValueType", "value_type") - // 设置字段名称 - .fields("STRING", "INTEGER", "DECIMAL", "BOOLEAN", "COLOR") - // 设置字典值 - .value(1, 2, 3, 4, 5) - // 设置字典值描述 - .labels("字符串", "整数", "小数", "布尔值", "颜色") - // 设置额外值 color - .color("blue", "gray", "red", "green", "white") - .build(); -``` +* Docker +* SpringBoot +* Mysql +* Redis +* Vue3 +* Arco Design +[//]: # ( fixme 免责声明 (注意事项) (在使用平台之前, 请确保您已经了解并同意相关的使用协议和隐私政策。) (为了数据安全, 请定期备份数据和配置, 以防意外丢失或损坏。)) + +## 功能预览 + +> 工作台 + +![工作台](https://bjuimg.obs.cn-north-4.myhuaweicloud.com/images/2024/2/27/69328bb3-8a8d-47ca-8a5b-d16c56be704b.png "工作台") + +> 资产管理 + +![主机列表](https://bjuimg.obs.cn-north-4.myhuaweicloud.com/images/2024/2/27/8ca59a20-09b6-48e5-b511-c01319d963df.png "主机列表") +![资产授权](https://bjuimg.obs.cn-north-4.myhuaweicloud.com/images/2024/2/27/a6e48de3-5145-4c48-a6a2-b99208cb1ae1.png "资产授权") + +> 主机终端 + +![主机终端](https://bjuimg.obs.cn-north-4.myhuaweicloud.com/images/2024/2/27/7264f870-45c7-4037-9179-6473d254c231.png "主机终端") +![命令片段](https://bjuimg.obs.cn-north-4.myhuaweicloud.com/images/2024/2/27/0803bb07-3776-4de3-bd4a-02931fab7ca7.png "命令片段") +![主题设置](https://bjuimg.obs.cn-north-4.myhuaweicloud.com/images/2024/2/27/89f75025-b0d4-4ccf-b1a7-de311c576ab4.png "主题设置") +![终端设置](https://bjuimg.obs.cn-north-4.myhuaweicloud.com/images/2024/2/27/b6d2da7a-5aaf-4790-b4e9-d8e8428e2122.png "终端设置") +![sftp](https://bjuimg.obs.cn-north-4.myhuaweicloud.com/images/2024/2/27/9c096d5e-3a1c-40e3-b047-1e8725f27726.png "sftp") +![传输列表](https://bjuimg.obs.cn-north-4.myhuaweicloud.com/images/2024/2/27/cebee39c-d5f6-4d82-b4b8-f2734c9a49bf.png "传输列表") + +> 用户管理 + +![用户列表](https://bjuimg.obs.cn-north-4.myhuaweicloud.com/images/2024/2/27/b9ca5bb6-f88a-43e6-888f-b7259df02521.png "用户列表") +![个人中心](https://bjuimg.obs.cn-north-4.myhuaweicloud.com/images/2024/2/27/6a4985c6-e828-4eb3-96b2-b1ca48df7579.png "个人中心") +![操作日志](https://bjuimg.obs.cn-north-4.myhuaweicloud.com/images/2024/2/27/304c6e12-755e-4ce7-8d37-051676ff6fe9.png "操作日志") + +> 系统管理 + +![系统菜单](https://bjuimg.obs.cn-north-4.myhuaweicloud.com/images/2024/2/27/89dcd816-7f76-4bed-be4c-79a412dbeba4.png "系统菜单") +![分配菜单](https://bjuimg.obs.cn-north-4.myhuaweicloud.com/images/2024/2/27/ac5ca3da-6874-4655-b192-b88bad6cfa06.png "分配菜单") + +## 联系我 + +
+ qq + wx +
+ +📧 微信添加备注: ops + +## 支持一下 + +收款码 + +🎁 为了项目能健康持续的发展, 我期望获得相应的资金支持, 你们的支持是我不断更新前进的动力! + +## License + +本项目遵循 [Apache-2.0](https://github.com/lijiahangmax/orion-ops-pro/blob/main/LICENSE) 开源许可证。 diff --git a/docs/README.md b/docs/README.md index fdb7dd62..a6d3881d 100644 --- a/docs/README.md +++ b/docs/README.md @@ -47,9 +47,12 @@ demo: http://101.43.254.243:1081/#/ * 在线终端: 提供便捷的在线 Web 终端服务, 支持自定义快捷键和主题风格。 * 文件管理: 实现远程主机文件的批量上传、下载和在线编辑等操作。 * 可扩展性: 前后端代码规范统一, 代码质量高、健壮且易于阅读和扩展。 - [//]: # (FIXME * 批量操作: 支持远程主机批量执行命令 以及 批量执行上传文件) - [//]: # (FIXME * 调度任务: 维护 cron 表达式, 定时执行主机命令) - [//]: # (FIXME * 功能强大: 命令批量执行, 任务定时调度, 远程日志查看, 操作日志全记录等) + +[comment]: <> ( FIXME * 批量操作: 支持远程主机批量执行命令 以及 批量执行上传文件) + +[comment]: <> ( FIXME * 调度任务: 维护 cron 表达式, 定时执行主机命令) + +[comment]: <> ( FIXME * 功能强大: 命令批量执行, 任务定时调度, 远程日志查看, 操作日志全记录等) ## 快速开始 @@ -104,8 +107,10 @@ roadmap: https://lijiahangmax.gitee.io/orion-ops-pro/#/about/roadmap ## 联系我 -qq -wx +
+ qq + wx +
📧 微信添加备注: ops