chore: update readme

This commit is contained in:
pycook 2024-12-03 18:45:41 +08:00
parent 9f7a91ab26
commit 191ce95717
15 changed files with 30 additions and 73 deletions

View File

@ -27,7 +27,6 @@
<img src=docs/images/dashboard.png />
[查看更多展示](docs/screenshot.md)
### 相关文章
@ -51,14 +50,12 @@
### 主要功能
- 模型属性支持索引、多值、默认排序、字体颜色,支持计算属
- 支持自动发现、定时巡检、文件导入
- 自定义模型和模型关系,模型属性支持下拉列表、字体颜色、计算属性等高级特
- 支持计算机、网络设备、存储设备、数据库、中间件、公有云资源等自动发现
- 支持资源、层级、关系视图展示
- 支持模型间关系配置和展示
- 细粒度访问控制,完备的操作日志
- 支持跨模型搜索
- 通用的资源搜索和关系搜索
- 支持IP地址管理(IPAM), 数据中心基础设施管理(DCIM)

View File

@ -1,6 +1,6 @@
NODE_ENV=production
VUE_APP_PREVIEW=false
VUE_APP_API_BASE_URL=http://127.0.0.1:5000/api
VUE_APP_API_BASE_URL=/api
VUE_APP_BUILD_PACKAGES="ticket,calendar,acl"
VUE_APP_IS_OUTER=true
VUE_APP_IS_OPEN_SOURCE=true

View File

@ -1,8 +1,5 @@
<p align="center">
<a href="https://veops.cn"><img src="images/logo.png" alt="维易CMDB" width="300"/></a>
</p>
<h3 align="center">Simple, lightweight, and versatile operational CMDB</h3>
<h2 align="center">Simple, lightweight, and versatile operational CMDB</h2>
<p align="center">
<a href="https://github.com/veops/cmdb/blob/master/LICENSE"><img src="https://img.shields.io/badge/License-AGPLv3-brightgreen" alt="License: GPLv3"></a>
<a href="https:https://github.com/sendya/ant-design-pro-vue"><img src="https://img.shields.io/badge/UI-Ant%20Design%20Pro%20Vue-brightgreen" alt="UI"></a>
@ -24,17 +21,6 @@
## Overview
### System Overview
<img src=images/dashboard.png />
[View more screenshots](screenshot.md)
### Document
- <a href="https://zhuanlan.zhihu.com/p/98453732" target="_blank">Design Document</a>
- <a href="https://github.com/veops/cmdb/tree/master/docs/cmdb_api.md" target="_blank">API Documentation</a>
- <a href="https://mp.weixin.qq.com/s/EflmmJ-qdUkddTx2hRt3pA" target="_blank">Practice of Tree View</a>
### Features
@ -51,12 +37,12 @@
### Main Features
- Model attributes support indexing, multiple values, default sorting, font color, and computed properties.
- Support automatic discovery, scheduled inspections, and file import.
- Support resource, tree view, and relationship view display.
- Support configuration and display of relationships between models.
- Custom models and model relationships, with model attributes supporting advanced features such as dropdown lists, font colors, and computed attributes.
- Support for automatic discovery of computers, network devices, storage devices, databases, middleware, public cloud resources, etc.
- Support for displaying resource, hierarchy, and relationship views.
- Fine-grained access control and comprehensive operation logs.
- Support cross-model search.
- General resource and relationship search capabilities.
- Support for IP Address Management (IPAM) and Data Center Infrastructure Management (DCIM).
@ -68,7 +54,7 @@
### One-Click Docker Quick Build
> Method 1
[//]: # (> Method 1)
- step 1: **Prepare: install Docker and Docker Compose (v2)**
- step 2: copy the repository
```shell
@ -78,13 +64,20 @@ git clone https://github.com/veops/cmdb.git
```
docker compose up -d
```
> Method 2 Usefull for linux os.
- step 1: **Prepare: install Docker and Docker Compose (v2)**
- step 2: directly use the install.sh file in the project's root directory to `install`, `start`, `pause`, `status`, `delete`, and `uninstall` the application.
```shell
curl -so install.sh https://raw.githubusercontent.com/veops/cmdb/master/install.sh
sh install.sh install
```
[//]: # (> M**ethod 2 Usefull for linux os.)
[//]: # (- step 1: **Prepare: install Docker and Docker Compose &#40;v2&#41;**)
[//]: # (- step 2: directly use the install.sh file in the project's root directory to `install`, `start`, `pause`, `status`, `delete`, and `uninstall` the application. )
[//]: # (```shell)
[//]: # (curl -so install.sh https://raw.githubusercontent.com/veops/cmdb/master/install.sh )
[//]: # (sh install.sh install)
[//]: # (```**)
### [Local Setup](local_en.md)
@ -100,13 +93,9 @@ sh install.sh install
## Contributing
1. Fork it
1. Create your feature branch (`git checkout -b my-feature`)
1. Commit your changes (`git commit -am 'Add some feature'`)
1. Push to the branch (`git push origin my-feature`)
1. Create new Pull Request
2. Create your feature branch (`git checkout -b my-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-feature`)
5. Create new Pull Request
---
_**Welcome to pay attention to our public account, click to contact us, join WeChat, QQ operation and maintenance group, and get more product and industry related information**_
![QQgroup](images/qrcode_for_gzh.jpg)

Binary file not shown.

Before

Width:  |  Height:  |  Size: 98 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 57 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 273 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 41 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 78 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 82 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 365 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 19 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 245 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 200 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 191 KiB

After

Width:  |  Height:  |  Size: 51 KiB

View File

@ -1,29 +0,0 @@
### 系统概览
- 服务树
![1](images/0.png "首页展示")
- 资源视图
![2](images/2.png "资源视图")
- 订阅页面
![6](images/6.png "订阅页面")
- 模型配置
![9](images/9.png "模型配置")
- 属性设置
![7](images/7.png "属性设置")
- 资源搜索
![8](images/8.png "资源搜索")
- 定制仪表盘
![10](images/10.jpg "定制仪表盘")