Merge pull request #991 from scottsut/master

feat: 1.0.0-beta.2 release

Deployment.md

@@ -1,14 +1,58 @@
 ---
-title: 部署
+部署
 ---
 
-## 0 demo
+# 0. 在线体验 Demo
 
 - http://datart-demo.retech.cc
 - 用户名：demo
 - 密码：123456
 
-## 1 环境准备
+# 1. Docker 部署
+
+```shell
+docker run -p 8080:8080 datart/datart 
+```
+启动后可访问 <http://docker_ip:8080>  
+默认账户:用户名`demo`,密码`123456`
+
+## 1.1. 配置外部数据库
+在没有外部数据库配置的情况下，Datart使用H2作为应用程序数据库。 强烈建议您将自己的Mysql数据库配置为应用程序数据库。  
+
+创建空文件 `datart.conf` ,将以下内容粘贴到到文件中。
+
+```shell
+# 数据库连接配置
+datasource.ip=   
+datasource.port=
+datasource.database=
+datasource.username=
+datasource.password=
+
+# server
+server.port=8080
+server.address=0.0.0.0
+
+# datart config
+datart.address=http://127.0.0.1
+datart.send-mail=false
+datart.webdriver-path=http://127.0.0.1:4444/wd/hub
+```
+
+运行 `docker run -d --name datart -v your_path/datart.conf:/datart/config/datart.conf -p 8080:8080 datart/datart`
+
+## 1.2. 将用户文件挂载到外部
+
+默认配置下，用户文件（头像，文件数据源等）保存在 `files` 文件夹下，将这个路径挂载到外部，以在进行应用升级时，能够保留这些文件。
+
+在配置文件中增加参数 `-v your_path/files:/datart/files` 即可。以下是完整命令
+
+`docker run -d --name datart -v your_path/datart.conf:/datart/config/datart.conf -v your_path/files:/datart/files -p 8080:8080 datart/datart`
+
+***更多配置，访问 <http://running-elephant.gitee.io/datart-docs/docs/index.html> ***
+
+# 2. 本地部署 
+## 2.1. 环境准备
 
 - JDK 1.8+
 - MySql5.7+
@@ -40,35 +84,49 @@ unzip datart-server-1.0.0-beta.x-install.zip
 
 ```
 
-## 2 初始化数据库
+## 2.2. 以独立模式运行
+
+安装包解压后，即可运行 ./bin/datart-server.sh start 来启动datart,启动后默认访问地址是: <http://127.0.0.1:8080>,默认用户`demo/123456`
+
+***独立模式使用内置数据库作为应用数据库，数据的安全性和数据迁移无法保证，建议配置外部数据库作为应用数据库***
+
+## 2.3. 配置外部数据库，要求Mysql5.7及以上版本。
 
-- 创建数据库，并将bin/datart.sql导入到数据库中
+- 创建数据库，指定数据库编码为utf8
 
 ```bash
 mysql> CREATE DATABASE `datart` CHARACTER SET 'utf8' COLLATE 'utf8_general_ci';
-mysql> use datart;
-mysql> source bin/datart.sql
 ```
 
-## 3 修改配置文件
+***注意：1.0.0-beta.2版本以前，需要手动执行`bin/datart.sql`来初始化数据库。此版本及以上版本，创建好数据库即可，在初次连接时会自动初始化数据库***
+
+***首次连接数据库(或者版本升级)时,建议使用一个权限较高的数据库账号登录(如root账号)。因为首次连接会执行数据库初始化脚本，如果使用的数据库账号权限太低，会导致数据库初始化失败***
+
+- 基础配置：配置文件位于 config/datart.conf
 
-- 配置文件位于 config/application-config.yml.example，先重命名为application-config.yml
 ```bash
-   mv ${DATART_HOME}/config/application-config.yml.example  ${DATART_HOME}/config/application-config.yml
-
-   需要修改的配置项:
-      1. 数据库连接信息(必须)
-      2. 邮件配置(注册需邮箱激活时必须)
-      3. 浏览器截图驱动(可选-需要使用定时任务邮件发送图表截图时可配置)
-      4. Redis(可选-需要使用缓存时可配置)
-    具体配置见下述:
-
+   数据库配置(必填):
+    1. datasource.ip(数据库IP地址)
+    2. datasource.port(数据库端口数据库端口)
+    3. datasource.database(指定数据库)
+    4. datasource.username(用户名)
+    5. datasource.password(密码)
+
+   其它配置(选填):
+    1. server.port(应用绑定端口地址,默认8080)
+    2. server.address(应用绑定IP地址,默认 0.0.0.0)
+    3. datart.address(datart 外部可访问地址,默认http://127.0.0.1)
+    4. datart.send-mail(用户注册是否使用邮件激活,默认 false )
+    5. datart.webdriver-path(截图驱动)
 ```
 
+## 2.4. 高级配置 (可选) : 配置文件位于 config/profiles/application-config.yml
 
-### 3.1 配置文件信息
+***高级配置文件格式是yml格式,配置错误会导致程序无法启动。配置时一定要严格遵循yml格式。***
 
-***注：请务必保留连接串中的`allowMultiQueries=true`参数***
+***application-config.yml直接由spring-boot处理,其中的oauth2,redis,mail等配置项完全遵循spring-boot-autoconfigure配置***
+
+### 2.4.1 配置文件信息
 
 ```yaml
 spring:
@@ -133,18 +191,17 @@ datart:
   env:
     file-path: ${user.dir}/files # 服务端文件保存位置
 
-# 可选配置 如需配置请参照 [3.2 截图配置 [ChromeWebDriver]-可选]
+  # 可选配置 如需配置请参照 [3.2 截图配置 [ChromeWebDriver]-可选]
   screenshot:
     timeout-seconds: 60
     webdriver-type: CHROME
-    webdriver-path: "http://youip:4444/wd/hub"  
+    webdriver-path: "http://youip:4444/wd/hub"
 
 ```
 
 *注意：加密密钥每个服务端部署前应该进行修改，且部署后不能再次修改。如果是集群部署，同一个集群内的secret要保持统一*
 
-
-### 3.2 截图配置 [ChromeWebDriver]-可选
+### 2.4.2 截图配置 [ChromeWebDriver]-可选
 
 ```bash
 
@@ -154,15 +211,15 @@ docker run -p 4444:4444 -d --name selenium-chrome --shm-size="2g" selenium/stand
 
 ```
 
-### 4 启动服务
+### 2.5. 启动服务
 
 *注意：启动脚本 已更新了 start|stop|status|restart*
 
 ```base
 ${DATART_HOME}/bin/datart-server.sh (start|stop|status|restart)
 ```
 
-### 5 访问服务
+### 2.5 访问服务
 
 *注意：没有默认用户 直接注册 成功后直接登录即可*
 

Dockerfile

@@ -1,11 +1,11 @@
 FROM java:8
 LABEL "author"="tl"
 RUN mkdir /datart
-COPY ./bin/* /datart/bin/
-COPY ./config/* /datart/config/
-COPY ./lib/* /datart/lib/
+COPY ./bin/ /datart/bin/
+COPY ./config/ /datart/config/
+COPY ./lib/ /datart/lib/
 COPY static /datart/static
 ENV TZ=Asia/Shanghai
-EXPOSE 58080
+EXPOSE 8080
 WORKDIR /datart
 ENTRYPOINT java -cp "lib/*" datart.DatartServerApplication