diff --git a/README.md b/README.md index 065d4d6a..0e01615e 100644 --- a/README.md +++ b/README.md @@ -113,7 +113,7 @@ npm run docs:dev ``` 下载最新发行版,解压 cd aj-report-xxxx -vim conf/bootstrap.yml 修改数据库连接、上传下载地址等信息 +vim conf/bootstrap.yml 修改数据库连接、上传下载地址、jwt令牌等信息 sh bin/start.sh Linux启动 bin/start.bat Windows修改第4行的JAVA_HOME后(去掉rem注释),双击启动 @@ -145,7 +145,7 @@ sh build.sh unzip aj-report-xxxx.zip cd aj-report-xxxx -vim conf/bootstrap.yml 修改数据库连接、上传下载地址等信息 +vim conf/bootstrap.yml 修改数据库连接、上传下载地址、jwt令牌等信息 sh bin/start.sh Linux启动 bin/start.bat Windows修改第4行的JAVA_HOME后(去掉rem注释),双击启动 @@ -173,6 +173,10 @@ sql文件的目录在:report-core --> src --> main --> resources -- > db.migra 系统初始化时flyway会自动的将该目录下的sql文件执行,不需要手动执行sql文件,执行完将会创建 aj_report(存放系统基础数据)数据库
+**注意:** 如果sql初始化有问题,请将bootstrap.yml中flyway改为false,并手动执行这些sql
+ +示例数据sql目录在:doc/example,有需要的请手动执行
+ ## 谁在使用 感谢关注并使用AJ-Report的朋友,如果贵公司、组织、学校等正在使用AJ-Report,希望可以按照此[Issue](https://gitee.com/anji-plus/report/issues/I3ZXT4) diff --git a/doc/docs/guide/quicklyDistribution.md b/doc/docs/guide/quicklyDistribution.md index a910e15b..03907433 100644 --- a/doc/docs/guide/quicklyDistribution.md +++ b/doc/docs/guide/quicklyDistribution.md @@ -1,6 +1,6 @@ ``` 第一步,下载zip包,解压 - 第二步,conf->bootstrap.yml,修改数据库连接、上传下载地址等信息 + 第二步,conf->bootstrap.yml,修改数据库连接、上传下载地址、jwt令牌等信息 第三步,启动bin目录下start.sh 第四步,访问 http://localhost:9095 admin 123456 ``` @@ -23,17 +23,48 @@ 解压下载好的Zip包,找到bootstrap.yml
![img_1.png](../picture/quickly/img_17.png)
-将图中关于mysql的连接配置信息换成你使用的IP
-**注**:aj_report库是存放底层基础信息的库,flyway启动时会自动建立,如果你在这里修改了库,将会出错
+将图中关于mysql的连接配置信息换成你使用的IP:数据库名。如果没有修改flyway为false,那flyway会自动建立aj_report库
![bootstrap.png](../picture/quickly/img_2.png)
**注**:请确认你的Mysql是否支持远程连接,登陆用户是否有DDL权限
+```yaml + datasource: + url: jdbc:mysql://10.108.26.197:3306/aj_report?characterEncoding=UTF-8&serverTimezone=Asia/Shanghai&useSSL=false + username: root + password: appuser@anji +``` + ## OSS配置 OSS底层已支持minio、amazonS3、nfs,都配置的情况下优先级minio->amazonS3->nfs
![file.png](../picture/quickly/img.png)
+```yaml + gaea: + subscribes: + oss: #文件存储 都配置的情况下优先级minio->amazonS3->nfs + enabled: true + ##允许上传的文件后缀 + file-type-white-list: .png|.jpg|.gif|.icon|.pdf|.xlsx|.xls|.csv|.mp4|.avi|.jpeg|.aaa|.svg + # 用于文件上传成功后,生成文件的下载公网完整URL,http://serverip:9095/file/download,注意填写IP必须填写后端服务所在的机器IP + downloadPath: http://10.108.26.197:9095/file/download + nfs: + #上传对应本地全路径,注意目录不会自动创建,注意 Win是 \ 且有盘符,linux是 / 无盘符,注意目录权限问题 + path: /app/disk/upload/ +``` + +## jwt秘钥 + +生产环境请自行修改,避免被远程伪造登录攻击
+[随机密码生成器](http://www.chahuo.com/token-generator.html) + +```yaml + Security: + # jwt密钥,生产环境请自行修改,避免被远程伪造登录攻击 + jwtSecret: TybmmfrgsIqpPsBOYxvygCMVJWKNfDJU +``` + ## 启动 linux启动:
diff --git a/doc/docs/guide/quicklySeparate.md b/doc/docs/guide/quicklySeparate.md index 85162a7e..18b1e2d1 100644 --- a/doc/docs/guide/quicklySeparate.md +++ b/doc/docs/guide/quicklySeparate.md @@ -9,7 +9,7 @@ linux: git clone https://gitee.com/anji-plus/report.git 后端:report-code -修改bootstrap.yml 修改数据库连接、上传下载地址等信息 +修改bootstrap.yml 修改数据库连接、上传下载地址、jwt令牌等信息 maven package java -jar @@ -52,12 +52,13 @@ report-core --> src --> main --> resources --> bootstrap.yml
将图中关于mysql的连接配置信息换成你使用的IP
![bootstrap.png](../picture/quickly/img_2.png)
+**注**:请确认你的Mysql是否支持远程连接,登陆用户是否有DDL权限
-**注 :** - -``` -1、aj_report库是存放底层基础信息的库,flyway启动时会自动建立,如果你在这里修改了库,将会出错 -2、请确认你的Mysql是否支持远程连接,登陆用户是否有DDL权限 +```yaml + datasource: + url: jdbc:mysql://10.108.26.197:3306/aj_report?characterEncoding=UTF-8&serverTimezone=Asia/Shanghai&useSSL=false + username: root + password: appuser@anji ``` ### OSS配置 @@ -65,6 +66,31 @@ report-core --> src --> main --> resources --> bootstrap.yml
OSS底层已支持minio、amazonS3、nfs,都配置的情况下优先级minio->amazonS3->nfs
![file.png](../picture/quickly/img.png)
+```yaml + gaea: + subscribes: + oss: #文件存储 都配置的情况下优先级minio->amazonS3->nfs + enabled: true + ##允许上传的文件后缀 + file-type-white-list: .png|.jpg|.gif|.icon|.pdf|.xlsx|.xls|.csv|.mp4|.avi|.jpeg|.aaa|.svg + # 用于文件上传成功后,生成文件的下载公网完整URL,http://serverip:9095/file/download,注意填写IP必须填写后端服务所在的机器IP + downloadPath: http://10.108.26.197:9095/file/download + nfs: + #上传对应本地全路径,注意目录不会自动创建,注意 Win是 \ 且有盘符,linux是 / 无盘符,注意目录权限问题 + path: /app/disk/upload/ +``` + +### jwt秘钥 + +生产环境请自行修改,避免被远程伪造登录攻击
+[随机密码生成器](http://www.chahuo.com/token-generator.html) + +```yaml + Security: + # jwt密钥,生产环境请自行修改,避免被远程伪造登录攻击 + jwtSecret: TybmmfrgsIqpPsBOYxvygCMVJWKNfDJU +``` + ### maven打包 直接使用 maven package 打包,打包完成如图所示
@@ -74,8 +100,7 @@ OSS底层已支持minio、amazonS3、nfs,都配置的情况下优先级minio-> ``` 1、打包之前如果系统用的不止mysql数据源,需要自己在pom文件中加入对应的数据库的驱动,登陆系统之后,数据源提示无驱动,则选择通用JDBC数据源,这里不做演示了 -2、不要使用 maven install -3、此方式不会打包 lib目录下的驱动,详情可查看 "数据源->扩展" +2、此方式不会打包 lib目录下的驱动,详情可查看 "数据源->扩展" ``` ### linux启动jar包 @@ -85,6 +110,8 @@ OSS底层已支持minio、amazonS3、nfs,都配置的情况下优先级minio-> ## 前端编译 +**注意:** 每个版本前端可能会有些需要手动调整的部分,这里只写最公共的部分,如果有差异,请看对应版本的release文档。
+ ### install 进入前端目录:report-ui
@@ -107,6 +134,7 @@ OSS底层已支持minio、amazonS3、nfs,都配置的情况下优先级minio-> ### 前端部署 使用nginx做转发,以下内容仅供参考 + ```text server { listen 443 ssl; diff --git a/doc/docs/guide/quicklySource.md b/doc/docs/guide/quicklySource.md index 3c558a6d..4d13041f 100644 --- a/doc/docs/guide/quicklySource.md +++ b/doc/docs/guide/quicklySource.md @@ -6,7 +6,7 @@ sh build.sh unzip aj-report-xxxx.zip cd aj-report-xxxx -vim conf/bootstrap.yml 修改数据库连接、上传下载地址等信息 +vim conf/bootstrap.yml 修改数据库连接、上传下载地址、jwt令牌等信息 sh bin/start.sh 访问:http://serverip:9095 @@ -16,7 +16,7 @@ admin 123456 ## 编译环境 请在Linux上先准备好maven、node.js、jdk
-如果在Win10上部署,还需要下载一个 Git 软件,软件名就是 Git
+如果在Win10上部署,还需要下载一个 Git 软件,软件名就是 [Git](https://git-scm.com/downloads)
以下内容需要特别注意的地方会有对应提示。
- [Apache Maven] 3.5
@@ -55,17 +55,48 @@ git clone https://gitee.com/anji-plus/report.git
解压aj-report-xxxx.zip,找到bootstrap.yml
![img_1.png](../picture/quickly/img_17.png)
-将图中关于mysql的连接配置信息换成你使用的IP
-**注**:aj_report库是存放底层基础信息的库,flyway启动时会自动建立,如果你在这里修改了库,将会出错
+将图中关于mysql的连接配置信息换成你使用的IP:数据库名。如果没有修改flyway为false,那flyway会自动建立aj_report库
![bootstrap.png](../picture/quickly/img_2.png)
**注**:请确认你的Mysql是否支持远程连接,登陆用户是否有DDL权限
+```yaml + datasource: + url: jdbc:mysql://10.108.26.197:3306/aj_report?characterEncoding=UTF-8&serverTimezone=Asia/Shanghai&useSSL=false + username: root + password: appuser@anji +``` + ## OSS配置 OSS底层已支持minio、amazonS3、nfs,都配置的情况下优先级minio->amazonS3->nfs
![file.png](../picture/quickly/img.png)
+```yaml + gaea: + subscribes: + oss: #文件存储 都配置的情况下优先级minio->amazonS3->nfs + enabled: true + ##允许上传的文件后缀 + file-type-white-list: .png|.jpg|.gif|.icon|.pdf|.xlsx|.xls|.csv|.mp4|.avi|.jpeg|.aaa|.svg + # 用于文件上传成功后,生成文件的下载公网完整URL,http://serverip:9095/file/download,注意填写IP必须填写后端服务所在的机器IP + downloadPath: http://10.108.26.197:9095/file/download + nfs: + #上传对应本地全路径,注意目录不会自动创建,注意 Win是 \ 且有盘符,linux是 / 无盘符,注意目录权限问题 + path: /app/disk/upload/ +``` + +## jwt秘钥 + +生产环境请自行修改,避免被远程伪造登录攻击
+[随机密码生成器](http://www.chahuo.com/token-generator.html) + +```yaml + Security: + # jwt密钥,生产环境请自行修改,避免被远程伪造登录攻击 + jwtSecret: TybmmfrgsIqpPsBOYxvygCMVJWKNfDJU +``` + ## 启动 linux启动:
@@ -76,6 +107,8 @@ win10启动:
aj-report-XXX --> bin --> start.bat
双击start.bat启动
+**注意文件格式** + ## 日志位置 日志的位置是:report-xxx/logs/aj-report.log