Skip to content

Commit 676f79b

Browse files
author
yaopengbo
committed
add some english readme
1 parent c463a90 commit 676f79b

File tree

6 files changed

+75
-35
lines changed

6 files changed

+75
-35
lines changed

elkeidup/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Automated deployment of Elkeid tools
1313
* The back-end server used for deployment needs to ensure intranet interoperability
1414
* The backend server used for deployment requires root user privileges when deploying
1515
* The backend server used for deployment can only be used: Centos7 and above; Ubuntu16 and above; Debian9 and above
16-
* The server which execute elkeidup could execute ssh root@x.x.x.x without password to any backend server
16+
* The server which execute elkeidup could execute `ssh root@x.x.x.x` without password to any backend server
1717
* Deployment cannot be manually interrupted
1818
* Only cat use LAN IP, do not use 127.0.0.1 or hostname or public IP
1919
* Don't remove `~/.elkeidup` dir

elkeidup/deploy-zh_CN.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -157,4 +157,4 @@ cd /root/.elkeidup
157157
ko/sign文件的格式应该遵循:`hids_driver_1.7.0.4_{uname -r}_{arch}.ko/sign`格式, 文件需要放置在nginx对应服务器的:`/elkeid/nginx/ElkeidAgent/agent/component/driver/ko`下,并修改权限`chown -R nginx:nginx /elkeid/nginx`。放置完成后,重启Agent即可。
158158

159159
## 4、HTTPS配置
160-
请参考[Elkeid https配置文档](./https_config/https.md)
160+
请参考[Elkeid https配置文档](./https_config/https-zh_CN.md)

elkeidup/deploy_hub-zh_CN.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,4 +50,4 @@ cd /root/.elkeidup
5050
访问 elkeid_hub_frontend,参照 [Elkeid HUB 社区版快速上手教程](https://github.com/bytedance/Elkeid-HUB/blob/main/docs/quick_start/quick_start.md) 使用。
5151

5252
## 6、HTTPS配置
53-
请参考[Elkeid https配置文档](./https_config/https.md)
53+
请参考[Elkeid https配置文档](./https_config/https-zh_CN.md)

elkeidup/deploy_hub.md

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -15,19 +15,20 @@ wget https://github.com/bytedance/Elkeid/releases/download/v1.9.1/elkeidup_hub_v
1515
chmod a+x /root/.elkeidup/elkeidup
1616
```
1717
### 3、Generate and modify config.yaml
18-
If it is not a standalone deployment, please refer to the deployment resource manual to modify config.yaml
19-
ip为本机非 `127.0.0.1` ip,若不为单机部署,请参考[部署资源手册](./configuration-zh_CN.md)修改config.yaml
18+
If it is not a standalone deployment, please refer to the [deployment resource manual](./configuration.md) to modify config.yaml
19+
2020
```
2121
cd /root/.elkeidup
22-
## 生成hub only 配置
22+
## Generate hub only configurations
2323
./elkeidup init --host {ip} --hub_only
2424
mv config_example.yaml config.yaml
2525
```
26-
### 4、部署
26+
27+
### 4、Deployment
2728
```
2829
cd /root/.elkeidup
2930
30-
# 命令为交互式
31+
# Command is interactive
3132
./elkeidup deploy --hub_only
3233
3334
## status
@@ -37,18 +38,18 @@ cd /root/.elkeidup
3738
./elkeidup undeploy --hub_only
3839
```
3940

40-
### 5、访问HUB前端
41-
顺利安装完成后,执行`cat /root/.elkeidup/elkeid_passwd`将看到各组件的随机生成的密码和相关的url。
41+
### 5、Visit the HUB front end
42+
After a successful installation, executing `cat /root/.elkeidup/elkeid_passwd` will see the randomly generated passwords and associated URLs for each component.
4243

43-
| 字段 | 说明 |
44+
| Field | Description |
4445
| -------------------------- |------------------|
45-
| elkeid_hub_frontend | hub前端账号密码 |
46-
| grafana | grafana账号密码 |
47-
| grafana | grafana 地址 |
48-
| elkeid_hub_frontend | elkeid hub前端地址 |
49-
| elkeid_service_discovery | 服务发现地址 |
46+
| elkeid_hub_frontend | hub front-end account password |
47+
| grafana | grafana account password |
48+
| grafana | grafana address |
49+
| elkeid_hub_frontend | elkeid hub front-end address |
50+
| elkeid_service_discovery | Service Discovery Address |
5051

51-
访问 elkeid_hub_frontend,参照 [Elkeid HUB 社区版快速上手教程](https://github.com/bytedance/Elkeid-HUB/blob/main/docs/quick_start/quick_start.md) 使用。
52+
To access elkeid_hub_frontend, refer to the [Elkeid HUB Quick Start Tutorial](https://github.com/bytedance/Elkeid-HUB/blob/main/docs/quick_start/quick_start.md).
5253

53-
## 6、HTTPS配置
54-
请参考[Elkeid https配置文档](./https_config/https.md)
54+
## 6、HTTPS configuration
55+
Please refer to [Elkeid https configuration documentation](./https_config/https.md)

elkeidup/https_config/https-zh_CN.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Elkeid https配置文档
2+
3+
## 1 概述
4+
- 默认情况下,Elkeid Console监听在8082和8072端口,Elkeid HUB监听在8081和8071端口。
5+
- 如果需要使用HTTPS,可以使用8072和8071端口来访问。
6+
7+
| | Elkeid Console | Elkeid HUB Console |
8+
|-------|--------------------------|--------------------------|
9+
| HTTP | http://{{NignxIP}}:8082 | http://{{NignxIP}}:8081 |
10+
| HTTPS | https://{{NignxIP}}:8072 | https://{{NignxIP}}:8072 |
11+
12+
## 2、使用企业内部证书
13+
安装时生成的自签名证书位于nginx所在机器的 `/elkeid/nginx/nginx` 目录,包括以下两个文件:
14+
```
15+
server.key
16+
server.crt
17+
```
18+
替换上述两个文件后,执行以下操作即可:
19+
```
20+
chown -R nginx:nginx /elkeid/nginx
21+
systemctl restart elkeid_nginx
22+
```
23+
24+
## 3、使用部署时生成的自签名证书
25+
Elkeid 在部署时,仅能使用自签名证书,由于chrome的安全设置,无法直接访问,所有需要手动信任该证书才可使用https访问,具体操作参考如下:
26+
以下示例假设nginx所在服务器为 `console.elkeid.org`,并配置了`/etc/hosts`或dns解析。
27+
### 3.1、Macos
28+
1. 访问 `https://console.elkeid.org:8072/` 导出证书
29+
![cert1](001.png)
30+
![cert2](002.png)
31+
2. 导入导出的证书并信任
32+
![cert3](003.png)
33+
![cert4](004.png)
34+
![cert5](005.png)
35+
3. 点击钥匙串访问,信任证书
36+
![cert6](006.png)
37+
4. 再次访问 `https://console.elkeid.org:8072/`
38+
![cert7](007.png)
39+
![cert8](008.png)

elkeidup/https_config/https.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,39 @@
1-
# Elkeid https配置文档
1+
# Elkeid https configuration documentation
22

3-
## 1 概述
4-
- 默认情况下,Elkeid Console监听在8082和8072端口,Elkeid HUB监听在8081和8071端口。
5-
- 如果需要使用HTTPS,可以使用8072和8071端口来访问。
3+
## 1. Overview
4+
- By default, the Elkeid Console listens on ports 8082 and 8072, and the Elkeid HUB listens on ports 8081 and 8071.
5+
- If HTTPS is required, ports 8072 and 8071 can be used for access.
66

77
| | Elkeid Console | Elkeid HUB Console |
88
|-------|--------------------------|--------------------------|
99
| HTTP | http://{{NignxIP}}:8082 | http://{{NignxIP}}:8081 |
1010
| HTTPS | https://{{NignxIP}}:8072 | https://{{NignxIP}}:8072 |
1111

12-
## 2、使用企业内部证书
13-
安装时生成的自签名证书位于nginx所在机器的 `/elkeid/nginx/nginx` 目录,包括以下两个文件:
12+
## 2. Use an internal enterprise certificate
13+
The self-signed certificate generated during installation is located in the '/elkeid/nginx/nginx' directory on the machine where nginx is located, and includes the following two files:
1414
```
1515
server.key
1616
server.crt
1717
```
18-
替换上述两个文件后,执行以下操作即可:
18+
After replacing the above two files, do the following:
1919
```
20-
chown -R nginx:nginx /elkeid/nginx
20+
chown -R nginx: nginx /elkeid/nginx
2121
systemctl restart elkeid_nginx
2222
```
2323

24-
## 3、使用部署时生成的自签名证书
25-
Elkeid 在部署时,仅能使用自签名证书,由于chrome的安全设置,无法直接访问,所有需要手动信任该证书才可使用https访问,具体操作参考如下:
26-
以下示例假设nginx所在服务器为 `console.elkeid.org`,并配置了`/etc/hosts`或dns解析。
27-
### 3.1Macos
28-
1. 访问 `https://console.elkeid.org:8072/` 导出证书
24+
## 3. Use the self-signed certificate generated at deployment time
25+
When Elkeid is deployed, it can only use a self-signed certificate. Due to the security settings of chrome, it cannot be accessed directly. All you need to manually trust the certificate to access it using https. The specific operation is as follows:
26+
The following example hypotheses that the server where nginx is located is `console.elkeid.org` and has a configuration of `/etc/hosts` or dns parsing.
27+
### 3.1, Macos
28+
1. Access https://console.elkeid.org:8072/ Export Certificate
2929
![cert1](001.png)
3030
![cert2](002.png)
31-
2. 导入导出的证书并信任
31+
2. Import the exported certificate and trust it
3232
![cert3](003.png)
3333
![cert4](004.png)
3434
![cert5](005.png)
35-
3. 点击钥匙串访问,信任证书
35+
3. Click Keychain Access, Trust Certificate
3636
![cert6](006.png)
37-
4. 再次访问 `https://console.elkeid.org:8072/`
37+
4. Visit https://console.elkeid.org:8072/ again
3838
![cert7](007.png)
3939
![cert8](008.png)

0 commit comments

Comments
 (0)