This is an automated email from the ASF dual-hosted git repository.
kassiez pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/doris-website.git
The following commit(s) were added to refs/heads/master by this push:
new 951b5767578 Change Quick Start Shell (#2328)
951b5767578 is described below
commit 951b57675780cdcaa22994d196481ffd0131e052
Author: FreeOnePlus <54164178+freeonep...@users.noreply.github.com>
AuthorDate: Mon Apr 28 10:31:37 2025 +0800
Change Quick Start Shell (#2328)
## Versions
- [ ] dev
- [*] 3.0
- [*] 2.1
- [*] 2.0
## Languages
- [*] Chinese
- [*] English
## Docs Checklist
- [ ] Checked by AI
- [ ] Test Cases Built
---------
Co-authored-by: Yijia Su <freeonep...@apache.org>
---
docs/gettingStarted/quick-start.md | 41 +++----
.../current/gettingStarted/quick-start.md | 40 +++----
.../version-2.1/gettingStarted/quick-start.md | 40 +++----
.../version-3.0/gettingStarted/quick-start.md | 33 ++----
static/files/start-doris.sh | 126 +++++++++++++++++++++
.../version-2.1/gettingStarted/quick-start.md | 41 +++----
.../version-3.0/gettingStarted/quick-start.md | 35 ++----
7 files changed, 203 insertions(+), 153 deletions(-)
diff --git a/docs/gettingStarted/quick-start.md
b/docs/gettingStarted/quick-start.md
index 6beb3e49f5c..716a93b35fc 100644
--- a/docs/gettingStarted/quick-start.md
+++ b/docs/gettingStarted/quick-start.md
@@ -39,37 +39,26 @@ The following rapid deployment methods are intended solely
for local development
Starting from Doris version 2.1.8, Docker can be used for rapid deployment.
-### Step 1: Create the docker-compose.yaml File
-
-Copy the following content into the docker-compose.yaml file, and replace the
`DORIS_QUICK_START_VERSION` parameter with the specified version, such as
`3.0.1`.
-
-```text
-version: "3"
-services:
- fe:
- image: apache/doris.fe-ubuntu:${DORIS_QUICK_START_VERSION}
- hostname: fe
- environment:
- - FE_SERVERS=fe1:127.0.0.1:9010
- - FE_ID=1
- network_mode: host
- be:
- image: apache/doris.be-ubuntu:${DORIS_QUICK_START_VERSION}
- hostname: be
- environment:
- - FE_SERVERS=fe1:127.0.0.1:9010
- - BE_ADDR=127.0.0.1:9050
- depends_on:
- - fe
- network_mode: host
+### Step 1: Download the Quick-Start script
+
+[Download the script](/files/start-doris.sh), run the following command to
grant it the corresponding execution permissions.
+
+```shell
+chmod 755 start-doris.sh
```
-### Step 2: Start Cluster
+### Step 2: Start the cluster
+
+Run the script to start the cluster, using the `2.1.9` version by default
+
+```shell
+bash start-doris.sh
+```
-Start the cluster using the docker-compose command.
+You can specify the startup version through the -v parameter, such as:
```shell
-docker-compose -f ./docker-compose.yaml up -d
+bash start-doris.sh -v 2.1.8
```
### Step 3: Connect to the cluster using MySQL client and check the cluster
status
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/gettingStarted/quick-start.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/gettingStarted/quick-start.md
index 52d493299f1..7369e3215c5 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/gettingStarted/quick-start.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/gettingStarted/quick-start.md
@@ -39,37 +39,27 @@ under the License.
自 Doris 2.1.8 版本后，可以使用 Docker 进行快速部署。
-### 第 1 步：创建 docker-compose.yaml 文件
-
-复制以下内容到 docker-compose.yaml 文件中，并将 DORIS_QUICK_START_VERSION 替换为指定的 Doris
版本，例如 3.0.1。
-
-```text
-version: "3"
-services:
- fe:
- image: apache/doris.fe-ubuntu:${DORIS_QUICK_START_VERSION}
- hostname: fe
- environment:
- - FE_SERVERS=fe1:127.0.0.1:9010
- - FE_ID=1
- network_mode: host
- be:
- image: apache/doris.be-ubuntu:${DORIS_QUICK_START_VERSION}
- hostname: be
- environment:
- - FE_SERVERS=fe1:127.0.0.1:9010
- - BE_ADDR=127.0.0.1:9050
- depends_on:
- - fe
- network_mode: host
+### 第 1 步：下载 Quick-Start 脚本
+
+[下载脚本](/files/start-doris.sh)，运行以下命令，给其赋有相应的执行权限。
+
+```shell
+chmod 755 start-doris.sh
```
+
### 第 2 步：启动集群
-使用 docker-compose 命令启动集群
+运行脚本，启动集群，默认使用`2.1.9`版本
+
+```shell
+bash start-doris.sh
+```
+
+可通过 -v 参数指定启动版本，如：
```shell
-docker-compose -f ./docker-compose.yaml up -d
+bash start-doris.sh -v 2.1.8
```
### 第 3 步：使用 MySQL 客户端连接集群，并检查集群状态
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/gettingStarted/quick-start.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/gettingStarted/quick-start.md
index 52d493299f1..7369e3215c5 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/gettingStarted/quick-start.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/gettingStarted/quick-start.md
@@ -39,37 +39,27 @@ under the License.
自 Doris 2.1.8 版本后，可以使用 Docker 进行快速部署。
-### 第 1 步：创建 docker-compose.yaml 文件
-
-复制以下内容到 docker-compose.yaml 文件中，并将 DORIS_QUICK_START_VERSION 替换为指定的 Doris
版本，例如 3.0.1。
-
-```text
-version: "3"
-services:
- fe:
- image: apache/doris.fe-ubuntu:${DORIS_QUICK_START_VERSION}
- hostname: fe
- environment:
- - FE_SERVERS=fe1:127.0.0.1:9010
- - FE_ID=1
- network_mode: host
- be:
- image: apache/doris.be-ubuntu:${DORIS_QUICK_START_VERSION}
- hostname: be
- environment:
- - FE_SERVERS=fe1:127.0.0.1:9010
- - BE_ADDR=127.0.0.1:9050
- depends_on:
- - fe
- network_mode: host
+### 第 1 步：下载 Quick-Start 脚本
+
+[下载脚本](/files/start-doris.sh)，运行以下命令，给其赋有相应的执行权限。
+
+```shell
+chmod 755 start-doris.sh
```
+
### 第 2 步：启动集群
-使用 docker-compose 命令启动集群
+运行脚本，启动集群，默认使用`2.1.9`版本
+
+```shell
+bash start-doris.sh
+```
+
+可通过 -v 参数指定启动版本，如：
```shell
-docker-compose -f ./docker-compose.yaml up -d
+bash start-doris.sh -v 2.1.8
```
### 第 3 步：使用 MySQL 客户端连接集群，并检查集群状态
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/gettingStarted/quick-start.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/gettingStarted/quick-start.md
index 52d493299f1..066072259c4 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/gettingStarted/quick-start.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/gettingStarted/quick-start.md
@@ -39,37 +39,20 @@ under the License.
自 Doris 2.1.8 版本后，可以使用 Docker 进行快速部署。
-### 第 1 步：创建 docker-compose.yaml 文件
-
-复制以下内容到 docker-compose.yaml 文件中，并将 DORIS_QUICK_START_VERSION 替换为指定的 Doris
版本，例如 3.0.1。
-
-```text
-version: "3"
-services:
- fe:
- image: apache/doris.fe-ubuntu:${DORIS_QUICK_START_VERSION}
- hostname: fe
- environment:
- - FE_SERVERS=fe1:127.0.0.1:9010
- - FE_ID=1
- network_mode: host
- be:
- image: apache/doris.be-ubuntu:${DORIS_QUICK_START_VERSION}
- hostname: be
- environment:
- - FE_SERVERS=fe1:127.0.0.1:9010
- - BE_ADDR=127.0.0.1:9050
- depends_on:
- - fe
- network_mode: host
+### 第 1 步：下载 Quick-Start 脚本
+
+[下载脚本](/files/start-doris.sh)，运行以下命令，给其赋有相应的执行权限。
+
+```shell
+chmod 755 start-doris.sh
```
### 第 2 步：启动集群
-使用 docker-compose 命令启动集群
+运行脚本，启动集群，默认使用`2.1.9`版本，可通过 -v 参数指定启动版本，如：
```shell
-docker-compose -f ./docker-compose.yaml up -d
+bash start-doris.sh -v 3.0.4
```
### 第 3 步：使用 MySQL 客户端连接集群，并检查集群状态
diff --git a/static/files/start-doris.sh b/static/files/start-doris.sh
new file mode 100755
index 00000000000..6e8aaf17c2d
--- /dev/null
+++ b/static/files/start-doris.sh
@@ -0,0 +1,126 @@
+#!/bin/bash
+
+# Default version
+DORIS_QUICK_START_VERSION="2.1.9"
+
+# Parse parameters
+while getopts "v:" opt; do
+ case $opt in
+ v) DORIS_QUICK_START_VERSION="$OPTARG"
+ ;;
+ \?) echo "Invalid option: -$OPTARG" >&2
+ exit 1
+ ;;
+ esac
+done
+
+# Check system type
+OS_TYPE=$(uname -s)
+if [[ "$OS_TYPE" != "Linux" && "$OS_TYPE" != "Darwin" ]]; then
+ echo "Error: Unsupported operating system [$OS_TYPE], only Linux and Mac are
supported"
+ exit 1
+fi
+
+# Check Docker environment
+if ! command -v docker &> /dev/null; then
+ echo "Error: Docker environment not detected, please install Docker first"
+ exit 1
+fi
+
+# Check docker-compose
+COMPOSE_CMD=""
+if command -v docker-compose &> /dev/null; then
+ COMPOSE_CMD="docker-compose"
+elif docker compose version &> /dev/null; then
+ COMPOSE_CMD="docker compose"
+else
+ echo "Error: docker-compose plugin or docker-compose command is required"
+ exit 1
+fi
+
+# Generate docker-compose configuration for corresponding system
+if [[ "$OS_TYPE" == "Linux" ]]; then
+ cat > docker-compose-doris.yaml <<EOF
+version: "3"
+services:
+ fe:
+ image: apache/doris:fe-${DORIS_QUICK_START_VERSION}
+ hostname: fe
+ environment:
+ - FE_SERVERS=fe1:127.0.0.1:9010
+ - FE_ID=1
+ network_mode: host
+ be:
+ image: apache/doris:be-${DORIS_QUICK_START_VERSION}
+ hostname: be
+ environment:
+ - FE_SERVERS=fe1:127.0.0.1:9010
+ - BE_ADDR=127.0.0.1:9050
+ depends_on:
+ - fe
+ network_mode: host
+EOF
+else # Mac system
+ cat > docker-compose-doris.yaml <<EOF
+version: "3"
+networks:
+ custom_network:
+ driver: bridge
+ ipam:
+ config:
+ - subnet: 172.20.80.0/24
+
+services:
+ fe:
+ image: apache/doris:fe-${DORIS_QUICK_START_VERSION}
+ hostname: fe
+ ports:
+ - 8030:8030
+ - 9030:9030
+ - 9010:9010
+ environment:
+ - FE_SERVERS=fe1:172.20.80.2:9010
+ - FE_ID=1
+ networks:
+ custom_network:
+ ipv4_address: 172.20.80.2
+
+ be:
+ image: apache/doris:be-${DORIS_QUICK_START_VERSION}
+ hostname: be
+ ports:
+ - 8040:8040
+ - 9050:9050
+ environment:
+ - FE_SERVERS=fe1:172.20.80.2:9010
+ - BE_ADDR=172.20.80.3:9050
+ depends_on:
+ - fe
+ networks:
+ custom_network:
+ ipv4_address: 172.20.80.3
+EOF
+fi
+
+# Start services
+$COMPOSE_CMD -f docker-compose-doris.yaml up -d
+
+echo "Doris cluster started successfully, version:
${DORIS_QUICK_START_VERSION}"
+echo "You can manage the cluster using the following commands:"
+echo " Stop cluster: $COMPOSE_CMD -f docker-compose-doris.yaml down"
+echo " View logs: $COMPOSE_CMD -f docker-compose-doris.yaml logs -f"
+echo " Connect to cluster: mysql -uroot -P9030 -h127.0.0.1"
+
+# Display connection information based on system type
+if [[ "$OS_TYPE" == "Linux" ]]; then
+ echo -e "\nAccess FE/BE http ports (8030, 8040) using the following
addresses (Linux system):"
+ echo " http://127.0.0.1:8030";
+ echo " http://127.0.0.1:8040";
+elif [[ "$OS_TYPE" == "Darwin" ]]; then
+ echo -e "\nAccess FE/BE http ports (8030, 8040) using the following
addresses (Mac system):"
+ echo " http://docker.for.mac.localhost:8030";
+ echo " http://docker.for.mac.localhost:8040";
+ echo "Note: If access fails, try using 127.0.0.1 address:"
+ echo " http://127.0.0.1:8030";
+ echo " http://127.0.0.1:8040";
+fi
\ No newline at end of file
diff --git a/versioned_docs/version-2.1/gettingStarted/quick-start.md
b/versioned_docs/version-2.1/gettingStarted/quick-start.md
index 6beb3e49f5c..716a93b35fc 100644
--- a/versioned_docs/version-2.1/gettingStarted/quick-start.md
+++ b/versioned_docs/version-2.1/gettingStarted/quick-start.md
@@ -39,37 +39,26 @@ The following rapid deployment methods are intended solely
for local development
Starting from Doris version 2.1.8, Docker can be used for rapid deployment.
-### Step 1: Create the docker-compose.yaml File
-
-Copy the following content into the docker-compose.yaml file, and replace the
`DORIS_QUICK_START_VERSION` parameter with the specified version, such as
`3.0.1`.
-
-```text
-version: "3"
-services:
- fe:
- image: apache/doris.fe-ubuntu:${DORIS_QUICK_START_VERSION}
- hostname: fe
- environment:
- - FE_SERVERS=fe1:127.0.0.1:9010
- - FE_ID=1
- network_mode: host
- be:
- image: apache/doris.be-ubuntu:${DORIS_QUICK_START_VERSION}
- hostname: be
- environment:
- - FE_SERVERS=fe1:127.0.0.1:9010
- - BE_ADDR=127.0.0.1:9050
- depends_on:
- - fe
- network_mode: host
+### Step 1: Download the Quick-Start script
+
+[Download the script](/files/start-doris.sh), run the following command to
grant it the corresponding execution permissions.
+
+```shell
+chmod 755 start-doris.sh
```
-### Step 2: Start Cluster
+### Step 2: Start the cluster
+
+Run the script to start the cluster, using the `2.1.9` version by default
+
+```shell
+bash start-doris.sh
+```
-Start the cluster using the docker-compose command.
+You can specify the startup version through the -v parameter, such as:
```shell
-docker-compose -f ./docker-compose.yaml up -d
+bash start-doris.sh -v 2.1.8
```
### Step 3: Connect to the cluster using MySQL client and check the cluster
status
diff --git a/versioned_docs/version-3.0/gettingStarted/quick-start.md
b/versioned_docs/version-3.0/gettingStarted/quick-start.md
index 6beb3e49f5c..e14c2a4c6bc 100644
--- a/versioned_docs/version-3.0/gettingStarted/quick-start.md
+++ b/versioned_docs/version-3.0/gettingStarted/quick-start.md
@@ -39,37 +39,20 @@ The following rapid deployment methods are intended solely
for local development
Starting from Doris version 2.1.8, Docker can be used for rapid deployment.
-### Step 1: Create the docker-compose.yaml File
-
-Copy the following content into the docker-compose.yaml file, and replace the
`DORIS_QUICK_START_VERSION` parameter with the specified version, such as
`3.0.1`.
-
-```text
-version: "3"
-services:
- fe:
- image: apache/doris.fe-ubuntu:${DORIS_QUICK_START_VERSION}
- hostname: fe
- environment:
- - FE_SERVERS=fe1:127.0.0.1:9010
- - FE_ID=1
- network_mode: host
- be:
- image: apache/doris.be-ubuntu:${DORIS_QUICK_START_VERSION}
- hostname: be
- environment:
- - FE_SERVERS=fe1:127.0.0.1:9010
- - BE_ADDR=127.0.0.1:9050
- depends_on:
- - fe
- network_mode: host
+### Step 1: Download the Quick-Start script
+
+[Download the script](/files/start-doris.sh), run the following command to
grant it the corresponding execution permissions.
+
+```shell
+chmod 755 start-doris.sh
```
-### Step 2: Start Cluster
+### Step 2: Start the cluster
-Start the cluster using the docker-compose command.
+Run the script to start the cluster. The default version is `2.1.9`. You can
specify the startup version through the -v parameter, such as:
```shell
-docker-compose -f ./docker-compose.yaml up -d
+bash start-doris.sh -v 3.0.4
```
### Step 3: Connect to the cluster using MySQL client and check the cluster
status
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@doris.apache.org
For additional commands, e-mail: commits-h...@doris.apache.org
