[home]feature: support home docs i18n en (#94)

* [home]feature: support home docs i18n en * [home]feature: i18n update introduce * [web-app]i18n for zh-TW * [home]feature: i18n update docs
2022-04-17 21:36:13 +08:00
parent 630c571f28
commit 81896f9ba1
57 changed files with 4553 additions and 499 deletions
--- a/home/i18n/en/docusaurus-plugin-content-docs/current/start/docker-deploy.md
+++ b/home/i18n/en/docusaurus-plugin-content-docs/current/start/docker-deploy.md
@@ -17,7 +17,7 @@ sidebar_label: Docker方式部署
 2. 拉取HertzBeat Docker镜像   
   镜像版本TAG可查看[官方镜像仓库](https://hub.docker.com/r/tancloud/hertzbeat/tags)     
   ``` 
-   $ docker pull tancloud/hertzbeat:latest 
+   $ docker pull tancloud/hertzbeat:[版本tag]   
   ```
 3. 配置HertzBeat的配置文件  
   在主机目录下创建application.yml，eg:/opt/application.yml   
@@ -39,19 +39,112 @@ sidebar_label: Docker方式部署
   
   ```

-4. 启动HertzBeat Docker容器  
+4. 配置用户配置文件(非必须,配置账户需要)     
+   HertzBeat默认内置三个用户账户,分别为 admin/admin tom/tom@123 lili/lili   
+   若需要新增删除修改账户或密码，可以通过配置 `sureness.yml` 实现，若无此需求可忽略此步骤  
+   在主机目录下创建sureness.yml，eg:/opt/sureness.yml  
+   配置文件内容参考 项目仓库[/script/sureness.yml](https://gitee.com/dromara/hertzbeat/blob/master/script/sureness.yml)
+   
+   ```yaml
+   
+   resourceRole:
+   - /account/auth/refresh===post===[role1,role2,role3,role4]
+   
+   excludedResource:
+   - /account/auth/**===*
+   - /===get
+   - /i18n/**===get
+   - /apps/hierarchy===get
+   - /console/**===get
+   - /**/*.html===get
+   - /**/*.js===get
+   - /**/*.css===get
+   - /**/*.ico===get
+   - /**/*.ttf===get
+   - /**/*.png===get
+   - /**/*.gif===get
+   - /**/*.png===*
+   - /swagger-resources/**===get
+   - /v2/api-docs===get
+   - /v3/api-docs===get
+   
+   # 用户账户信息
+   # 下面有 admin tom lili 三个账户
+   # eg: admin 拥有[role1,role2]角色,密码为admin
+   # eg: tom 拥有[role1,role2,role3],密码为tom@123
+   # eg: lili 拥有[role1,role2],明文密码为lili, 加盐密码为1A676730B0C7F54654B0E09184448289
+   account:
+   - appId: admin
+     credential: admin
+     role: [role1,role2]
+   - appId: tom
+     credential: tom@123
+     role: [role1,role2,role3]
+   - appId: lili
+     # 注意 Digest认证不支持加盐加密的密码账户
+     # 加盐加密的密码，通过 MD5(password+salt)计算
+     # 此账户的原始密码为 lili
+     credential: 1A676730B0C7F54654B0E09184448289
+     salt: 123
+     role: [role1,role2]
+   ```
+   
+   修改sureness.yml的如下**部分参数**：**[注意⚠️sureness配置的其它默认参数需保留]**  
+   
+   ```yaml
+   
+   # 用户账户信息
+   # 下面有 admin tom lili 三个账户
+   # eg: admin 拥有[role1,role2]角色,密码为admin
+   # eg: tom 拥有[role1,role2,role3],密码为tom@123
+   # eg: lili 拥有[role1,role2],明文密码为lili, 加盐密码为1A676730B0C7F54654B0E09184448289  
+   account:
+   - appId: admin
+     credential: admin
+     role: [role1,role2]
+   - appId: tom
+     credential: tom@123
+     role: [role1,role2,role3]
+   - appId: lili
+     # 注意 Digest认证不支持加盐加密的密码账户
+     # 加盐加密的密码，通过 MD5(password+salt)计算
+     # 此账户的原始密码为 lili
+     credential: 1A676730B0C7F54654B0E09184448289
+     salt: 123
+     role: [role1,role2]
+   ```
+
+6. 启动HertzBeat Docker容器  
   ``` 
-   $ docker run -d -p 1157:1157 -v /opt/application.yml:/opt/hertzbeat/config/application.yml --name hertzbeat tancloud/hertzbeat:latest
+   $ docker run -d -p 1157:1157 -v /opt/application.yml:/opt/hertzbeat/config/application.yml -v /opt/sureness.yml:/opt/hertzbeat/config/sureness.yml --name hertzbeat tancloud/hertzbeat:[版本tag]
   526aa188da767ae94b244226a2b2eec2b5f17dd8eff592893d9ec0cd0f3a1ccd
   ```
   这条命令启动一个运行HertzBeat的Docker容器，并且将容器的1157端口映射到宿主机的1157端口上。若宿主机已有进程占用该端口，则需要修改主机映射端口。
   - docker run -d : 通过Docker运行一个容器,使其在后台运行
   - -p 1157:1157  : 映射容器端口到主机端口
-   - -v /opt/application.yml:/opt/hertzbeat/config/application.yml  : 挂载上一步修改的本地配置文件到容器中，即使用本地配置文件覆盖容器配置文件。我们需要修改此配置文件的MYSQL，TDengine配置信息来连接外部服务。
+   - -v /opt/application.yml:/opt/hertzbeat/config/application.yml  : 挂载上上一步修改的本地配置文件到容器中，即使用本地配置文件覆盖容器配置文件。我们需要修改此配置文件的MYSQL，TDengine配置信息来连接外部服务。
+   - -v /opt/sureness.yml:/opt/hertzbeat/config/sureness.yml  : (非必须)挂载上一步修改的账户配置文件到容器中，若无修改账户需求可删除此命令参数。  
   - --name hertzbeat : 命名容器名称 hertzbeat 
-   - tancloud/hertzbeat:latest : 使用拉取的HertzBeat官方发布的应用镜像来启动容器 
-   
-5. 开始探索HertzBeat  
-   浏览器访问 http://ip:1157 开始使用HertzBeat进行监控告警。
+   - tancloud/hertzbeat:[版本tag] : 使用拉取的HertzBeat官方发布的应用镜像来启动容器,TAG可查看[官方镜像仓库](https://hub.docker.com/r/tancloud/hertzbeat/tags)   

-**HAVE FUN**
+7. 开始探索HertzBeat  
+   浏览器访问 http://ip:1157/console 开始使用HertzBeat进行监控告警，默认账户密码 admin/admin。  
+
+**HAVE FUN**   
+
+### Docker部署常见问题   
+
+1. **MYSQL,TDENGINE和HertzBeat都Docker部署在同一主机上，HertzBeat使用localhost或127.0.0.1连接数据库失败**     
+此问题本质为Docker容器访问宿主机端口连接失败，由于docker默认网络模式为Bridge模式，其通过localhost访问不到宿主机。
+> 解决办法一：配置application.yml将数据库的连接地址由localhost修改为宿主机的对外IP     
+> 解决办法二：使用Host网络模式启动Docker，即使Docker容器和宿主机共享网络 `docker run -d --network host .....`   
+
+2. **按照流程部署，访问 http://ip:1157/console 无界面**   
+请参考下面几点排查问题：  
+> 一：依赖服务MYSQL数据库，TDENGINE数据库是否已按照启动成功，对应hertzbeat数据库是否已创建，SQL脚本是否执行    
+> 二：HertzBeat的配置文件 `application.yml` 里面的依赖服务IP账户密码等配置是否正确  
+> 三：若都无问题可以 `docker logs hertzbeat` 查看容器日志是否有明显错误，提issue或交流群或社区反馈
+
+3. **日志报错TDengine连接或插入SQL失败**  
+> 一：排查配置的数据库账户密码是否正确，数据库是否创建   
+> 二：若是安装包安装的TDengine2.3+，除了启动server外，还需执行 `systemctl start taosadapter` 启动 adapter    
--- a/home/i18n/en/docusaurus-plugin-content-docs/current/start/mysql-init.md
+++ b/home/i18n/en/docusaurus-plugin-content-docs/current/start/mysql-init.md
@@ -17,14 +17,18 @@ MYSQL是一款值得信赖的关系型数据库，HertzBeat使用其存储监控
   ```
 2. Docker安装MYSQl  
   ```
-   $ docker run -d --name mysql -p 3306:3306 -e MYSQL_ROOT_PASSWORD=123456 mysql:latest
+   $ docker run -d --name mysql -p 3306:3306 -v /opt/data:/var/lib/mysql -e MYSQL_ROOT_PASSWORD=123456 mysql:5.7
   526aa188da767ae94b244226a2b2eec2b5f17dd8eff594533d9ec0cd0f3a1ccd
   ```
+   `-v /opt/data:/var/lib/mysql` 为mysql数据目录本地持久化挂载，需将`/opt/data`替换为实际本地存在的目录           
   使用```$ docker ps```查看数据库是否启动成功

 ### SQL脚本执行   
-1. 进入MYSQL或使用客户端连接MYSQL服务
-2. 创建名称为hertzbeat的数据库
+1. 进入MYSQL或使用客户端连接MYSQL服务   
+   `mysql -uroot -p123456`  
+2. 创建名称为hertzbeat的数据库    
+   `create database hertzbeat;`
 3. 执行位于项目仓库/script/sql/目录下的数据库建表初始化脚本 [schema.sql](https://gitee.com/dromara/hertzbeat/raw/master/script/sql/schema.sql)  
+   `mysql -uroot -p123456 < schema.sql`   
 4. 查看hertzbeat数据库是否成功建表

--- a/home/i18n/en/docusaurus-plugin-content-docs/current/start/package-deploy.md
+++ b/home/i18n/en/docusaurus-plugin-content-docs/current/start/package-deploy.md
@@ -23,9 +23,9 @@ sidebar_label: 安装包方式部署
 3. 配置HertzBeat的配置文件    
   解压安装包到主机 eg: /opt/hertzbeat
   ``` 
-   $ tar zxvf hertzbeat-1.0.tar.gz 
+   $ tar zxvf hertzbeat-[版本号].tar.gz 
   ```
-   修改位于 hertzbeat/config/application.yml 的配置文件      
+   修改位于 `hertzbeat/config/application.yml` 的配置文件      
   需要替换里面的MYSQL服务和TDengine服务参数，IP端口账户密码（若使用邮件告警，需替换里面的邮件服务器参数）
   具体替换参数如下:
   ``` 
@@ -43,13 +43,51 @@ sidebar_label: 安装包方式部署
   spring.mail.password
   
   ```
+4. 配置用户配置文件(非必须,配置账户需要)     
+   HertzBeat默认内置三个用户账户,分别为 admin/admin tom/tom@123 lili/lili   
+   若需要新增删除修改账户或密码，可以通过修改位于 `hertzbeat/config/sureness.yml` 的配置文件实现，若无此需求可忽略此步骤 
+   修改sureness.yml的如下**部分参数**：**[注意⚠️sureness配置的其它默认参数需保留]**

-4. 部署启动
+   ```yaml
+   # 用户账户信息
+   # 下面有 admin tom lili 三个账户
+   # eg: admin 拥有[role1,role2]角色,密码为admin
+   # eg: tom 拥有[role1,role2,role3],密码为tom@123
+   # eg: lili 拥有[role1,role2],明文密码为lili, 加盐密码为1A676730B0C7F54654B0E09184448289  
+   account:
+   - appId: admin
+     credential: admin
+     role: [role1,role2]
+   - appId: tom
+     credential: tom@123
+     role: [role1,role2,role3]
+   - appId: lili
+     # 注意 Digest认证不支持加盐加密的密码账户
+     # 加盐加密的密码，通过 MD5(password+salt)计算
+     # 此账户的原始密码为 lili
+     credential: 1A676730B0C7F54654B0E09184448289
+     salt: 123
+     role: [role1,role2]
+   ```
+
+5. 部署启动
   执行位于安装目录hertzbeat/bin/下的启动脚本 startup.sh 
   ``` 
   $ ./startup.sh 
   ```
-5. 开始探索HertzBeat  
-   浏览器访问 http://ip:1157 开始使用HertzBeat进行监控告警。
+6. 开始探索HertzBeat  
+   浏览器访问 http://ip:1157/console 开始使用HertzBeat进行监控告警，默认账户密码 admin/admin。  

 **HAVE FUN**
+
+### 安装包部署常见问题
+
+1. **按照流程部署，访问 http://ip:1157/console 无界面**   
+   请参考下面几点排查问题：
+> 一：依赖服务MYSQL数据库，TDENGINE数据库是否已按照启动成功，对应hertzbeat数据库是否已创建，SQL脚本是否执行    
+> 二：HertzBeat的配置文件 `hertzbeat/config/application.yml` 里面的依赖服务IP账户密码等配置是否正确    
+> 三：若都无问题可以查看 `hertzbeat/logs/` 目录下面的运行日志是否有明显错误，提issue或交流群或社区反馈
+
+2. **日志报错TDengine连接或插入SQL失败**
+> 一：排查配置的数据库账户密码是否正确，数据库是否创建   
+> 二：若是安装包安装的TDengine2.3+，除了启动server外，还需执行 `systemctl start taosadapter` 启动 adapter    
--- a/home/i18n/en/docusaurus-plugin-content-docs/current/start/quickstart.md
+++ b/home/i18n/en/docusaurus-plugin-content-docs/current/start/quickstart.md
@@ -1,46 +1,63 @@
 ---
 id: quickstart  
-title: 快速开始    
-sidebar_label: 快速开始    
+title: Quick Start    
+sidebar_label: Quick Start    
 ---

-### 🐕 开始使用
+### 🐕 Quick Start

- 如果您不想部署而是直接使用，我们提供SAAS监控云-[TanCloud探云](https://console.tancloud.cn)，即刻[登录注册](https://console.tancloud.cn)免费使用。  
- 如果您是想将HertzBeat部署到内网环境搭建监控系统，请参考下面的部署文档进行操作。 
+- If you don’t want to deploy but use it directly, we provide [SAAS Monitoring Cloud-TanCloud](https://console.tancloud.cn), **[Log In And Register For Free](https://console.tancloud.cn) **.
+- If you want to deploy HertzBeat local, please refer to the following [Deployment Documentation](https://hertzbeat.com/docs/start/quickstart) for operation.

-### 🐵 依赖服务部署   
+### 🐵 Dependency Service Deployment   

-> HertzBeat最少依赖于 关系型数据库[MYSQL8+](https://www.mysql.com/) 和 时序性数据库[TDengine2+](https://www.taosdata.com/getting-started)
+> HertzBeat depends at least on relational database [MYSQL5+](https://www.mysql.com/) and time series database [TDengine2+](https://www.taosdata.com/getting-started)

-##### 安装MYSQL  
-1. docker安装MYSQl  
-`docker run -d --name mysql -p 3306:3306 -e MYSQL_ROOT_PASSWORD=123456 mysql`   
-2. 创建名称为hertzbeat的数据库  
-3. 执行位于项目仓库/script/sql/目录下的数据库脚本 [schema.sql](https://gitee.com/dromara/hertzbeat/raw/master/script/sql/schema.sql)      

-详细步骤参考 [依赖服务MYSQL安装初始化](mysql-init.md)    
+##### Install MYSQL
+1. Install mysql with docker    
+   `docker run -d --name mysql -p 3306:3306 -e MYSQL_ROOT_PASSWORD=123456 mysql:5.7`
+2. Create database names `hertzbeat`
+3. Run the database sql script [schema.sql](https://gitee.com/dromara/hertzbeat/raw/master/script/sql/schema.sql) located in the project repository `/script/sql/` directory.

-##### 安装TDengine   
-1. docker安装TDengine   
-`docker run -d -p 6030-6049:6030-6049 -p 6030-6049:6030-6049/udp --name tdengine tdengine/tdengine`     
-2. 创建名称为hertzbeat的数据库
+For detailed steps, refer to [MYSQL Installation And Initialization](https://hertzbeat.com/docs/start/mysql-init)

-详细步骤参考 [依赖服务TDengine安装初始化](tdengine-init.md)   
+##### Install TDengine
+1. Install TDengine with docker     
+   `docker run -d -p 6030-6049:6030-6049 -p 6030-6049:6030-6049/udp --name tdengine tdengine/tdengine:2.4.0.12`
+2. Create database names `hertzbeat`

-### 🍞 HertzBeat安装   
-> HertzBeat支持通过源码安装启动，Docker容器运行和安装包方式安装部署。  
+For detailed steps, refer to [TDengine Installation And Initialization](https://hertzbeat.com/docs/start/tdengine-init).

-#### Docker方式快速安装
-`docker run -d -p 1157:1157 --name hertzbeat tancloud/hertzbeat:latest`  
+### 🍞 Install HertzBeat

-详细步骤参考 [通过Docker方式安装HertzBeat](docker-deploy.md) 
+> HertzBeat supports installation through source code, docker or package.

-#### 通过安装包安装    
-1. 下载您系统环境对应的安装包 [GITEE Release](https://gitee.com/dromara/hertzbeat/releases) [GITHUB Release](https://github.com/dromara/hertzbeat/releases)  
-2. 配置HertzBeat的配置文件 hertzbeat/config/application.yml   
-3. 部署启动 `$ ./startup.sh `   
+##### 1：Install quickly via docker
+`docker run -d -p 1157:1157 -v /opt/application.yml:/opt/hertzbeat/config/application.yml --name hertzbeat tancloud/hertzbeat:[版本tag]`

-详细步骤参考 [通过安装包安装HertzBeat](package-deploy.md) 
+Detailed steps refer to [Install HertzBeat via Docker](https://hertzbeat.com/docs/start/docker-deploy)
+
+##### 2：Install via package
+1. Download the installation package [GITEE Release](https://gitee.com/dromara/hertzbeat/releases) [GITHUB Release](https://github.com/dromara/hertzbeat/releases)
+2. Configure the HertzBeat configuration yml file `hertzbeat/config/application.yml`
+3. Run shell `$ ./startup.sh `
+4. Access `localhost:1157` to start, default account: `admin/admin`
+
+Detailed steps refer to [Install HertzBeat via package](https://hertzbeat.com/docs/start/package-deploy)
+
+##### 3：Start via source code
+1. Local source code debugging needs to start the back-end project manager and the front-end project web-app.
+2. Backend：need `maven3+`, `java8+`, start the manager service.
+3. Web：need `nodejs npm angular-cli` environment, Run `ng serve --open` in `web-app` directory after backend startup.
+4. Access `localhost:4200` to start, default account: `admin/admin`
+
+Detailed steps refer to [CONTRIBUTING](CONTRIBUTING.md)
+
+##### 4：Install All(mysql+tdengine+hertzbeat) via Docker-compose
+
+Install and deploy the mysql database, tdengine database and hertzbeat at one time through [docker-compose deployment script](script/docker-compose).
+
+Detailed steps refer to [docker-compose install](script/docker-compose/README.md)

 **HAVE FUN**
--- a/home/i18n/en/docusaurus-plugin-content-docs/current/start/tdengine-init.md
+++ b/home/i18n/en/docusaurus-plugin-content-docs/current/start/tdengine-init.md
@@ -18,9 +18,11 @@ TDengine是一款国产的开源物联网时序型数据库，我们使用其替
   ```
 2. Docker安装TDengine
   ```
-   $ docker run -d -p 6030-6049:6030-6049 -p 6030-6049:6030-6049/udp --name tdengine tdengine/tdengine
+   $ docker run -d -p 6030-6049:6030-6049 -p 6030-6049:6030-6049/udp -v /opt/taosdata:/var/lib/taos --name tdengine -e TZ=Asia/Shanghai tdengine/tdengine:2.4.0.12
   526aa188da767ae94b244226a2b2eec2b5f17dd8eff594533d9ec0cd0f3a1ccd
   ```
+   `-v /opt/taosdata:/var/lib/taos` 为tdengine数据目录本地持久化挂载，需将`/opt/taosdata`替换为实际本地存在的目录  
+   `-e TZ="Asia/Shanghai"` 为tdengine设置时区，这里可选设置对应的时区   
   使用```$ docker ps```查看数据库是否启动成功

 ### 创建数据库实例    
@@ -48,3 +50,6 @@ TDengine是一款国产的开源物联网时序型数据库，我们使用其替
   taos> show databases;
   taos> use hertzbeat;
   ```
+
+**注意⚠️若是安装包安装的TDengine2.3+版本**       
+> 除了启动server外，还需执行 `systemctl start taosadapter` 启动 adapter