You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flink.apache.org by rm...@apache.org on 2014/08/25 11:14:51 UTC
[3/7] git commit: [FLINK-1050] Windows local setup documentation:
added note for java being in %PATH% variable, headers, and missing link label
[FLINK-1050] Windows local setup documentation: added note for java being in %PATH% variable, headers, and missing link label
This closes #95
Project: http://git-wip-us.apache.org/repos/asf/incubator-flink/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-flink/commit/355a13ef
Tree: http://git-wip-us.apache.org/repos/asf/incubator-flink/tree/355a13ef
Diff: http://git-wip-us.apache.org/repos/asf/incubator-flink/diff/355a13ef
Branch: refs/heads/release-0.6.1
Commit: 355a13efbb26d7cf4c815b694c7f85cf68c93633
Parents: 80ab109
Author: Fabian Hueske <fh...@apache.org>
Authored: Thu Aug 14 18:00:57 2014 +0200
Committer: Robert Metzger <rm...@apache.org>
Committed: Mon Aug 25 11:10:52 2014 +0200
----------------------------------------------------------------------
docs/local_setup.md | 9 +++++++++
1 file changed, 9 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-flink/blob/355a13ef/docs/local_setup.md
----------------------------------------------------------------------
diff --git a/docs/local_setup.md b/docs/local_setup.md
index dd8ffe5..d12401b 100644
--- a/docs/local_setup.md
+++ b/docs/local_setup.md
@@ -56,12 +56,17 @@ INFO ... - Starting web info server for JobManager on port 8081
The JobManager will also start a web frontend on port 8081, which you can check with your browser at `http://localhost:8081`.
+<section id="windows">
# Flink on Windows
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.
+### Starting with Windows Batch Files
+
To start Flink in local mode from the *Windows Batch*, open the command window, navigate to the `bin/` directory of Flink and run `start-local.bat`.
+Note: The ``bin`` folder of your Java Runtime Environment must be included in Window's ``%PATH%`` variable. Follow this [guide](http://www.java.com/en/download/help/path.xml) to add Java to the ``%PATH%`` variable.
+
```bash
$ cd flink
$ cd bin
@@ -72,6 +77,8 @@ 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 `flink.bat`.
+### Starting with Cygwin and Unix Scripts
+
With *Cygwin* you need to start the Cygwin Terminal, navigate to your Flink directory and run the `start-local.sh` script:
```bash
@@ -80,6 +87,8 @@ $ bin/start-local.sh
Starting Nephele job manager
```
+### Installing Flink from Git
+
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:
```bash