Skip to content

Commit

Permalink
fix markdown ci
Browse files Browse the repository at this point in the history
  • Loading branch information
ljemq committed Jul 12, 2024
1 parent 2029d2d commit a8e30d2
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 22 deletions.
20 changes: 10 additions & 10 deletions ecp/en_US/edge_service/batch_intall.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,16 +37,16 @@ After the installation is complete, you need to open the remote access port of t

1. If the Docker API enables TLS authentication, the edge node deployed as the server needs to configure the CA certificate, server certificate and server private key of the Docker API. ECP as the client needs to configure the CA certificate, client certificate and client private key of the Docker API. For specific configuration methods, please refer to [Docker TLS authentication](https://docs.docker.com/engine/security/https/).

1. You can download the certificate file and script from [this link](https://github.com/emqx/emqx-ecp-docs/tree/main/ecp/resource/docker-tls)
:::tip Note
This certificate is for testing only.
Please use a self-signed certificate in a production environment.
:::
2. Modify the IP address in extfile.cnf to the IP address exposed by the edge node that deploys the Docker Engine service externally. This IP address is also the IP address that needs to be entered in ECP when adding [edge nodes](#edge-node-management).
![extfile](./_assets/extfile.png)
3. Execute the gen-docker-cert.sh script to generate the server certificate: server-cert.pem, the default password: `1111`;
![gen-docker-cert](./_assets/gen-docker-cert.png)
4. Copy the generated `server-cert.pem` certificate file and `ca.pem`, `server-key.pem` files to the specified directory of the edge node, such as: `/root/docker-tls/ca.pem`, `/root/docker-tls/server-cert.pem`, `/root/docker-tls/server-key.pem` directory.
1). You can download the certificate file and script from [this link](https://github.com/emqx/emqx-ecp-docs/tree/main/ecp/resource/docker-tls)
:::tip Note
This certificate is for testing only.
Please use a self-signed certificate in a production environment.
:::
2). Modify the IP address in extfile.cnf to the IP address exposed by the edge node that deploys the Docker Engine service externally. This IP address is also the IP address that needs to be entered in ECP when adding [edge nodes](#edge-node-management).
![extfile](./_assets/extfile.png)
3). Execute the gen-docker-cert.sh script to generate the server certificate: server-cert.pem, the default password: `1111`;
![gen-docker-cert](./_assets/gen-docker-cert.png)
4). Copy the generated `server-cert.pem` certificate file and `ca.pem`, `server-key.pem` files to the specified directory of the edge node, such as: `/root/docker-tls/ca.pem`, `/root/docker-tls/server-cert.pem`, `/root/docker-tls/server-key.pem` directory.

2. Find the docker service configuration file, the default is: `/usr/lib/systemd/system/docker.service`, you can see the location of the file through the `systemctl status docker` command.
![docker_service](./_assets/docker_service.png)
Expand Down
14 changes: 8 additions & 6 deletions ecp/en_US/install/install_ecp_on_linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,23 +54,25 @@ Press Enter to skip all, which means that the default ECP version is used, the i
### Start ECP Service

- If necessary, modify the configuration file `emqx_ecp.conf`. - If the `ElasticSearch` service already exists, the following configuration may be modified:
`shell

```shell
# telegraf config

TELEGRAF_EXTERNAL_PORT=10514
EL_URL="https://elasticsearch:9200"
EL_USERNAME="elastic"
EL_PASSWORD="elastic"
`
```

:::tip Note
If ElasticSearch connection information is incorrectly configured, the logging function is unavailable, but other functions are not affected.
:::

- Execute the following command to start the ECP service.
`shell
./emqx_ecp_ctl start
`

```shell
./emqx_ecp_ctl start
```

:::tip Note
When starting the ECP service for the first time, you need to pull the software image from the public image repository, which may take some time. You can also [contact us](https://www.emqx.com/en/contact?product=emqx-ecp) to get the offline installation package.
:::
Expand Down
14 changes: 8 additions & 6 deletions ecp/zh_CN/install/install_ecp_on_linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,23 +53,25 @@ EMQX ECP 部署前,请确认您的环境满足以下要求:
### 启动服务

- 如有必要, 可以修改配置文件 `emqx_ecp.conf`。 - 如已有 `ElasticSearch` 服务, 可能修改如下配置:
`shell

```shell
# telegraf config

TELEGRAF_EXTERNAL_PORT=10514
EL_URL="https://elasticsearch:9200"
EL_USERNAME="elastic"
EL_PASSWORD="elastic"
`
```

:::tip 注意
若没有正确配置 ElasticSearch 连接信息, 日志功能将不可用, 但不影响其它功能。
:::

- 执行以下命令,启动 ECP 服务。
`shell
./emqx_ecp_ctl start
`

```shell
./emqx_ecp_ctl start
```

:::tip 注意
在初次启动 ECP 服务时,需要从 ECP 镜像拉取软件镜像,可能需要等待一段时间。您也可以[联系我们](https://www.emqx.com/zh/contact?product=emqx-ecp),获取离线安装包。
:::
Expand Down

0 comments on commit a8e30d2

Please sign in to comment.