7x31/cmdb
1
0
Fork 0
mirror of https://github.com/veops/cmdb.git synced 2025-08-11 15:46:13 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: update README

Browse Source
This commit is contained in:
songlh
2025-01-16 17:39:43 +08:00
parent 6a20e2f578
commit 3ea81987a1
8 changed files with 314 additions and 149 deletions
Download Patch File Download Diff File Expand all files Collapse all files

154
docs/README_en.md
View File

@@ -4,98 +4,120 @@
<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>
<a href="https://github.com/pallets/flask"><img src="https://img.shields.io/badge/API-Flask-brightgreen" alt="API"></a>
<a href="https://github.com/veops/cmdb/stargazers">
<img src="https://img.shields.io/github/stars/veops/cmdb" alt="Stars Badge"/>
</a>
<a href="https://github.com/veops/cmdb">
<img src="https://img.shields.io/github/forks/veops/cmdb" alt="Forks Badge"/>
</a>
</p>
<p align="center">
English · <a href="../README.md">中文(简体)</a>
</p>
------------------------------
## Introduce
VE CMDB is a simple, lightweight and highly customizable operations and maintenance configuration management database (CMDB). It supports flexible model configuration and resource auto-discovery, and is designed to provide organizations with a convenient asset management solution that helps operations teams efficiently manage IT infrastructure and services.
[English](README_en.md) / [中文](../README.md)
## DEMO ONLINE
- Product document：https://veops.cn/docs/
- Preview online: <a href="https://cmdb.veops.cn" target="_blank">CMDB</a>
- Product document：[https://veops.cn/docs/](https://veops.cn/docs/)
- Preview online: [https://cmdb.veops.cn](https://cmdb.veops.cn)
- username: demo
- password: 123456
> **ATTENTION**: branch `master` may be unstable as the result of continued development, please pull code from [releases](https://github.com/veops/cmdb/releases)
## Overview
- **ATTENTION**: branch `master` may be unstable as the result of continued development, Please use [releases](https://github.com/veops/cmdb/releases) to get the latest stable version
### Features
- **Custom Model and Model Relationships**: Supports customization of model attributes, including drop-down lists, font colors, calculated attributes and other advanced functions to meet different business needs.
- **Auto-discovery of resources**: supports auto-discovery of computers, network devices, storage devices, databases, middleware, public cloud resources, etc.
- **Multi-dimensional view display**: including resource view, hierarchical view, relationship view, etc., helping O&M personnel to comprehensively manage resources.
- **Fine-grained privilege control**: ensure system security through precise access control and complete operation logs.
- **Comprehensive Resource Search Function**: Supports flexible resource and relationship search to quickly locate and operate resources.
- **Integrated IP Address Management (IPAM) and Data Center Infrastructure Management (DCIM) features**: Simplify the management of network resources and data center equipment.
For more detailed features, please visit the [official website](https://veops.cn).
### System Characteristics
- Flexibility
1. Standardize and manage complex data assets
2. Automatically discover and inventory IT assets
+ No need to specify fixed operation and maintenance scenarios, supports free configuration and built-in multiple templates.
+ Support automatic discovery and inventory of IT assets, quickly set up an asset management system.
- Security
1. Fine-grained access control
2. Comprehensive operation logs
+ Fine-grained permission control mechanism to ensure the security of resource management.
+ Complete operation logs for easy auditing and problem tracking.
- Multi-application
1. Rich view display dimensions
2. Provide Restful API
3. Custom field triggers
+ Provides multiple views to meet the needs of different scenarios.
+ Powerful API interface supports deep integration.
+ Support for defining attribute triggers and calculating attributes to enhance data processing capabilities.
### Main Features
### Tech Stack
- 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.
- General resource and relationship search capabilities.
- Support for IP Address Management (IPAM) and Data Center Infrastructure Management (DCIM).
+ Back-end: Python [3.8-3.11].
+ Data Storage: MySQL, Redis
+ Front-end: Vue.js
+ UI component library: Ant Design Vue
### Overview
<table style="border-collapse: collapse; border: 1px solid black;">
<tr>
<td style="padding: 5px;background-color:#fff;">
<img width="400" src="./images/cmdb-screenshot-1.png"/>
</td>
<td style="padding: 5px;background-color:#fff;">
<img width="400" src="./images/cmdb-screenshot-2.png"/>
</td>
</tr>
### More Features
<tr>
<td style="padding: 5px;background-color:#fff;">
<img width="400" src="./images/cmdb-screenshot-3.png"/>
</td>
<td style="padding: 5px;background-color:#fff;">
<img width="400" src="./images/cmdb-screenshot-4.png"/>
</td>
</tr>
</table>
> Welcome to visit VeOps official website to discover more free operations and maintenance systems.
## Quick Start
## Installation
### 1. Set up
### One-Click Docker Quick Build
+ Option 1: Docker One-Click Quick Builds
[//]: # (> Method 1)
- step 1: **Prepare: install Docker and Docker Compose (v2)**
- step 2: copy the repository
```shell
git clone https://github.com/veops/cmdb.git
```
- step 3: In directory cmdb:
```
docker compose up -d
```
- Step 1: Install Docker environment and Docker Compose (v2)
- Step 2: Copy the project code, `git clone https://github.com/veops/cmdb.git`
- Step 3: Enter the home directory and start, `docker compose up -d`
[//]: # (> M**ethod 2 Usefull for linux os.)
+ [Local Setup](local_en.md)
+ [Installation with Makefile](makefile_en.md)
[//]: # (- step 1: **Prepare: install Docker and Docker Compose &#40;v2&#41;**)
### 2. Visit
- Open your browser and visit: [http://127.0.0.1:8000](http://127.0.0.1:8000)
- Username: demo or admin
- Password: 123456
[//]: # (- step 2: directly use the install.sh file in the project's root directory to `install`, `start`, `pause`, `status`, `delete`, and `uninstall` the application. )
## Access Company
[//]: # (```shell)
[//]: # (curl -so install.sh https://raw.githubusercontent.com/veops/cmdb/master/install.sh )
[//]: # (sh install.sh install)
[//]: # (```**)
### [Local Setup](local_en.md)
### [Installation with Makefile](makefile_en.md)
## Validation
- View: [http://127.0.0.1:8000](http://127.0.0.1:8000)
- username: demo or admin
- password: 123456
+ Companies using the open source CMDB are welcome to record in [#112](https://github.com/veops/cmdb/issues/112)
## Contributing
We welcome all developers to contribute code to improve and extend this project. Please read our [contribution guidelines](./CONTRIBUTING_en.md) first. Additionally, you can support Veops open source through social media, events, and sharing.
1. Fork it
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
<a href="https://github.com/veops/cmdb/graphs/contributors">
<img src="https://contrib.rocks/image?repo=veops/cmdb" />
</a>
---
## Enterprise Edition
Compared to the Community Edition, VE Enterprise Edition provides a large number of enhancements and technical support services for enterprises. Enhancements include data compliance, data cascading, auto-discovery extensions, large screen customization, and more. [Enterprise Edition Details](https://veops.cn/cmdb)
## VE Technology's other open source projects
- [OneTerm](https://github.com/veops/oneterm): Provide secure access and control over all infrastructure.
- [messenger](https://github.com/veops/messenger): A simple and lightweight message sending service.
- [ACL](https://github.com/veops/acl): A general permission control management system.
- [ops-tools](https://github.com/veops/ops-tools): Common practices and code for operations and maintenance.
## Contact me
+ Email: <a href="mailto:bd@veops.cn">bd@veops.cn</a>