updated README

pull/78/MERGE
13621160019@163.com 2021-11-05 23:03:28 +08:00
parent 405fa656f4
commit f9fb61035d
4 changed files with 144 additions and 221 deletions

138
README.md
View File

@ -35,40 +35,42 @@ MyEMS由资深专业团队开发维护系统代码基于MIT开源软件许可
[4]. [Gitlab](https://gitlab.com/myems/myems) https://gitlab.com/myems/myems
[5]. [CODE CHINA](https://codechina.csdn.net/myems/myems) https://codechina.csdn.net/myems/myems
## MyEMS组件(社区版)
MyEMS项目由下列组件构成:
### MyEMS 数据库 (SQL)
[安装 数据库](./database/README.md)
详见 [database介绍与安装](./database/README.md)
### MyEMS API 应用程序接口 (Python)
[安装 myems-api](./myems-api/README.md)
详见 [myems-api介绍与安装](./myems-api/README.md)
### MyEMS 管理 UI (AngularJS version 1.x)
[安装 admin UI](./admin/README.md)
详见 [myems-admin介绍与安装](./admin/README.md)
### MyEMS Modbus TCP 数据采集服务 (Python)
[安装 myems-modbus-tcp](./myems-modbus-tcp/README.md)
详见 [myems-modbus-tcp介绍与安装](./myems-modbus-tcp/README.md)
### MyEMS 数据清洗服务 (Python)
[安装 myems-cleaning](./myems-cleaning/README.md)
详见 [myems-cleaning介绍与安装](./myems-cleaning/README.md)
### MyEMS 数据规范化服务 (Python)
[安装 myems-normalization](./myems-normalization/README.md)
详见 [myems-normalization介绍与安装](./myems-normalization/README.md)
### MyEMS 数据汇总服务 (Python)
[安装 myems-aggregation](./myems-aggregation/README.md)
详见 [myems-aggregation介绍与安装](./myems-aggregation/README.md)
### MyEMS Web UI (ReactJS)
[安装 web UI](./web/README.md)
详见 [myems-web介绍与安装](./web/README.md)
### 默认端口号
@ -99,125 +101,9 @@ administrator@myems.io
```
</details>
### Docker-Compose
### Docker-Compose 快速部署
除了上面的分步安装方式也可以使用docker-compose命令一键安装
#### 前提
- 主机已安装docker、docker-compose、npm
- MySQL数据库已安装拥有一个账号为root密码为!MyEMS1的用户
- MySQL数据库可正常登陆可被安装Docker的主机Ping通以及远程访问
#### 配置
注一:这里的主机指的是**安装Docker的主机**, 这里的IP和账号密码都为假定的用来展示说明实际情况中用户需要根据自己的配置改为自己的具体的修改步骤会在“安装”中讲述。
注二:这里如果**安装数据库和安装Docker的主机为同一个主机那么数据库IP和主机IP修改为一个实际IP**即可这里是以数据库和安装Docker的主机不在同一个上举例的。
| -- | -- |
| ---------- | ----------- |
| 主机IP | 192.168.0.1 |
| 数据库IP | 192.168.0.2 |
| 数据库账号 | root |
| 数据库密码 | !MyEMS1 |
#### Docker-Compose安装
1. 克隆仓库
```
git clone https://gitee.com/myems/myems.git
```
2. 数据库导入 (否则数据库没有用户信息,网页无法验证登录)
```
cd myems/database/install
mysql -u root -p < myems_billing_baseline_db.sql
mysql -u root -p < myems_billing_db.sql
mysql -u root -p < myems_energy_baseline_db.sql
mysql -u root -p < myems_energy_db.sql
mysql -u root -p < myems_fdd_db.sql
mysql -u root -p < myems_historical_db.sql
mysql -u root -p < myems_reporting_db.sql
mysql -u root -p < myems_system_db.sql
mysql -u root -p < myems_user_db.sql
```
注: 如有问题,详情可查看"database/README.md"
3. 修改配置
注:如“配置”所述,这里假定的**主机IP为 192.168.0.1数据库IP为 192.168.0.2数据库账号为root,数据库密码:!MyEMS1,用户应该修改为自己对应的主机IP,数据库IP,数据库账号,数据库密码**
3.1 修改nginx.conf里的API配置
```
cd myems
sed -i 's/127.0.0.1:8000/192.168.0.1:8000/g' admin/nginx.conf
sed -i 's/127.0.0.1:8000/192.168.0.1:8000/g' web/nginx.conf
```
3.2 复制example.env为.env并修改.env里的数据库IP账号密码
```
# 这里以修改数据库IP为例如果数据库账号密码也不同请根据自己需求替换.env里的账号密码
cd myems
cp myems-api/example.env myems-api/.env
sed -i 's/127.0.0.1/192.168.0.2/g' myems-api/.env
cp myems-aggregation/example.env myems-aggregation/.env
sed -i 's/127.0.0.1/192.168.0.2/g' myems-aggregation/.env
cp myems-cleaning/example.env myems-cleaning/.env
sed -i 's/127.0.0.1/192.168.0.2/g' myems-cleaning/.env
cp myems-modbus-tcp/example.env myems-modbus-tcp/.env
sed -i 's/127.0.0.1/192.168.0.2/g' myems-modbus-tcp/.env
cp myems-normalization/example.env myems-normalization/.env
sed -i 's/127.0.0.1/192.168.0.2/g' myems-normalization/.env
```
3.3 测试数据库是否可以正确连接
```
cd myems
python3 myems-api/test_mysql.py
```
注:如果测试通过,继续下一步操作,否则请修改.env配置。
4. Web UI 打包 (Web UI 为React项目需要打包为产品文件)
```
cd myems/web
npm install
npm run build
```
5. 运行docker-compose命令
```
cd myems
docker-compose up -d
```
6. 测试
| | 网址 | 结果 |
| ----- | ----------------------- | ---------------- |
| web | 192.168.0.1:80 | 输入账号密码登陆成功 |
| admin | 192.168.0.1:8001 | 输入账号密码登录成功 |
| api | 192.168.0.1:8000/spaces | 返回Json数据无报错 |
如果api测试报错请确认.env里的数据库IP数据库账号数据库密码是否正确如果不正确请修改.env后执行
```
docker-compose up --build -d
```
| -- | -- |
| ---------- | ----------- |
| web账号 | administrator@myems.io |
| web密码 | !MyEMS1 |
| admin账号 | administrator |
| admin密码 | !MyEMS1 |
如有问题欢迎创建Issue
详见 [Docker Compose 快速部署](docker-compose.md)
## 功能版本对比

View File

@ -34,41 +34,43 @@ MyEMS wird von einem erfahrenen Entwicklungsteam entwickelt und gewartet, und de
[4]. [Gitlab](https://gitlab.com/myems/myems) https://gitlab.com/myems/myems
[5]. [CODE CHINA](https://codechina.csdn.net/myems/myems) https://codechina.csdn.net/myems/myems
## MyEMS Komponenten (GCommunity Edition)
Dieses Projekt besteht aus folgenden Komponenten:
### MyEMS Database (SQL)
[Installieren database](./database/README.md)
Sehen [database Introduction & Installation](./database/README.md)
### MyEMS API (Python)
[Installieren myems-api](./myems-api/README.md)
Sehen [myems-api Introduction & Installation](./myems-api/README.md)
### MyEMS Admin UI (AngularJS)
[Installieren admin UI](./admin/README.md)
Sehen [myems-admin Introduction & Installation](./admin/README.md)
### MyEMS Modbus TCP Acquisition Service (Python)
[Installieren myems-modbus-tcp](./myems-modbus-tcp/README.md)
Sehen [myems-modbus-tcp Introduction & Installation](./myems-modbus-tcp/README.md)
### MyEMS Cleaning Service (Python)
[Installieren myems-cleaning](./myems-cleaning/README.md)
Sehen [myems-cleaning Introduction & Installation](./myems-cleaning/README.md)
### MyEMS Normalization Service (Python)
[Installieren myems-normalization](./myems-normalization/README.md)
Sehen [myems-normalization Introduction & Installation](./myems-normalization/README.md)
### MyEMS Aggregation Service (Python)
[Installieren myems-aggregation](./myems-aggregation/README.md)
Sehen [myems-aggregation Introduction & Installation](./myems-aggregation/README.md)
### MyEMS Web UI (ReactJS)
[Installieren web UI](./web/README.md)
Sehen [myems-web Introduction & Installation](./web/README.md)
### Standardports
@ -100,47 +102,9 @@ administrator@myems.io
```
</details>
### Docker Docker-compose Installieren
### Docker Compose Schnelle Bereitstellung
```
git clone https://gitee.com/myems/myems.git
```
Ändern Sie die Datenbankkonfiguration in den folgenden Dateien
Angenommen, die Datenbank-IP lautet 192.168.0.1
```
sudo nano myems-api/config.py
sudo nano myems-aggregation/config.py
sudo nano myems-cleaning/config.py
sudo nano myems-modbus-tcp/config.py
sudo nano myems-normalization/config.py
```
~~'host': '127.0.0.1'~~
'host': '192.168.0.1'
Ändern Sie den location '/api' von nginx.conf in web und admin
Angenommen, die Host-IP lautet 192.168.0.2
```
sudo nano admin/nginx.conf
sudo nano web/nginx.conf
```
~~proxy_pass http://127.0.0.1:8000/;~~
proxy_pass http://192.168.0.2:8000/;
Verpacken Sie das web, um Produktdateien zu generieren
```
cd myems/web
npm install
npm run build
```
Mit docker-compose installieren
```
cd myems
docker-compose up -d
```
Sehen [Docker Compose Schnelle Bereitstellung](docker-compose.md)
## Editionen vergleichen

View File

@ -34,41 +34,43 @@ MyEMS is being developed and maintained by an experienced development team, and
[4]. [Gitlab](https://gitlab.com/myems/myems) https://gitlab.com/myems/myems
[5]. [CODE CHINA](https://codechina.csdn.net/myems/myems) https://codechina.csdn.net/myems/myems
## MyEMS Components (Community Edition)
This project is compose of following components:
### MyEMS Database (SQL)
[Install database](./database/README.md)
See [database Introduction & Installation](./database/README.md)
### MyEMS API (Python)
[Install myems-api](./myems-api/README.md)
See [myems-api Introduction & Installation](./myems-api/README.md)
### MyEMS Admin UI (ReactJS)
[Install admin UI](./admin/README.md)
See [myems-admin Introduction & Installation](./admin/README.md)
### MyEMS Modbus TCP Acquisition Service (Python)
[Install myems-modbus-tcp](./myems-modbus-tcp/README.md)
See [myems-modbus-tcp Introduction & Installation](./myems-modbus-tcp/README.md)
### MyEMS Cleaning Service (Python)
[Install myems-cleaning](./myems-cleaning/README.md)
See [myems-cleaning Introduction & Installation](./myems-cleaning/README.md)
### MyEMS Normalization Service (Python)
[Install myems-normalization](./myems-normalization/README.md)
See [myems-normalization Introduction & Installation](./myems-normalization/README.md)
### MyEMS Aggregation Service (Python)
[Install myems-aggregation](./myems-aggregation/README.md)
See [myems-aggregation Introduction & Installation](./myems-aggregation/README.md)
### MyEMS Web UI (AngularJS)
[Install web UI](./web/README.md)
See [myems-web Introduction & Installation](./web/README.md)
### Default Ports
@ -99,47 +101,10 @@ administrator@myems.io
```
</details>
### Docker-compose Installation
### Docker Compose Repaid Deployment
```
git clone https://gitee.com/myems/myems.git
```
See [Docker Compose Repaid Deployment](docker-compose.md)
Modify Database IP in the following files
Assume the Database IP is 192.168.0.1
```
sudo nano myems-api/config.py
sudo nano myems-aggregation/config.py
sudo nano myems-cleaning/config.py
sudo nano myems-modbus-tcp/config.py
sudo nano myems-normalization/config.py
```
~~'host': '127.0.0.1'~~
'host': '192.168.0.1'
Modify location '/api' in nginx.conf of web and admin
Assume the Host IP is 192.168.0.2
```
sudo nano admin/nginx.conf
sudo nano web/nginx.conf
```
~~proxy_pass http://127.0.0.1:8000/;~~
proxy_pass http://192.168.0.2:8000/;
Build web for production
```
cd myems/web
npm install
npm run build
```
Install with docker-compose
```
cd myems
docker-compose up -d
```
## Compare Editions

108
docker-compose.md Normal file
View File

@ -0,0 +1,108 @@
## Docker Compose 快速部署
除了上面的分步安装方式也可以使用docker-compose命令一键安装
### 前提
- 主机已安装docker、docker-compose、npm
- MySQL数据库已安装拥有一个账号为root密码为!MyEMS1的用户
- MySQL数据库可正常登陆可被安装Docker的主机Ping通以及远程访问
### 配置
注一:这里的主机指的是**安装Docker的主机**, 这里的IP和账号密码都为假定的用来展示说明实际情况中用户需要根据自己的配置改为自己的具体的修改步骤会在“安装”中讲述。
注二:这里如果**安装数据库和安装Docker的主机为同一个主机那么数据库IP和主机IP修改为一个实际IP**即可这里是以数据库和安装Docker的主机不在同一个上举例的。
| -- | -- |
| ---------- | ----------- |
| 主机IP | 192.168.0.1 |
| 数据库IP | 192.168.0.2 |
| 数据库账号 | root |
| 数据库密码 | !MyEMS1 |
### Docker-Compose安装
1. 克隆仓库
```
git clone https://gitee.com/myems/myems.git
```
2. 数据库导入 (否则数据库没有用户信息,网页无法验证登录)
```
cd myems/database/install
mysql -u root -p < myems_billing_baseline_db.sql
mysql -u root -p < myems_billing_db.sql
mysql -u root -p < myems_energy_baseline_db.sql
mysql -u root -p < myems_energy_db.sql
mysql -u root -p < myems_fdd_db.sql
mysql -u root -p < myems_historical_db.sql
mysql -u root -p < myems_reporting_db.sql
mysql -u root -p < myems_system_db.sql
mysql -u root -p < myems_user_db.sql
```
注: 如有问题,详情可查看"database/README.md"
3. 修改配置
注:如“配置”所述,这里假定的**主机IP为 192.168.0.1数据库IP为 192.168.0.2数据库账号为root,数据库密码:!MyEMS1,用户应该修改为自己对应的主机IP,数据库IP,数据库账号,数据库密码**
3.1 修改nginx.conf里的API配置
```
cd myems
sed -i 's/127.0.0.1:8000/192.168.0.1:8000/g' admin/nginx.conf
sed -i 's/127.0.0.1:8000/192.168.0.1:8000/g' web/nginx.conf
```
3.2 复制example.env为.env并修改.env里的数据库IP账号密码
```
# 这里以修改数据库IP为例如果数据库账号密码也不同请根据自己需求替换.env里的账号密码
cd myems
cp myems-api/example.env myems-api/.env
sed -i 's/127.0.0.1/192.168.0.2/g' myems-api/.env
cp myems-aggregation/example.env myems-aggregation/.env
sed -i 's/127.0.0.1/192.168.0.2/g' myems-aggregation/.env
cp myems-cleaning/example.env myems-cleaning/.env
sed -i 's/127.0.0.1/192.168.0.2/g' myems-cleaning/.env
cp myems-modbus-tcp/example.env myems-modbus-tcp/.env
sed -i 's/127.0.0.1/192.168.0.2/g' myems-modbus-tcp/.env
cp myems-normalization/example.env myems-normalization/.env
sed -i 's/127.0.0.1/192.168.0.2/g' myems-normalization/.env
```
3.3 测试数据库是否可以正确连接
```
cd myems
python3 myems-api/test_mysql.py
```
注:如果测试通过,继续下一步操作,否则请修改.env配置。
4. Web UI 打包 (Web UI 为React项目需要打包为产品文件)
```
cd myems/web
npm install
npm run build
```
5. 运行docker-compose命令
```
cd myems
docker-compose up -d
```
6. 测试
| | 网址 | 结果 |
| ----- | ----------------------- | ---------------- |
| web | 192.168.0.1:80 | 输入账号密码登陆成功 |
| admin | 192.168.0.1:8001 | 输入账号密码登录成功 |
| api | 192.168.0.1:8000/version| 返回版本信息 |
如果api测试报错请确认.env里的数据库IP数据库账号数据库密码是否正确如果不正确请修改.env后执行
```
docker-compose up --build -d
```