This is an automated email from the ASF dual-hosted git repository.
lidongdai pushed a commit to branch master
in repository
https://gitbox.apache.org/repos/asf/incubator-dolphinscheduler-website.git
The following commit(s) were added to refs/heads/master by this push:
new ccc4c8c add docker image deployment doc (#271)
ccc4c8c is described below
commit ccc4c8c60b11822b7081c447be83bd895e204b36
Author: dailidong <[email protected]>
AuthorDate: Tue Jan 19 16:20:24 2021 +0800
add docker image deployment doc (#271)
* update error metadata version
* add docker deployment doc in 1.3.4
---
docs/en-us/1.3.4/user_doc/build-docker-image.md | 247 ++++++++++++++++++++++++
docs/en-us/1.3.4/user_doc/docker-deployment.md | 135 +++++++++++++
docs/zh-cn/1.3.4/user_doc/build-docker-image.md | 247 ++++++++++++++++++++++++
docs/zh-cn/1.3.4/user_doc/docker-deployment.md | 148 ++++++++++++++
site_config/docs1-3-4.js | 8 +
5 files changed, 785 insertions(+)
diff --git a/docs/en-us/1.3.4/user_doc/build-docker-image.md
b/docs/en-us/1.3.4/user_doc/build-docker-image.md
new file mode 100644
index 0000000..6238aac
--- /dev/null
+++ b/docs/en-us/1.3.4/user_doc/build-docker-image.md
@@ -0,0 +1,247 @@
+## How to build a docker image
+
+You can build a docker image in A Unix-like operating system, You can also
build it in Windows operating system.
+
+In Unix-Like, Example:
+
+```bash
+$ cd path/incubator-dolphinscheduler
+$ sh ./docker/build/hooks/build
+```
+
+In Windows, Example:
+
+```bat
+c:\incubator-dolphinscheduler>.\docker\build\hooks\build.bat
+```
+
+Please read `./docker/build/hooks/build` `./docker/build/hooks/build.bat`
script files if you don't understand
+
+## Environment Variables
+
+The Dolphin Scheduler image uses several environment variables which are easy
to miss. While none of the variables are required, they may significantly aid
you in using the image.
+
+**`DATABASE_TYPE`**
+
+This environment variable sets the type for database. The default value is
`postgresql`.
+
+**Note**: You must be specify it when start a standalone dolphinscheduler
server. Like `master-server`, `worker-server`, `api-server`, `alert-server`.
+
+**`DATABASE_DRIVER`**
+
+This environment variable sets the type for database. The default value is
`org.postgresql.Driver`.
+
+**Note**: You must be specify it when start a standalone dolphinscheduler
server. Like `master-server`, `worker-server`, `api-server`, `alert-server`.
+
+**`DATABASE_HOST`**
+
+This environment variable sets the host for database. The default value is
`127.0.0.1`.
+
+**Note**: You must be specify it when start a standalone dolphinscheduler
server. Like `master-server`, `worker-server`, `api-server`, `alert-server`.
+
+**`DATABASE_PORT`**
+
+This environment variable sets the port for database. The default value is
`5432`.
+
+**Note**: You must be specify it when start a standalone dolphinscheduler
server. Like `master-server`, `worker-server`, `api-server`, `alert-server`.
+
+**`DATABASE_USERNAME`**
+
+This environment variable sets the username for database. The default value is
`root`.
+
+**Note**: You must be specify it when start a standalone dolphinscheduler
server. Like `master-server`, `worker-server`, `api-server`, `alert-server`.
+
+**`DATABASE_PASSWORD`**
+
+This environment variable sets the password for database. The default value is
`root`.
+
+**Note**: You must be specify it when start a standalone dolphinscheduler
server. Like `master-server`, `worker-server`, `api-server`, `alert-server`.
+
+**`DATABASE_DATABASE`**
+
+This environment variable sets the database for database. The default value is
`dolphinscheduler`.
+
+**Note**: You must be specify it when start a standalone dolphinscheduler
server. Like `master-server`, `worker-server`, `api-server`, `alert-server`.
+
+**`DATABASE_PARAMS`**
+
+This environment variable sets the database for database. The default value is
`characterEncoding=utf8`.
+
+**Note**: You must be specify it when start a standalone dolphinscheduler
server. Like `master-server`, `worker-server`, `api-server`, `alert-server`.
+
+**`DOLPHINSCHEDULER_ENV_PATH`**
+
+This environment variable sets the runtime environment for task. The default
value is `/opt/dolphinscheduler/conf/env/dolphinscheduler_env.sh`.
+
+**`DOLPHINSCHEDULER_DATA_BASEDIR_PATH`**
+
+User data directory path, self configuration, please make sure the directory
exists and have read write permissions. The default value is
`/tmp/dolphinscheduler`
+
+**`ZOOKEEPER_QUORUM`**
+
+This environment variable sets zookeeper quorum for `master-server` and
`worker-serverr`. The default value is `127.0.0.1:2181`.
+
+**Note**: You must be specify it when start a standalone dolphinscheduler
server. Like `master-server`, `worker-server`.
+
+**`MASTER_EXEC_THREADS`**
+
+This environment variable sets exec thread num for `master-server`. The
default value is `100`.
+
+**`MASTER_EXEC_TASK_NUM`**
+
+This environment variable sets exec task num for `master-server`. The default
value is `20`.
+
+**`MASTER_HEARTBEAT_INTERVAL`**
+
+This environment variable sets heartbeat interval for `master-server`. The
default value is `10`.
+
+**`MASTER_TASK_COMMIT_RETRYTIMES`**
+
+This environment variable sets task commit retry times for `master-server`.
The default value is `5`.
+
+**`MASTER_TASK_COMMIT_INTERVAL`**
+
+This environment variable sets task commit interval for `master-server`. The
default value is `1000`.
+
+**`MASTER_MAX_CPULOAD_AVG`**
+
+This environment variable sets max cpu load avg for `master-server`. The
default value is `100`.
+
+**`MASTER_RESERVED_MEMORY`**
+
+This environment variable sets reserved memory for `master-server`. The
default value is `0.1`.
+
+**`MASTER_LISTEN_PORT`**
+
+This environment variable sets port for `master-server`. The default value is
`5678`.
+
+**`WORKER_EXEC_THREADS`**
+
+This environment variable sets exec thread num for `worker-server`. The
default value is `100`.
+
+**`WORKER_HEARTBEAT_INTERVAL`**
+
+This environment variable sets heartbeat interval for `worker-server`. The
default value is `10`.
+
+**`WORKER_FETCH_TASK_NUM`**
+
+This environment variable sets fetch task num for `worker-server`. The default
value is `3`.
+
+**`WORKER_MAX_CPULOAD_AVG`**
+
+This environment variable sets max cpu load avg for `worker-server`. The
default value is `100`.
+
+**`WORKER_RESERVED_MEMORY`**
+
+This environment variable sets reserved memory for `worker-server`. The
default value is `0.1`.
+
+**`WORKER_WEIGHT`**
+
+This environment variable sets port for `worker-server`. The default value is
`100`.
+
+**`WORKER_LISTEN_PORT`**
+
+This environment variable sets port for `worker-server`. The default value is
`1234`.
+
+**`WORKER_GROUP`**
+
+This environment variable sets group for `worker-server`. The default value is
`default`.
+
+**`XLS_FILE_PATH`**
+
+This environment variable sets xls file path for `alert-server`. The default
value is `/tmp/xls`.
+
+**`MAIL_SERVER_HOST`**
+
+This environment variable sets mail server host for `alert-server`. The
default value is empty.
+
+**`MAIL_SERVER_PORT`**
+
+This environment variable sets mail server port for `alert-server`. The
default value is empty.
+
+**`MAIL_SENDER`**
+
+This environment variable sets mail sender for `alert-server`. The default
value is empty.
+
+**`MAIL_USER=`**
+
+This environment variable sets mail user for `alert-server`. The default value
is empty.
+
+**`MAIL_PASSWD`**
+
+This environment variable sets mail password for `alert-server`. The default
value is empty.
+
+**`MAIL_SMTP_STARTTLS_ENABLE`**
+
+This environment variable sets SMTP tls for `alert-server`. The default value
is `true`.
+
+**`MAIL_SMTP_SSL_ENABLE`**
+
+This environment variable sets SMTP ssl for `alert-server`. The default value
is `false`.
+
+**`MAIL_SMTP_SSL_TRUST`**
+
+This environment variable sets SMTP ssl truest for `alert-server`. The default
value is empty.
+
+**`ENTERPRISE_WECHAT_ENABLE`**
+
+This environment variable sets enterprise wechat enable for `alert-server`.
The default value is `false`.
+
+**`ENTERPRISE_WECHAT_CORP_ID`**
+
+This environment variable sets enterprise wechat corp id for `alert-server`.
The default value is empty.
+
+**`ENTERPRISE_WECHAT_SECRET`**
+
+This environment variable sets enterprise wechat secret for `alert-server`.
The default value is empty.
+
+**`ENTERPRISE_WECHAT_AGENT_ID`**
+
+This environment variable sets enterprise wechat agent id for `alert-server`.
The default value is empty.
+
+**`ENTERPRISE_WECHAT_USERS`**
+
+This environment variable sets enterprise wechat users for `alert-server`. The
default value is empty.
+
+**`FRONTEND_API_SERVER_HOST`**
+
+This environment variable sets api server host for `frontend`. The default
value is `127.0.0.1`.
+
+**Note**: You must be specify it when start a standalone dolphinscheduler
server. Like `api-server`.
+
+**`FRONTEND_API_SERVER_PORT`**
+
+This environment variable sets api server port for `frontend`. The default
value is `123451`.
+
+**Note**: You must be specify it when start a standalone dolphinscheduler
server. Like `api-server`.
+
+## Initialization scripts
+
+If you would like to do additional initialization in an image derived from
this one, add one or more environment variable under
`/root/start-init-conf.sh`, and modify template files in
`/opt/dolphinscheduler/conf/*.tpl`.
+
+For example, to add an environment variable `API_SERVER_PORT` in
`/root/start-init-conf.sh`:
+
+```
+export API_SERVER_PORT=5555
+```
+
+and to modify `/opt/dolphinscheduler/conf/application-api.properties.tpl`
template file, add server port:
+```
+server.port=${API_SERVER_PORT}
+```
+
+`/root/start-init-conf.sh` will dynamically generate config file:
+
+```sh
+echo "generate app config"
+ls ${DOLPHINSCHEDULER_HOME}/conf/ | grep ".tpl" | while read line; do
+eval "cat << EOF
+$(cat ${DOLPHINSCHEDULER_HOME}/conf/${line})
+EOF
+" > ${DOLPHINSCHEDULER_HOME}/conf/${line%.*}
+done
+
+echo "generate nginx config"
+sed -i "s/FRONTEND_API_SERVER_HOST/${FRONTEND_API_SERVER_HOST}/g"
/etc/nginx/conf.d/dolphinscheduler.conf
+sed -i "s/FRONTEND_API_SERVER_PORT/${FRONTEND_API_SERVER_PORT}/g"
/etc/nginx/conf.d/dolphinscheduler.conf
+```
diff --git a/docs/en-us/1.3.4/user_doc/docker-deployment.md
b/docs/en-us/1.3.4/user_doc/docker-deployment.md
new file mode 100644
index 0000000..38dd906
--- /dev/null
+++ b/docs/en-us/1.3.4/user_doc/docker-deployment.md
@@ -0,0 +1,135 @@
+## Try DolphinScheduler quickly
+
+There are 2 ways to quickly intall DolphinScheduler
+
+### The first way：Start with docker-compose (recommended)
+In this way, you need to install docker-compose first, please install it
yourself
+
+##### 1、 Download the source code zip package
+
+-Please download the latest version of the source code package and unzip it
+```shell
+mkdir -p /opt/soft/dolphinscheduler;
+cd /opt/soft/dolphinscheduler;
+
+# download source code package
+wget
https://mirrors.tuna.tsinghua.edu.cn/apache/incubator/dolphinscheduler/1.3.4/apache-dolphinscheduler-incubating-1.3.4-src.zip
+
+# unzip
+tar -zxvf apache-dolphinscheduler-incubating-1.3.4-src.zip
+
+mv apache-dolphinscheduler-incubating-1.3.4-src-release dolphinscheduler-src
+```
+##### 2、 Install and start the service
+```
+cd dolphinscheduler-src
+docker-compose -f ./docker/docker-swarm/docker-compose.yml up -d
+```
+
+##### 3、 Login the system
+Visit the front-end UI: http://192.168.xx.xx:8888
+ <p align="center">
+ <img src="/img/login.png" width="60%" />
+ </p>
+Then refer to the `Quick Start` in the chapter of the user manual to use
+
+
+
+
+### The Second way: start in docker mode
+
+##### 1. Basic software installation (please install by yourself)
+ * PostgreSQL (8.2.15+)
+ * ZooKeeper (3.4.6+)
+ * Docker
+
+##### 2. Please login to the PostgreSQL database and create a database named
`dolphinscheduler`
+
+##### 3. Initialize the database, import `sql/dolphinscheduler-postgre.sql`
+
+##### 4. Download the DolphinScheduler Image
+```
+docker pull apache/dolphinscheduler:latest
+```
+
+##### 5. Run a DolphinScheduler instance
+
+start service:
+
+```
+$ docker run -dit --name dolphinscheduler \
+-e ZOOKEEPER_QUORUM="l92.168.x.x:2181"
+-e DATABASE_HOST="192.168.x.x" -e DATABASE_PORT="5432" -e
DATABASE_DATABASE="dolphinscheduler" \
+-e DATABASE_USERNAME="{user}" -e DATABASE_PASSWORD="{password}" \
+-p 8888:8888 \
+dolphinscheduler all
+```
+Note: {user} and {password} need to be replaced with your database user name
and password)
+
+
+
+## Appendix
+
+### When the container starts, the following services are automatically
started:
+
+```aidl
+ MasterServer ----- master service
+ WorkerServer ----- worker service
+ LoggerServer ----- logger service
+ ApiApplicationServer ----- api service
+ AlertServer ----- alert service
+```
+### If you just want to run some services in dolphinscheduler
+
+You can run some services in dolphinscheduler.
+
+* Start a **master server**, For example:
+
+```
+$ docker run -dit --name dolphinscheduler \
+-e ZOOKEEPER_QUORUM="l92.168.x.x:2181"
+-e DATABASE_HOST="192.168.x.x" -e DATABASE_PORT="5432" -e
DATABASE_DATABASE="dolphinscheduler" \
+-e DATABASE_USERNAME="test" -e DATABASE_PASSWORD="test" \
+dolphinscheduler master-server
+```
+
+* Start a **worker server**, For example:
+
+```
+$ docker run -dit --name dolphinscheduler \
+-e ZOOKEEPER_QUORUM="l92.168.x.x:2181"
+-e DATABASE_HOST="192.168.x.x" -e DATABASE_PORT="5432" -e
DATABASE_DATABASE="dolphinscheduler" \
+-e DATABASE_USERNAME="test" -e DATABASE_PASSWORD="test" \
+dolphinscheduler worker-server
+```
+
+* Start a **api server**, For example:
+
+```
+$ docker run -dit --name dolphinscheduler \
+-e DATABASE_HOST="192.168.x.x" -e DATABASE_PORT="5432" -e
DATABASE_DATABASE="dolphinscheduler" \
+-e DATABASE_USERNAME="test" -e DATABASE_PASSWORD="test" \
+-p 12345:12345 \
+dolphinscheduler api-server
+```
+
+* Start a **alert server**, For example:
+
+```
+$ docker run -dit --name dolphinscheduler \
+-e DATABASE_HOST="192.168.x.x" -e DATABASE_PORT="5432" -e
DATABASE_DATABASE="dolphinscheduler" \
+-e DATABASE_USERNAME="test" -e DATABASE_PASSWORD="test" \
+dolphinscheduler alert-server
+```
+
+* Start a **frontend**, For example:
+
+```
+$ docker run -dit --name dolphinscheduler \
+-e FRONTEND_API_SERVER_HOST="192.168.x.x" -e FRONTEND_API_SERVER_PORT="12345" \
+-p 8888:8888 \
+dolphinscheduler frontend
+```
+
+**Note**: You must be specify `DATABASE_HOST` `DATABASE_PORT`
`DATABASE_DATABASE` `DATABASE_USERNAME` `DATABASE_PASSWORD` `ZOOKEEPER_QUORUM`
when start a standalone dolphinscheduler server.
+
diff --git a/docs/zh-cn/1.3.4/user_doc/build-docker-image.md
b/docs/zh-cn/1.3.4/user_doc/build-docker-image.md
new file mode 100644
index 0000000..e813aa8
--- /dev/null
+++ b/docs/zh-cn/1.3.4/user_doc/build-docker-image.md
@@ -0,0 +1,247 @@
+### 如何构建 DolphinScheduler 的 docker 镜像
+
+你能够在类 Unix 系统和 Windows 系统中构建一个 docker 镜像。
+
+类 Unix 系统, 如下:
+
+```bash
+$ cd path/incubator-dolphinscheduler
+$ sh ./docker/build/hooks/build
+```
+
+Windows系统, 如下:
+
+```bat
+c:\incubator-dolphinscheduler>.\docker\build\hooks\build.bat
+```
+
+如果你不理解这些脚本 `./docker/build/hooks/build`
`./docker/build/hooks/build.bat`，请阅读里面的内容。
+
+## 环境变量
+
+DolphinScheduler 映像使用了几个容易遗漏的环境变量。虽然这些变量不是必须的，但是可以帮助你更容易配置镜像并根据你的需求定义相应的服务配置。
+
+**`DATABASE_TYPE`**
+
+配置`database`的`TYPE`， 默认值 `postgresql`。
+
+**注意**:
当运行`dolphinscheduler`中`master-server`、`worker-server`、`api-server`、`alert-server`这些服务时，必须指定这个环境变量，以便于你更好的搭建分布式服务。
+
+**`DATABASE_DRIVER`**
+
+配置`database`的`DRIVER`， 默认值 `org.postgresql.Driver`。
+
+**注意**:
当运行`dolphinscheduler`中`master-server`、`worker-server`、`api-server`、`alert-server`这些服务时，必须指定这个环境变量，以便于你更好的搭建分布式服务。
+
+**`DATABASE_HOST`**
+
+配置`database`的`HOST`， 默认值 `127.0.0.1`。
+
+**注意**:
当运行`dolphinscheduler`中`master-server`、`worker-server`、`api-server`、`alert-server`这些服务时，必须指定这个环境变量，以便于你更好的搭建分布式服务。
+
+**`DATABASE_PORT`**
+
+配置`database`的`PORT`， 默认值 `5432`。
+
+**注意**:
当运行`dolphinscheduler`中`master-server`、`worker-server`、`api-server`、`alert-server`这些服务时，必须指定这个环境变量，以便于你更好的搭建分布式服务。
+
+**`DATABASE_USERNAME`**
+
+配置`database`的`USERNAME`， 默认值 `root`。
+
+**注意**:
当运行`dolphinscheduler`中`master-server`、`worker-server`、`api-server`、`alert-server`这些服务时，必须指定这个环境变量，以便于你更好的搭建分布式服务。
+
+**`DATABASE_PASSWORD`**
+
+配置`database`的`PASSWORD`， 默认值 `root`。
+
+**注意**:
当运行`dolphinscheduler`中`master-server`、`worker-server`、`api-server`、`alert-server`这些服务时，必须指定这个环境变量，以便于你更好的搭建分布式服务。
+
+**`DATABASE_DATABASE`**
+
+配置`database`的`DATABASE`， 默认值 `dolphinscheduler`。
+
+**注意**:
当运行`dolphinscheduler`中`master-server`、`worker-server`、`api-server`、`alert-server`这些服务时，必须指定这个环境变量，以便于你更好的搭建分布式服务。
+
+**`DATABASE_PARAMS`**
+
+配置`database`的`PARAMS`， 默认值 `characterEncoding=utf8`。
+
+**注意**:
当运行`dolphinscheduler`中`master-server`、`worker-server`、`api-server`、`alert-server`这些服务时，必须指定这个环境变量，以便于你更好的搭建分布式服务。
+
+**`DOLPHINSCHEDULER_ENV_PATH`**
+
+任务执行时的环境变量配置文件， 默认值 `/opt/dolphinscheduler/conf/env/dolphinscheduler_env.sh`。
+
+**`DOLPHINSCHEDULER_DATA_BASEDIR_PATH`**
+
+用户数据目录, 用户自己配置, 请确保这个目录存在并且用户读写权限， 默认值 `/tmp/dolphinscheduler`。
+
+**`ZOOKEEPER_QUORUM`**
+
+配置`master-server`和`worker-serverr`的`Zookeeper`地址, 默认值 `127.0.0.1:2181`。
+
+**注意**:
当运行`dolphinscheduler`中`master-server`、`worker-server`这些服务时，必须指定这个环境变量，以便于你更好的搭建分布式服务。
+
+**`MASTER_EXEC_THREADS`**
+
+配置`master-server`中的执行线程数量，默认值 `100`。
+
+**`MASTER_EXEC_TASK_NUM`**
+
+配置`master-server`中的执行任务数量，默认值 `20`。
+
+**`MASTER_HEARTBEAT_INTERVAL`**
+
+配置`master-server`中的心跳交互时间，默认值 `10`。
+
+**`MASTER_TASK_COMMIT_RETRYTIMES`**
+
+配置`master-server`中的任务提交重试次数，默认值 `5`。
+
+**`MASTER_TASK_COMMIT_INTERVAL`**
+
+配置`master-server`中的任务提交交互时间，默认值 `1000`。
+
+**`MASTER_MAX_CPULOAD_AVG`**
+
+配置`master-server`中的CPU中的`load average`值，默认值 `100`。
+
+**`MASTER_RESERVED_MEMORY`**
+
+配置`master-server`的保留内存，默认值 `0.1`。
+
+**`MASTER_LISTEN_PORT`**
+
+配置`master-server`的端口，默认值 `5678`。
+
+**`WORKER_EXEC_THREADS`**
+
+配置`worker-server`中的执行线程数量，默认值 `100`。
+
+**`WORKER_HEARTBEAT_INTERVAL`**
+
+配置`worker-server`中的心跳交互时间，默认值 `10`。
+
+**`WORKER_FETCH_TASK_NUM`**
+
+配置`worker-server`中的获取任务的数量，默认值 `3`。
+
+**`WORKER_MAX_CPULOAD_AVG`**
+
+配置`worker-server`中的CPU中的最大`load average`值，默认值 `100`。
+
+**`WORKER_RESERVED_MEMORY`**
+
+配置`worker-server`的保留内存，默认值 `0.1`。
+
+**`WORKER_WEIGHT`**
+
+配置`worker-server`的权重，默认之`100`。
+
+**`WORKER_LISTEN_PORT`**
+
+配置`worker-server`的端口，默认值 `1234`。
+
+**`WORKER_GROUP`**
+
+配置`worker-server`的分组，默认值 `default`。
+
+**`XLS_FILE_PATH`**
+
+配置`alert-server`的`XLS`文件的存储路径，默认值 `/tmp/xls`。
+
+**`MAIL_SERVER_HOST`**
+
+配置`alert-server`的邮件服务地址，默认值 `空`。
+
+**`MAIL_SERVER_PORT`**
+
+配置`alert-server`的邮件服务端口，默认值 `空`。
+
+**`MAIL_SENDER`**
+
+配置`alert-server`的邮件发送人，默认值 `空`。
+
+**`MAIL_USER=`**
+
+配置`alert-server`的邮件服务用户名，默认值 `空`。
+
+**`MAIL_PASSWD`**
+
+配置`alert-server`的邮件服务用户密码，默认值 `空`。
+
+**`MAIL_SMTP_STARTTLS_ENABLE`**
+
+配置`alert-server`的邮件服务是否启用TLS，默认值 `true`。
+
+**`MAIL_SMTP_SSL_ENABLE`**
+
+配置`alert-server`的邮件服务是否启用SSL，默认值 `false`。
+
+**`MAIL_SMTP_SSL_TRUST`**
+
+配置`alert-server`的邮件服务SSL的信任地址，默认值 `空`。
+
+**`ENTERPRISE_WECHAT_ENABLE`**
+
+配置`alert-server`的邮件服务是否启用企业微信，默认值 `false`。
+
+**`ENTERPRISE_WECHAT_CORP_ID`**
+
+配置`alert-server`的邮件服务企业微信`ID`，默认值 `空`。
+
+**`ENTERPRISE_WECHAT_SECRET`**
+
+配置`alert-server`的邮件服务企业微信`SECRET`，默认值 `空`。
+
+**`ENTERPRISE_WECHAT_AGENT_ID`**
+
+配置`alert-server`的邮件服务企业微信`AGENT_ID`，默认值 `空`。
+
+**`ENTERPRISE_WECHAT_USERS`**
+
+配置`alert-server`的邮件服务企业微信`USERS`，默认值 `空`。
+
+**`FRONTEND_API_SERVER_HOST`**
+
+配置`frontend`的连接`api-server`的地址，默认值 `127.0.0.1`。
+
+**Note**: 当单独运行`api-server`时，你应该指定`api-server`这个值。
+
+**`FRONTEND_API_SERVER_PORT`**
+
+配置`frontend`的连接`api-server`的端口，默认值 `12345`。
+
+**Note**: 当单独运行`api-server`时，你应该指定`api-server`这个值。
+
+## 初始化脚本
+
+如果你想在编译的时候或者运行的时候附加一些其它的操作及新增一些环境变量，你可以在`/root/start-init-conf.sh`文件中进行修改，同时如果涉及到配置文件的修改，请在`/opt/dolphinscheduler/conf/*.tpl`中修改相应的配置文件
+
+例如，在`/root/start-init-conf.sh`添加一个环境变量`API_SERVER_PORT`：
+
+```
+export API_SERVER_PORT=5555
+```
+
+当添加以上环境变量后，你应该在相应的模板文件`/opt/dolphinscheduler/conf/application-api.properties.tpl`中添加这个环境变量配置:
+```
+server.port=${API_SERVER_PORT}
+```
+
+`/root/start-init-conf.sh`将根据模板文件动态的生成配置文件：
+
+```sh
+echo "generate app config"
+ls ${DOLPHINSCHEDULER_HOME}/conf/ | grep ".tpl" | while read line; do
+eval "cat << EOF
+$(cat ${DOLPHINSCHEDULER_HOME}/conf/${line})
+EOF
+" > ${DOLPHINSCHEDULER_HOME}/conf/${line%.*}
+done
+
+echo "generate nginx config"
+sed -i "s/FRONTEND_API_SERVER_HOST/${FRONTEND_API_SERVER_HOST}/g"
/etc/nginx/conf.d/dolphinscheduler.conf
+sed -i "s/FRONTEND_API_SERVER_PORT/${FRONTEND_API_SERVER_PORT}/g"
/etc/nginx/conf.d/dolphinscheduler.conf
+```
\ No newline at end of file
diff --git a/docs/zh-cn/1.3.4/user_doc/docker-deployment.md
b/docs/zh-cn/1.3.4/user_doc/docker-deployment.md
new file mode 100644
index 0000000..35bc2e4
--- /dev/null
+++ b/docs/zh-cn/1.3.4/user_doc/docker-deployment.md
@@ -0,0 +1,148 @@
+## 快速试用 DolphinScheduler
+
+有 2 种方式可以快速试用 DolphinScheduler，分别介绍
+### 一、以 docker-compose 的方式启动(推荐)
+这种方式需要先安装 docker-compose , docker-compose 的安装网上已经有非常多的资料，请自行安装即可
+
+##### 1、下载源码 zip 包
+
+- 请下载最新版本的源码包并进行解压
+
+```shell
+# 创建源码存放目录
+mkdir -p /opt/soft/dolphinscheduler;
+cd /opt/soft/dolphinscheduler;
+
+# 下载源码包
+wget
https://mirrors.tuna.tsinghua.edu.cn/apache/incubator/dolphinscheduler/1.3.4/apache-dolphinscheduler-incubating-1.3.4-src.zip
+
+# 解压缩
+tar -zxvf apache-dolphinscheduler-incubating-1.3.4-src.zip
+
+mv apache-dolphinscheduler-incubating-1.3.4-src-release dolphinscheduler-src
+```
+
+##### 2、安装并启动服务
+```
+cd dolphinscheduler-src
+docker-compose -f ./docker/docker-swarm/docker-compose.yml up -d
+```
+
+##### 3、登录系统
+访问前端界面： http://192.168.xx.xx:8888
+ <p align="center">
+ <img src="/img/login.png" width="60%" />
+ </p>
+然后参考用户手册章节的`快速上手`即可进行使用
+
+
+下面介绍第 2 种方式
+### 二、以 docker 方式启动
+这种方式需要先安装 docker , docker 的安装网上已经有非常多的资料，请自行安装即可
+##### 1、基础软件安装(请自行安装)
+ * PostgreSQL (8.2.15+)
+ * ZooKeeper (3.4.6+)
+ * Docker
+
+##### 2、请登录 PostgreSQL 数据库，创建名为 `dolphinscheduler` 数据库
+
+##### 3、初始化数据库，导入 `sql/dolphinscheduler-postgre.sql` 进行创建表及基础数据导入
+
+##### 4、下载 DolphinScheduler 镜像
+我们已将面向用户的 DolphinScheduler 镜像上传至 docker 仓库，用户无需在本地构建镜像，直接执行以下命令从 docker 仓库
pull 镜像：
+```
+docker pull apache/dolphinscheduler:latest
+```
+
+##### 5、运行一个 DolphinScheduler 实例
+
+如下:(注: {user} 和 {password} 需要替换为具体的数据库用户名和密码)
+
+```
+$ docker run -dit --name dolphinscheduler \
+-e ZOOKEEPER_QUORUM="l92.168.x.x:2181"
+-e DATABASE_HOST="192.168.x.x" -e DATABASE_PORT="5432" -e
DATABASE_DATABASE="dolphinscheduler" \
+-e DATABASE_USERNAME="{user}" -e DATABASE_PASSWORD="{password}" \
+-p 8888:8888 \
+dolphinscheduler all
+```
+
+### 然后登录系统
+
+- 访问前端页面地址,接口ip(自行修改)
+http://192.168.xx.xx:8888
+
+ <p align="center">
+ <img src="/img/login.png" width="60%" />
+ </p>
+然后参考用户手册章节的`快速上手`即可进行使用
+
+
+## 附录
+
+### 在容器启动时，会自动启动以下服务：
+
+```aidl
+ MasterServer ----- master服务
+ WorkerServer ----- worker服务
+ LoggerServer ----- logger服务
+ ApiApplicationServer ----- api服务
+ AlertServer ----- alert服务
+```
+### 如果你只是想运行 dolphinscheduler 中的部分服务
+
+你能够运行dolphinscheduler中的部分服务。
+
+* 启动一个 **master server**, 如下:
+
+```
+$ docker run -dit --name dolphinscheduler \
+-e ZOOKEEPER_QUORUM="l92.168.x.x:2181"
+-e DATABASE_HOST="192.168.x.x" -e DATABASE_PORT="5432" -e
DATABASE_DATABASE="dolphinscheduler" \
+-e DATABASE_USERNAME="test" -e DATABASE_PASSWORD="test" \
+dolphinscheduler master-server
+```
+
+* 启动一个 **worker server**, 如下:
+
+```
+$ docker run -dit --name dolphinscheduler \
+-e ZOOKEEPER_QUORUM="l92.168.x.x:2181"
+-e DATABASE_HOST="192.168.x.x" -e DATABASE_PORT="5432" -e
DATABASE_DATABASE="dolphinscheduler" \
+-e DATABASE_USERNAME="test" -e DATABASE_PASSWORD="test" \
+dolphinscheduler worker-server
+```
+
+* 启动一个 **api server**, 如下:
+
+```
+$ docker run -dit --name dolphinscheduler \
+-e DATABASE_HOST="192.168.x.x" -e DATABASE_PORT="5432" -e
DATABASE_DATABASE="dolphinscheduler" \
+-e DATABASE_USERNAME="test" -e DATABASE_PASSWORD="test" \
+-p 12345:12345 \
+dolphinscheduler api-server
+```
+
+* 启动一个 **alert server**, 如下:
+
+```
+$ docker run -dit --name dolphinscheduler \
+-e DATABASE_HOST="192.168.x.x" -e DATABASE_PORT="5432" -e
DATABASE_DATABASE="dolphinscheduler" \
+-e DATABASE_USERNAME="test" -e DATABASE_PASSWORD="test" \
+dolphinscheduler alert-server
+```
+
+* 启动一个 **frontend**, 如下:
+
+```
+$ docker run -dit --name dolphinscheduler \
+-e FRONTEND_API_SERVER_HOST="192.168.x.x" -e FRONTEND_API_SERVER_PORT="12345" \
+-p 8888:8888 \
+dolphinscheduler frontend
+```
+
+**注意**: 当你运行dolphinscheduler中的部分服务时，你必须指定这些环境变量 `DATABASE_HOST`
`DATABASE_PORT` `DATABASE_DATABASE` `DATABASE_USERNAME` `DATABASE_PASSWORD`
`ZOOKEEPER_QUORUM`。
+
+
+
+
diff --git a/site_config/docs1-3-4.js b/site_config/docs1-3-4.js
index 3bd4253..6396f3a 100644
--- a/site_config/docs1-3-4.js
+++ b/site_config/docs1-3-4.js
@@ -15,6 +15,10 @@ export default {
{
title: 'Cluster deploy',
link:
'/en-us/docs/1.3.4/user_doc/cluster-deployment.html',
+ },
+ {
+ title: 'Docker deploy',
+ link:
'/en-us/docs/1.3.4/user_doc/docker-deployment.html',
}
]
},
@@ -90,6 +94,10 @@ export default {
{
title: '集群部署(Cluster)',
link:
'/zh-cn/docs/1.3.4/user_doc/cluster-deployment.html',
+ },
+ {
+ title: 'Docker部署(Docker)',
+ link:
'/zh-cn/docs/1.3.4/user_doc/docker-deployment.html',
}
],
},
