📝 doc.
This commit is contained in:
lijiahang
183
README.md
183
README.md
@@ -1,88 +1,125 @@
|
||||
### orion-ops-pro (orion-ops重构版)
|
||||
<h1 style="display: flex; align-items: center;">
|
||||
<img style="margin-right: 8px;" src="https://bjuimg.obs.cn-north-4.myhuaweicloud.com/images/2024/2/27/8c687ef1-5711-4a93-9db0-79c010af7902.png" width="32px" height="32px"/> orion-ops-pro 是什么
|
||||
</h1>
|
||||
|
||||
### 开发中
|
||||
`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 前端代码
|
||||
```
|
||||
<p style="text-align: left">
|
||||
<a target="_blank" style="text-decoration: none" href="https://app.codacy.com/gh/lijiahangmax/orion-ops-pro/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade">
|
||||
<img src="https://app.codacy.com/project/badge/Grade/49eaab3a9a474af3b87e1d21ffec71c4" alt="quality"/>
|
||||
</a>
|
||||
<a target="_blank" style="text-decoration: none" href="https://www.oracle.com/java/technologies/javase/javase-jdk8-downloads.html">
|
||||
<img src="https://img.shields.io/badge/JDK-8+-green.svg" alt="jdk8"/>
|
||||
</a>
|
||||
<a target="_blank" style="text-decoration: none" href="https://www.apache.org/licenses/LICENSE-2.0">
|
||||
<img src="https://img.shields.io/github/license/lijiahangmax/orion-ops-pro" alt="License"/>
|
||||
</a>
|
||||
<a target="_blank" style="text-decoration: none" href="https://gitee.com/lijiahangmax/orion-ops-pro/stargazers">
|
||||
<img src="https://gitee.com/lijiahangmax/orion-ops-pro/badge/star.svg?theme=dark" alt="star"/>
|
||||
</a>
|
||||
<a target="_blank" style="text-decoration: none" href="https://gitee.com/lijiahangmax/orion-ops-pro/members">
|
||||
<img src="https://gitee.com/lijiahangmax/orion-ops-pro/badge/fork.svg?theme=dark" alt="fork"/>
|
||||
</a>
|
||||
<!-- <a target="_blank" style="text-decoration: none" href="https://github.com/lijiahangmax/orion-ops-pro">
|
||||
<img src="https://img.shields.io/github/stars/lijiahangmax/orion-ops-pro.svg?style=social" alt="star"/>
|
||||
</a> -->
|
||||
</p>
|
||||
|
||||
<br/>
|
||||
|
||||
##### 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 免责声明 (注意事项) (在使用平台之前, 请确保您已经了解并同意相关的使用协议和隐私政策。) (为了数据安全, 请定期备份数据和配置, 以防意外丢失或损坏。))
|
||||
|
||||
## 功能预览
|
||||
|
||||
> 工作台
|
||||
|
||||
|
||||
|
||||
> 资产管理
|
||||
|
||||
|
||||
|
||||
|
||||
> 主机终端
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
> 用户管理
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
> 系统管理
|
||||
|
||||
|
||||
|
||||
|
||||
## 联系我
|
||||
|
||||
<div style="display: flex;">
|
||||
<img src="https://bjuimg.obs.cn-north-4.myhuaweicloud.com/images/2024/2/27/d452cd30-cecd-4236-86f5-5ecbf3eac091.jpg" alt="qq" width="268px" height="398px"/>
|
||||
<img src="https://bjuimg.obs.cn-north-4.myhuaweicloud.com/images/2024/2/27/4f1c4e77-8e36-45a3-8be6-9da5387bb96e.jpg" alt="wx" width="298px" height="398px"/>
|
||||
</div>
|
||||
|
||||
📧 微信添加备注: ops
|
||||
|
||||
## 支持一下
|
||||
|
||||
<img src="https://bjuimg.obs.cn-north-4.myhuaweicloud.com/images/2024/2/27/8063cf87-9de9-4df2-8009-d5dea6d69861.jpg" alt="收款码" width="540px"/>
|
||||
|
||||
🎁 为了项目能健康持续的发展, 我期望获得相应的资金支持, 你们的支持是我不断更新前进的动力!
|
||||
|
||||
## License
|
||||
|
||||
本项目遵循 [Apache-2.0](https://github.com/lijiahangmax/orion-ops-pro/blob/main/LICENSE) 开源许可证。
|
||||
|
||||
@@ -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
|
||||
|
||||
## 联系我
|
||||
|
||||
<img src="./assert/img/qq_group1.jpg" alt="qq" width="268px"/>
|
||||
<img src="./assert/img/wx.jpg" alt="wx" width="268px"/>
|
||||
<div style="display: flex;">
|
||||
<img src="./assert/img/qq_group1.jpg" alt="qq" width="268px" height="398px"/>
|
||||
<img src="./assert/img/wx.jpg" alt="wx" width="298px" height="398px"/>
|
||||
</div>
|
||||
|
||||
📧 微信添加备注: ops
|
||||
|
||||
|
||||
Reference in New Issue
Block a user