From 9b5d4802e554615b79ea5cfb8a9c0fab3db9145f Mon Sep 17 00:00:00 2001 From: gitee-bot Date: Thu, 7 Aug 2025 14:51:32 +0000 Subject: [PATCH] Update README.md --- README.md | 101 +++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 100 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9a3c7d3..69e7982 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,101 @@ -# docker-insight + +# DockerInsight + +DockerInsight 是一个基于Docker的可视化管理平台,提供容器、镜像、网络、存储卷等Docker资源的管理功能。系统采用Spring Boot框架,结合docker-java库实现对Docker的远程管理。 + +## 主要功能 + +- **容器管理**:支持容器的列表展示、详情查看、启动、停止、删除等操作 +- **镜像管理**:支持镜像的列表展示、详情查看、启动容器、导出等操作 +- **网络管理**:管理Docker网络资源 +- **存储卷管理**:管理Docker存储卷 +- **文件系统管理**:支持远程主机文件的浏览、上传、下载、重命名、删除等操作 +- **Docker安装管理**:支持远程主机Docker环境的安装配置 + +## 技术架构 + +- 后端:Spring Boot + docker-java + MyBatis Plus +- 前端:Vue.js + Element UI +- 数据库:MySQL +- 容器化:Docker +- 构建工具:Maven + +## 安装部署 + +### Docker部署 + +```bash +# 构建镜像 +docker build -t di-lark-admin:latest -f lark-admin/Dockerfile . +docker build -t di-lark-ui:latest -f lark-ui/Dockerfile . + +# 运行容器 +docker run -d -it --restart=unless-stopped --net=host --name di-lark-admin di-lark-admin:latest +docker run -d -it --restart=unless-stopped -p 80:80 --name di-lark-ui di-lark-ui:latest +``` + +### 手动部署 + +1. **JDK8**:使用`install_tools/install_jdk8.sh`脚本安装JDK8 +2. **MySQL8**:使用`install_tools/install_mysql8.sh`脚本安装MySQL8 +3. **Nginx**:使用`install_tools/install_nginx.sh`脚本安装Nginx + +## API接口 + +### Docker安装相关接口 +- `GET /dockerinsight/dockerinstall/getHostSystemType/{ip}`:获取主机系统类型 +- `POST /dockerinsight/dockerinstall/addYumRepo`:添加Yum仓库 +- `GET /dockerinsight/dockerinstall/getDockerVersion`:获取可用Docker版本 +- `POST /dockerinsight/dockerinstall/install`:远程安装Docker + +### 容器管理 +- `GET /dockerinsight/container/list`:容器列表 +- `GET /dockerinsight/container/{id}`:容器详情 +- `POST /dockerinsight/container`:创建容器 +- `PUT /dockerinsight/container`:更新容器 +- `DELETE /dockerinsight/container/{ids}`:删除容器 + +### 镜像管理 +- `GET /dockerinsight/image/list`:镜像列表 +- `GET /dockerinsight/image/{id}`:镜像详情 +- `POST /dockerinsight/image/startImage`:启动容器 +- `POST /dockerinsight/image/removeImage`:删除镜像 +- `GET /dockerinsight/image/exportImage`:导出镜像 + +## 特色功能 + +- 支持本地和远程Docker主机管理 +- 提供文件系统操作功能,支持远程文件上传、下载、重命名等 +- 支持WebSocket终端连接,实现Web终端功能 +- 完善的权限控制,基于Spring Security实现RBAC +- 支持Docker版本的远程安装和配置 + +## 系统截图 +![DockerInsight](https://gitee.com/LarkMidTable/DockerInsight/raw/master/screenshot.png) + +## 开源协议 + +本项目采用[MIT](LICENSE)协议,欢迎商业使用 + +## 联系我们 + +- 项目地址:[https://gitee.com/LarkMidTable/DockerInsight](https://gitee.com/LarkMidTable/DockerInsight) +- 问题反馈:请通过项目Issue进行反馈 +- 技术交流:欢迎加入项目交流群 + +## 贡献指南 + +欢迎贡献代码!请遵循以下指南: +1. Fork本项目 +2. 创建feature分支 +3. 提交代码 +4. 创建Pull Request + +## 致谢 + +感谢以下开源项目的支持: +- [docker-java](https://github.com/docker-java/docker-java) +- [Spring Boot](https://spring.io/projects/spring-boot) +- [Vue.js](https://vuejs.org/) +- [Element UI](https://element.eleme.io/) \ No newline at end of file -- Gitee