Skip to content

Commit 191ce95

Browse files
committed
chore: update readme
1 parent 9f7a91a commit 191ce95

15 files changed

Lines changed: 30 additions & 73 deletions

File tree

README.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@
2727

2828
<img src=docs/images/dashboard.png />
2929

30-
[查看更多展示](docs/screenshot.md)
3130

3231
### 相关文章
3332

@@ -51,14 +50,12 @@
5150

5251
### 主要功能
5352

54-
- 模型属性支持索引、多值、默认排序、字体颜色,支持计算属性
55-
- 支持自动发现、定时巡检、文件导入
53+
- 自定义模型和模型关系,模型属性支持下拉列表、字体颜色、计算属性等高级特性
54+
- 支持计算机、网络设备、存储设备、数据库、中间件、公有云资源等自动发现
5655
- 支持资源、层级、关系视图展示
57-
- 支持模型间关系配置和展示
5856
- 细粒度访问控制,完备的操作日志
59-
- 支持跨模型搜索
60-
61-
57+
- 通用的资源搜索和关系搜索
58+
- 支持IP地址管理(IPAM), 数据中心基础设施管理(DCIM)
6259

6360

6461

cmdb-ui/.env

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
NODE_ENV=production
22
VUE_APP_PREVIEW=false
3-
VUE_APP_API_BASE_URL=http://127.0.0.1:5000/api
3+
VUE_APP_API_BASE_URL=/api
44
VUE_APP_BUILD_PACKAGES="ticket,calendar,acl"
55
VUE_APP_IS_OUTER=true
66
VUE_APP_IS_OPEN_SOURCE=true

docs/README_en.md

Lines changed: 25 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,5 @@
11

2-
<p align="center">
3-
<a href="https://veops.cn"><img src="images/logo.png" alt="维易CMDB" width="300"/></a>
4-
</p>
5-
<h3 align="center">Simple, lightweight, and versatile operational CMDB</h3>
2+
<h2 align="center">Simple, lightweight, and versatile operational CMDB</h2>
63
<p align="center">
74
<a href="https://github.com/veops/cmdb/blob/master/LICENSE"><img src="https://img.shields.io/badge/License-AGPLv3-brightgreen" alt="License: GPLv3"></a>
85
<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 @@
2421
2522
## Overview
2623

27-
### System Overview
28-
29-
<img src=images/dashboard.png />
30-
31-
[View more screenshots](screenshot.md)
32-
33-
### Document
34-
35-
- <a href="https://zhuanlan.zhihu.com/p/98453732" target="_blank">Design Document</a>
36-
- <a href="https://github.com/veops/cmdb/tree/master/docs/cmdb_api.md" target="_blank">API Documentation</a>
37-
- <a href="https://mp.weixin.qq.com/s/EflmmJ-qdUkddTx2hRt3pA" target="_blank">Practice of Tree View</a>
3824

3925
### Features
4026

@@ -51,12 +37,12 @@
5137

5238
### Main Features
5339

54-
- Model attributes support indexing, multiple values, default sorting, font color, and computed properties.
55-
- Support automatic discovery, scheduled inspections, and file import.
56-
- Support resource, tree view, and relationship view display.
57-
- Support configuration and display of relationships between models.
40+
- Custom models and model relationships, with model attributes supporting advanced features such as dropdown lists, font colors, and computed attributes.
41+
- Support for automatic discovery of computers, network devices, storage devices, databases, middleware, public cloud resources, etc.
42+
- Support for displaying resource, hierarchy, and relationship views.
5843
- Fine-grained access control and comprehensive operation logs.
59-
- Support cross-model search.
44+
- General resource and relationship search capabilities.
45+
- Support for IP Address Management (IPAM) and Data Center Infrastructure Management (DCIM).
6046

6147

6248

@@ -68,7 +54,7 @@
6854

6955
### One-Click Docker Quick Build
7056

71-
> Method 1
57+
[//]: # (> Method 1)
7258
- step 1: **Prepare: install Docker and Docker Compose (v2)**
7359
- step 2: copy the repository
7460
```shell
@@ -78,13 +64,20 @@ git clone https://github.com/veops/cmdb.git
7864
```
7965
docker compose up -d
8066
```
81-
> Method 2 Usefull for linux os.
82-
- step 1: **Prepare: install Docker and Docker Compose (v2)**
83-
- step 2: directly use the install.sh file in the project's root directory to `install`, `start`, `pause`, `status`, `delete`, and `uninstall` the application.
84-
```shell
85-
curl -so install.sh https://raw.githubusercontent.com/veops/cmdb/master/install.sh
86-
sh install.sh install
87-
```
67+
68+
[//]: # (> M**ethod 2 Usefull for linux os.)
69+
70+
[//]: # (- step 1: **Prepare: install Docker and Docker Compose &#40;v2&#41;**)
71+
72+
[//]: # (- step 2: directly use the install.sh file in the project's root directory to `install`, `start`, `pause`, `status`, `delete`, and `uninstall` the application. )
73+
74+
[//]: # (```shell)
75+
76+
[//]: # (curl -so install.sh https://raw.githubusercontent.com/veops/cmdb/master/install.sh )
77+
78+
[//]: # (sh install.sh install)
79+
80+
[//]: # (```**)
8881

8982

9083
### [Local Setup](local_en.md)
@@ -100,13 +93,9 @@ sh install.sh install
10093
## Contributing
10194

10295
1. Fork it
103-
1. Create your feature branch (`git checkout -b my-feature`)
104-
1. Commit your changes (`git commit -am 'Add some feature'`)
105-
1. Push to the branch (`git push origin my-feature`)
106-
1. Create new Pull Request
96+
2. Create your feature branch (`git checkout -b my-feature`)
97+
3. Commit your changes (`git commit -am 'Add some feature'`)
98+
4. Push to the branch (`git push origin my-feature`)
99+
5. Create new Pull Request
107100

108101
---
109-
110-
_**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**_
111-
112-
![QQgroup](images/qrcode_for_gzh.jpg)

docs/images/1.png

-97.6 KB
Binary file not shown.

docs/images/10.jpg

-57.3 KB
Binary file not shown.

docs/images/2.png

-273 KB
Binary file not shown.

docs/images/3.png

-41.3 KB
Binary file not shown.

docs/images/4.png

-77.6 KB
Binary file not shown.

docs/images/5.png

-82.3 KB
Binary file not shown.

docs/images/6.png

-365 KB
Binary file not shown.

0 commit comments

Comments
 (0)