This documentation is intended to provide instructions on how to run Flink locally on a single machine.
Go to the downloads page and get the ready to run package. If you want to interact with Hadoop (e.g. HDFS or HBase), make sure to pick the Flink package matching your Hadoop version. When in doubt or you plan to just work with the local file system pick the package for Hadoop 1.2.x.
Flink runs on Linux, Mac OS X and Windows. The only requirement for a local setup is Java 1.7.x or higher. The following manual assumes a UNIX-like environment, for Windows see Flink on Windows.
You can check the correct installation of Java by issuing the following command:
The command should output something comparable to the following:
java version "1.8.0_51"
Java(TM) SE Runtime Environment (build 1.8.0_51-b16)
Java HotSpot(TM) 64-Bit Server VM (build 25.51-b03, mixed mode)
For local mode Flink is ready to go out of the box and you don’t need to change the default configuration.
The out of the box configuration will use your default Java installation. You can manually set the environment variable
JAVA_HOME or the configuration key
conf/flink-conf.yaml if you want to manually override the Java runtime to use. Consult the configuration page for further details about configuring Flink.
You are now ready to start Flink. Unpack the downloaded archive and change to the newly created
flink directory. There you can start Flink in local mode:
$ tar xzf flink-*.tgz
$ cd flink
You can check that the system is running by checking the log files in the
$ tail log/flink-*-jobmanager-*.log
INFO ... - Starting JobManager
INFO ... - Starting JobManager web frontend
INFO ... - Web frontend listening at 127.0.0.1:8081
INFO ... - Registered TaskManager at 127.0.0.1 (akka://flink/user/taskmanager)
The JobManager will also start a web frontend on port 8081, which you can check with your browser at
If you want to run Flink on Windows you need to download, unpack and configure the Flink archive as mentioned above. After that you can either use the Windows Batch file (
.bat) or use Cygwin to run the Flink Jobmanager.
To start Flink in local mode from the Windows Batch, open the command window, navigate to the
bin/ directory of Flink and run
bin folder of your Java Runtime Environment must be included in Window’s
%PATH% variable. Follow this guide to add Java to the
$ cd flink
$ cd bin
Starting Flink job manager. Web interface by default on http://localhost:8081/.
Do not close this batch window. Stop job manager by pressing Ctrl+C.
After that, you need to open a second terminal to run jobs using
With Cygwin you need to start the Cygwin Terminal, navigate to your Flink directory and run the
$ cd flink
If you are installing Flink from the git repository and you are using the Windows git shell, Cygwin can produce a failure similiar to this one:
c:/flink/bin/start-local.sh: line 30: $'\r': command not found
This error occurs, because git is automatically transforming UNIX line endings to Windows style line endings when running in Windows. The problem is, that Cygwin can only deal with UNIX style line endings. The solution is to adjust the Cygwin settings to deal with the correct line endings by following these three steps:
Start a Cygwin shell.
Determine your home directory by entering
It will return a path under the Cygwin root path.
.bash_profile in the home directory and append the following: (If the file does not exist you have to create it)
set -o igncr
Save the file and open a new bash shell.