diff --git a/README.md b/README.md index d0ae17608c58fef4ba8b3aba1cede4040c493056..321a9244db985acf9cf474633ccda11a8dbbff4b 100644 --- a/README.md +++ b/README.md @@ -6,18 +6,27 @@ - 由于原架构对新特性的开发支持并不是特别好,原代码结构混乱,打包方式不易,对读者部署阅读均不合适,因此计划重构。 + 计划使用Java重写原Go服务,使用SpringBoot框架代替Beego框架。作为一个Java开发者来说,使用Java语言开发更方便,对ISSUE也能更快的响应,虽然Go部署方便,但是一些同学本地开发很不方便 + 使用 React + TypeScript 重写GUI界面。 -+ 原存储服务使用MySQL 代替 Redis,Redis 还是作为缓存较好,作为存储服务还是有点弱。由于新版本将支持大量配置以及监控,日志等,因此使用MySQL这种结构数据库还是比较稳定的。 ++ 原存储服务使用 MySQL 代替 Redis,Redis 还是作为缓存较好,作为存储服务还是有点弱。由于新版本将支持大量配置以及监控,日志等,因此使用MySQL这种结构数据库还是比较稳定的。 + 重构方便偏向于安全、多Docker客户端、监控、提升稳定性 -Tip: 您可以在Issues中提出需求![需求 & BUG 管理](https://github.com/taoes/SimpleDocker/issues) +Tip: 您可以在Issues中提出需求![需求 & BUG 管理](https://github.com/taoes/SimpleDocker/issues) + +如过您计划贡献代码,可以查看[加入我们](./join.md) 查看如何贡献代码,我们鼓励并感谢您为开源做出的贡献 🌹 + +## 贡献者名单 + ++ [Taoes](https://toscode.gitee.com/taoes_admin) ++ [K8Scat](https://toscode.gitee.com/k8scat) ++ [Aweew](https://toscode.gitee.com/aweew) ++ [kevin_yin](https://toscode.gitee.com/kevin_yin) + --- ![xxx](doc/resource/img/icon.png) @@ -25,7 +34,7 @@ Tip: 您可以在Issues中提出需求![需求 & BUG 管理](https://github.co SimpleDocker 是一个简单的Docker控制面板,致力于可以让用户更方便、更无障碍、更舒适的使用Docker,其界面简洁、操作便捷,功能强大,可以带来更好地运维体验。 -**个人开发维护不易,求给个 Star ✨ 鼓励一下作者,您的鼓励是我最大的动力 💪🏻 !!!** +**开发维护不易,求给个 Star ✨ 鼓励一下作者,您的鼓励是我最大的动力 💪🏻 !!!** @@ -37,9 +46,6 @@ SimpleDocker 是一个简单的Docker控制面板,致力于可以让用户更 - - - ### 🎉 目前支持特性 | 特性 | 支持功能 | @@ -136,40 +142,10 @@ yarn install && yarn server 4. 打开相应的前端端口,即可访问,调试 -## 预览 - -+ 主页 - ![Docker 信息](doc/resource/img/home.jpg) -+ Docker 信息 - ![Docker 信息](doc/resource/img/info.png) - -+ Image 信息 - ![Image 信息](doc/resource/img/image.png) +## 界面预览 +您可以访问[界面预览](./preview.md) 查看项目的界面以及功能 -+ 运行新的容器 - ![Image 信息](doc/resource/img/runContainer.png) - -+ Container 信息 - ![Container 信息](doc/resource/img/container.png) - -+ 容器终端在线管理 - ![终端管理](doc/resource/img/terminal.png) - -+ 容器文件在线管理 - ![终端管理](doc/resource/img/file.png) - -+ 容器性能监控 - ![终端监控](doc/resource/img/monitor.png) - -+ 容器日志以及日志下载 - ![Image 信息](doc/resource/img/containerLog.png) - -+ Volume 信息 - ![Volume 信息](doc/resource/img/volume.png) - -+ Network 信息 - ![Network 信息](doc/resource/img/network.png) ## Q & A @@ -177,23 +153,12 @@ yarn install && yarn server > 忘记密码时候,你可以通过访问Redis服务的1号数据库,移除 `KEY=SIMPLE:DOCKER:AUTH:*`的所有KEY即可恢复默认密码 -## 相关依赖 - -- [GoLang](https://golang.org/) -- [Vuex](https://vuex.vuejs.org/) -- [VueJs 2.x](https://vuejs.org/) -- [Ant Design Vue](https://www.antdv.com/docs/vue/introduce-cn/) -- [Docker API Engine](https://docs.docker.com/engine/api/sdk/) -## 我的信息 -+ [燕归来兮的 GitEE ](https://gitee.com/taoes_admin) -+ [燕归来兮的 GitHub](https://github.com/taoes) -+ [燕归来兮的技术博客](https://www.zhoutao123.com) ## 讨论 -本项目完全开源,如有任何需求或者BUG反馈,欢迎提交Issue[Open an issue](https://github.com/taoes/SimpleDocker/issues/new) 或者提交PR! +本项目完全开源,如有任何需求或者BUG反馈,欢迎提交Issue[Open an issue](https://github.com/taoes/SimpleDocker/issues/new) 或者提交PR! 欢迎添加微信 `zhoutao825638` 或者邮件联系我 `zhoutao825638@vip.qq.com` ## 开源方案 diff --git a/join.md b/join.md new file mode 100644 index 0000000000000000000000000000000000000000..cf2923b9d1b3e239dc5bbfb63f9667349ef42fbd --- /dev/null +++ b/join.md @@ -0,0 +1,124 @@ +目前,SimpleDocker 重构版正在开发中,为了更好的进行开源合作,因此特记录此文件,以供二次开发和其他同学提交PR参考。 + +## 1、技术栈 + +本次开发的的模式为 B/S模型,分为服务端和浏览器端,其中服务端的主语言为 Java8, 浏览器端主语言为[TypeScript](https://www.typescriptlang.org/). 技术栈详情如下: + +#### 1.1 服务器端 + ++ 开发工具: JetBrains Idea ++ 编程语言: Java8 ++ 业务框架: SpringBoot 2.6 ++ 持久层: MySQL 8.0 + MyBatisPlus ++ 安全框架: Spring Security ++ 工具库: [Hutool](https://hutool.cn/) + +#### 1.2 浏览器端 + ++ 编程语言: [TypeScript](https://www.typescriptlang.org/)、CSS ++ 前端框架: [React18](https://zh-hans.reactjs.org/) ++ 网络请求:[Axios](https://www.axios.com/) ++ UI 组件库:[Ant Design](https://ant.design/) ++ 工具库: [Lodash](https://lodash.com/) + +## 2、如何本地启动 + +#### 2.1 服务端 + +服务端的启动需要安装 JDK8 以及MYSQL,其中MYSQL的数据库脚本为 `database/struct_data.sql` 在数据脚本执行完成后,修改`backend-src/src/main/resources/application-dev.yaml`文件内容的数据库URL,以及账号密码等信息,然后找到`backend-src/src/main/java/com/taoes/simpledocker/SimpleDockerApplication.java` 启动SpringBoot应用即可。 + + + +#### 2.2 前端 + +前端使用NodeJs构建编译,请安装稳定版本的NodeJS即可,无特殊版本要求。启动命令如下 + ++ npm + +```shell + npm install + npm run start +``` + ++ yarn(推荐) + +```shell + yarn install + yarn start +``` + + 启动成功后访问本地服务3000端口 [http://localhost:3000](http://localhost:3000) + +> 如遇端口冲突,react会启动在其他端口,一般为3001, 具体端口请参考启动日志 + + +## 3. 如何参与开发 + +目前开发进度主要通过微信群的方式协助,如果您有时间想为此项贡献力量,欢迎添加微信`zhoutao825638` 或者邮件联系我`zhoutao825638@vip.qq.com`. + +目前推荐的提交代码的方式如下: + ++ fork仓库到自己的账号下,拉取仓库代码并切换分支到refact分支 ++ 在refact分支上创建新的特性分支,然后再自己分支上提交代码并push到自己的fork仓库 ++ 在源仓库上创建PR请求,审核成功后即可合并到refact,完成特性分支建设。 + +如果您不了解如何贡献代码,可以参考 [如何提交一个PR](https://juejin.cn/post/6854573213200941063) + + + +## 4、目前进度如何 + +由于个人精力有限,重构的分支开发进展比较缓慢,目前基本功能已完成,为了同步协调,因此记录功能完成进度,以及未来的计划。 + +> 目前暂无好的需求管理软件,后面或尝试迁移 + +- [x] 镜像模块 + - [x] 基础镜像管理 + - [ ] 批量镜像管理 + - [ ] 镜像备份与导出 +- [x] 容器模块 + - [x] 容器基础管理 + - [ ] 批量容器管理 + - [x] 容器状态管理 + - [ ] 容器备份与导出 + - [x] 容器在线终端 + - [x] 本地容器终端 + - [x] 远程容器终端 + + - [ ] 容器在线文件管理 + - [ ] 本地文件管理 + - [ ] 远程文件管理 + - [ ] 文件导出与上传 + - [ ] 文件备份 +- [x] 存储模块 + - [x] 存储卷基本管理 +- [x] 网络模块 + - [x] 网络基础管理 + - [ ] 网络与容器关系 +- [x] 多端模块 + - [x] 多Docker服务器链接 + - [x] 本地链接 + - [x] 远程链接 + - [ ] 远程SSL链接 + - [ ] Docker数据源配置 +- [x] 权限模块 + - [x] 基础用户管理 + - [ ] 权限管理 + - [ ] 对容器管理 + - [ ] 对镜像管理 + - [ ] 对网络管理 + +- [x] 监控模块 + - [x] 社交软件通知 + - [ ] 钉钉 + - [ ] 飞书 + - [ ] 企业微信 + - [x] 监控变更记录 + - [ ] 自定义WebHook + - [ ] 容器资源监 + - [ ] CPU监控 + - [ ] 内存监控 + - [ ] 状态监控 + + + diff --git a/preview.md b/preview.md new file mode 100644 index 0000000000000000000000000000000000000000..dc6e325e97fc629ca82d6bf0feb32350442d5453 --- /dev/null +++ b/preview.md @@ -0,0 +1,34 @@ +## 预览 + ++ 主页 + ![Docker 信息](doc/resource/img/home.jpg) + ++ Docker 信息 + ![Docker 信息](doc/resource/img/info.png) + ++ Image 信息 + ![Image 信息](doc/resource/img/image.png) + ++ 运行新的容器 + ![Image 信息](doc/resource/img/runContainer.png) + ++ Container 信息 + ![Container 信息](doc/resource/img/container.png) + ++ 容器终端在线管理 + ![终端管理](doc/resource/img/terminal.png) + ++ 容器文件在线管理 + ![终端管理](doc/resource/img/file.png) + ++ 容器性能监控 + ![终端监控](doc/resource/img/monitor.png) + ++ 容器日志以及日志下载 + ![Image 信息](doc/resource/img/containerLog.png) + ++ Volume 信息 + ![Volume 信息](doc/resource/img/volume.png) + ++ Network 信息 + ![Network 信息](doc/resource/img/network.png) \ No newline at end of file