Skip to main content
Version: 2.3.1



Step 1: Prepare the environment​

Before you getting start the local run, you need to make sure you already have installed the following software which SeaTunnel required:

  • Java (Java 8 or 11, other versions greater than Java 8 can theoretically work as well) installed and JAVA_HOME set.

Step 2: Download SeaTunnel​

Enter the seatunnel download page and download the latest version of distribute package seatunnel-<version>-bin.tar.gz

Or you can download it by terminal

export version="2.3.1"
wget "${version}/apache-seatunnel-incubating-${version}-bin.tar.gz"
tar -xzvf "apache-seatunnel-incubating-${version}-bin.tar.gz"

Step 3: Install connectors plugin​

Since 2.2.0-beta, the binary package does not provide connector dependencies by default, so when using it for the first time, we need to execute the following command to install the connector: (Of course, you can also manually download the connector from [Apache Maven Repository]( to download, then manually move to the connectors/seatunnel directory).

sh bin/ 2.3.1

If you need to specify the version of the connector, take 2.3.0-beta as an example, we need to execute

sh bin/ 2.3.1

Usually you don't need all the connector plugins, so you can specify the plugins you need by configuring config/plugin_config, for example, you only need the connector-console plugin, then you can modify plugin_config as


If you'd like to make the sample application to work properly, you need to add the following plugins


You can find out all supported connectors and corresponding plugin_config configuration names under ${SEATUNNEL_HOME}/connectors/


If you want to install the connector plugin by manually downloading the connector, you need to pay special attention to the following

The connectors directory contains the following subdirectories, if they do not exist, you need to create them manually


If you want to install the V2 connector plugin manually, you only need to download the V2 connector plugin you need and put them in the seatunnel directory

What's More​

For now, you are already deployment SeaTunnel complete. You can follow Quick Start to configure and run a data synchronization job.