Skip to content
This repository was archived by the owner on Apr 20, 2022. It is now read-only.

Commit 64884fd

Browse files
author
owefsad
committed
Release V1.0.3
1 parent 99d6473 commit 64884fd

File tree

2 files changed

+0
-273
lines changed

2 files changed

+0
-273
lines changed

‎README.MD‎

Lines changed: 0 additions & 139 deletions
Original file line numberDiff line numberDiff line change
@@ -1,139 +0,0 @@
1-
# DongTai-openapi
2-
3-
[![django-project](https://img.shields.io/badge/django%20versions-3.0.3-blue)](https://www.djangoproject.com/)
4-
[![DongTai-project](https://img.shields.io/badge/DongTai%20versions-beta-green)](https://huoxianclub.github.io/LingZhi/)
5-
[![DongTai--openapi](https://img.shields.io/badge/DongTai--openapi-v1.0.0-lightgrey)](https://huoxianclub.github.io/LingZhi/#/doc/tutorial/quickstart)
6-
7-
[![Deploy DongTai OpenAPI To AWS Test](https://github.com/HXSecurity/DongTai-openapi/actions/workflows/deploy_openapi_to_aws_test.yml/badge.svg)](https://github.com/HXSecurity/DongTai-openapi/actions/workflows/deploy_openapi_to_aws_test.yml)
8-
[![Deploy DongTai OpenAPI To AWS](https://github.com/HXSecurity/DongTai-openapi/actions/workflows/deploy_openapi_to_aws.yml/badge.svg)](https://github.com/HXSecurity/DongTai-openapi/actions/workflows/deploy_openapi_to_aws.yml)
9-
[![Release DongTai OpenAPI](https://github.com/HXSecurity/DongTai-openapi/actions/workflows/release_openapi.yml/badge.svg)](https://github.com/HXSecurity/DongTai-openapi/actions/workflows/release_openapi.yml)
10-
11-
[中文版本(Chinese version)](README.ZH-CN.MD)
12-
13-
## Whit is DongTai-Engine?
14-
DongTai-OpenAPI is used to process DongTai probe related requests, including:
15-
- Process agent registration request
16-
- Processing heartbeat data
17-
- Processing error log data
18-
- Processing third-party component data
19-
- Processing method call data
20-
- Processing authority registration/change and other data
21-
- Send probe control commands
22-
- Send hook strategy
23-
- Download detection engine, etc.
24-
25-
## Deploy
26-
27-
Basic services：MySql、DongTai-Engine
28-
29-
The basic service configuration is as follows：
30-
31-
| service name | ip | port | additional |
32-
| --- | --- | --- | --- |
33-
| MySql | 127.0.0.1 | 3306 | account：dongtai<br>password：dongtai-iast<br>database name：dongtai_webapi |
34-
| DongTai-Engine | 127.0.0.1 | 8081 | |
35-
36-
### Official image
37-
38-
1. Pull image
39-
```shell script
40-
$ docker pull registry.cn-beijing.aliyuncs.com/huoxian_pub/dongtai-openapi:1.0.0
41-
```
42-
43-
2. Create a configuration file：`/etc/dongtai/config.ini`，The content is as follows：
44-
```ini
45-
[mysql]
46-
host = 127.0.0.1
47-
port = 3306
48-
name = dongtai_webapi
49-
user = dongtai
50-
password = dongtai-iast
51-
52-
[redis]
53-
host = redis
54-
port = port
55-
password = password
56-
db = 0
57-
58-
59-
[engine]
60-
url = http://127.0.0.1:8081
61-
62-
; The following content unused, keep the default
63-
[apiserver]
64-
url = http://api_server_url
65-
66-
[smtp]
67-
server = server
68-
user = user
69-
password = password
70-
from_addr = from_addr
71-
ssl = False
72-
cc_addr = cc_addr
73-
74-
[aliyun_oss]
75-
access_key = access_key
76-
access_key_secret = access_key
77-
```
78-
79-
3. Start the `dongtai-openapi` container and map the configuration file
80-
```shell script
81-
$ docker run -d --name dongtai-openapi -p 8000:8000 -v /etc/dongtai/config.ini:/opt/dongtai/openapi/conf/config.ini --restart=always huoxian_pub/dongtai-openapi:1.0.0
82-
```
83-
84-
### Build custom image
85-
86-
1. Build image
87-
```shell script
88-
$ docker build -t huoxian_pub/dongtai-openapi:1.0.0 .
89-
```
90-
91-
2. Create a configuration file：`/etc/dongtai/config.ini`，The content is as follows：
92-
```ini
93-
[mysql]
94-
host = 127.0.0.1
95-
port = 3306
96-
name = dongtai_webapi
97-
user = dongtai
98-
password = dongtai-iast
99-
100-
[redis]
101-
host = redis
102-
port = port
103-
password = password
104-
db = 0
105-
106-
107-
[engine]
108-
url = http://127.0.0.1:8081
109-
110-
; The following content unused, keep the default
111-
[apiserver]
112-
url = http://api_server_url
113-
114-
[smtp]
115-
server = server
116-
user = user
117-
password = password
118-
from_addr = from_addr
119-
ssl = False
120-
cc_addr = cc_addr
121-
122-
[aliyun_oss]
123-
access_key = access_key
124-
access_key_secret = access_key
125-
```
126-
127-
3. Start the `dongtai-openapi` container and map the configuration file
128-
```shell script
129-
$ docker run -d --name dongtai-openapi -p 8000:8000 -v /etc/dongtai/config.ini:/opt/dongtai/openapi/conf/config.ini --restart=always huoxian_pub/dongtai-openapi:1.0.0
130-
```
131-
132-
### Contributing
133-
Contributions are welcomed and greatly appreciated. See [CONTRIBUTING.md](https://github.com/HXSecurity/DongTai/blob/main/CONTRIBUTING.md) for details on submitting patches and the contribution workflow.
134-
135-
Any questions? Let's discuss in [#DongTai discussions](https://github.com/HXSecurity/DongTai/discussions)
136-
137-
### More resources
138-
- [Documentation](https://hxsecurity.github.io/DongTai-Doc/#/)
139-
- [DongTai WebSite](https://iast.huoxian.cn/)

‎README.ZH-CN.MD‎

Lines changed: 0 additions & 134 deletions
Original file line numberDiff line numberDiff line change
@@ -1,134 +0,0 @@
1-
# DongTai-openapi
2-
3-
[![django-project](https://img.shields.io/badge/django%20versions-3.0.3-blue)](https://www.djangoproject.com/)
4-
[![DongTai-project](https://img.shields.io/badge/DongTai%20versions-beta-green)](https://huoxianclub.github.io/LingZhi/)
5-
[![DongTai--openapi](https://img.shields.io/badge/DongTai--openapi-v1.0.0-lightgrey)](https://huoxianclub.github.io/LingZhi/#/doc/tutorial/quickstart)
6-
7-
[![Deploy DongTai OpenAPI To AWS Test](https://github.com/HXSecurity/DongTai-openapi/actions/workflows/deploy_openapi_to_aws_test.yml/badge.svg)](https://github.com/HXSecurity/DongTai-openapi/actions/workflows/deploy_openapi_to_aws_test.yml)
8-
[![Deploy DongTai OpenAPI To AWS](https://github.com/HXSecurity/DongTai-openapi/actions/workflows/deploy_openapi_to_aws.yml/badge.svg)](https://github.com/HXSecurity/DongTai-openapi/actions/workflows/deploy_openapi_to_aws.yml)
9-
[![Release DongTai OpenAPI](https://github.com/HXSecurity/DongTai-openapi/actions/workflows/release_openapi.yml/badge.svg)](https://github.com/HXSecurity/DongTai-openapi/actions/workflows/release_openapi.yml)
10-
11-
[English](README.MD)
12-
13-
## 项目介绍
14-
DongTai-OpenAPI用于处理DongTai探针的相关请求，包括：
15-
- 处理agent注册请求
16-
- 处理心跳数据
17-
- 处理错误日志数据
18-
- 处理第三方组件数据
19-
- 处理方法调用数据
20-
- 处理权限注册/变更等数据
21-
- 发送探针控制指令
22-
- 发送hook策略
23-
- 下载检测引擎等
24-
25-
## 部署方案
26-
基础服务：MySql、DongTai-Engine
27-
28-
基础服务配置如下：
29-
30-
| 服务名称 | 地址 | 端口 | 其他配置 |
31-
| --- | --- | --- | --- |
32-
| MySql | 127.0.0.1 | 3306 | 账号：dongtai<br>密码：dongtai-iast<br>库名：dongtai_webapi |
33-
| DongTai-Engine | 127.0.0.1 | 8081 | |
34-
35-
### 官方镜像部署
36-
37-
1. 拉取官方镜像
38-
```shell script
39-
$ docker pull registry.cn-beijing.aliyuncs.com/huoxian_pub/dongtai-openapi:1.0.0
40-
```
41-
42-
2. 创建配置文件：`/etc/dongtai/config.ini`，内容如下：
43-
```ini
44-
[mysql]
45-
host = 127.0.0.1
46-
port = 3306
47-
name = dongtai_webapi
48-
user = dongtai
49-
password = dongtai-iast
50-
51-
[redis]
52-
host = redis
53-
port = port
54-
password = password
55-
db = 0
56-
57-
58-
[engine]
59-
url = http://127.0.0.1:8081
60-
61-
; 下面的内容未使用，保持默认
62-
[apiserver]
63-
url = http://api_server_url
64-
65-
[smtp]
66-
server = server
67-
user = user
68-
password = password
69-
from_addr = from_addr
70-
ssl = False
71-
cc_addr = cc_addr
72-
73-
[aliyun_oss]
74-
access_key = access_key
75-
access_key_secret = access_key
76-
```
77-
78-
3. 启动`dongtai-openapi`容器并映射配置文件
79-
```shell script
80-
$ docker run -d --name dongtai-openapi -p 8000:8000 -v /etc/dongtai/config.ini:/opt/dongtai/openapi/conf/config.ini --restart=always huoxian_pub/dongtai-openapi:1.0.0
81-
```
82-
83-
### 构建镜像部署
84-
85-
1. 构建镜像
86-
```shell script
87-
$ docker build -t huoxian_pub/dongtai-openapi:1.0.0 .
88-
```
89-
90-
2. 创建配置文件：`/etc/dongtai/config.ini`，内容如下：
91-
```ini
92-
[mysql]
93-
host = 127.0.0.1
94-
port = 3306
95-
name = dongtai_webapi
96-
user = dongtai
97-
password = dongtai-iast
98-
99-
[redis]
100-
host = redis
101-
port = port
102-
password = password
103-
db = 0
104-
105-
106-
[engine]
107-
url = http://127.0.0.1:8081
108-
109-
; 下面的内容未使用，保持默认
110-
[apiserver]
111-
url = http://api_server_url
112-
113-
[smtp]
114-
server = server
115-
user = user
116-
password = password
117-
from_addr = from_addr
118-
ssl = False
119-
cc_addr = cc_addr
120-
121-
[aliyun_oss]
122-
access_key = access_key
123-
access_key_secret = access_key
124-
```
125-
126-
3. 启动`dongtai-openapi`容器并映射配置文件
127-
```shell script
128-
$ docker run -d --name dongtai-openapi -p 8000:8000 -v /etc/dongtai/config.ini:/opt/dongtai/openapi/conf/config.ini --restart=always huoxian_pub/dongtai-openapi:1.0.0
129-
```
130-
131-
132-
### 文档
133-
- [官方文档](https://huoxianclub.github.io/LingZhi/#/)
134-
- [快速体验](http://aws.iast.huoxian.cn:8000/login)

0 commit comments

Comments
 (0)