You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nifi.apache.org by bu...@apache.org on 2014/12/16 20:04:31 UTC
svn commit: r933023 - in /websites/staging/nifi/trunk/content: ./
development/quickstart.html
Author: buildbot
Date: Tue Dec 16 19:04:30 2014
New Revision: 933023
Log:
Staging update by buildbot for nifi
Modified:
websites/staging/nifi/trunk/content/ (props changed)
websites/staging/nifi/trunk/content/development/quickstart.html
Propchange: websites/staging/nifi/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Tue Dec 16 19:04:30 2014
@@ -1 +1 @@
-1645461
+1646045
Modified: websites/staging/nifi/trunk/content/development/quickstart.html
==============================================================================
--- websites/staging/nifi/trunk/content/development/quickstart.html (original)
+++ websites/staging/nifi/trunk/content/development/quickstart.html Tue Dec 16 19:04:30 2014
@@ -34,13 +34,14 @@
<div class="jumbotron">
<div id="content">
- <h1 id="wzxhzdk2-apache-nifi-development-quickstart"><img alt="NiFi logo" style="float: right" src="/images/bgNifiLogo.png" /> Apache NiFi Development Quickstart</h1>
+ <h1 id="wzxhzdk3-apache-nifi-development-quickstart"><img alt="NiFi logo" style="float: right" src="/images/bgNifiLogo.png" /> Apache NiFi Development Quickstart</h1>
<p>This documentation is in progress, but should get many started at building Apache NiFi.</p>
<h2 id="source-code">Source Code</h2>
<p>Apache NiFi source code is version controlled using <a href="http://git-scm.com/">Git</a> version control (<a href="https://git-wip-us.apache.org/repos/asf?p=incubator-nifi.git;a=summary">browse</a>|<a href="http://git-wip-us.apache.org/repos/asf/incubator-nifi.git">checkout</a>). </p>
<p>The code is also mirrored to <a href="https://github.com/apache/incubator-nifi">Github</a></p>
<p>The code as it was initially contributed and entered the incubator is on the 'master' branch.</p>
<p>To view the lastest codebase as we work toward an initial release checkout the 'develop' branch.</p>
+<p>All guidance that follows assumes you are working on the 'develop' branch.</p>
<h2 id="issue-tracking">Issue Tracking</h2>
<p>Track issues on the "NIFI" Project on the Apache Jira (<a href="https://issues.apache.org/jira/browse/NIFI">browse</a>).</p>
<h2 id="building">Building</h2>
@@ -50,16 +51,24 @@
</pre></div>
+<p>Then checkout the 'develop' branch</p>
+<div class="codehilite"><pre><span class="n">git</span> <span class="n">checkout</span> <span class="n">develop</span>
+</pre></div>
+
+
<h3 id="build-steps">Build steps</h3>
<p>We're planning on revising these steps, our build process, and tests for much more deterministic builds. For now, the steps are not automated.</p>
<ol>
<li>You need a recent Java 7 JDK.</li>
<li>You need Apache <a href="http://maven.apache.org/">Maven 3.X</a>. We've successfully used 3.2.3 and as far back as 3.0.5</li>
-<li>In the root dir of the source tree run <code>./misc/build-order.sh</code> (expect 20-30 mins build time) <strong>OR</strong> you can build each component
-manually.</li>
+<li>Build the nar maven plugin. In the root dir of the source tree cd to 'nar-maven-plugin'.
+ Run 'mvn clean install'</li>
+<li>Build the entire code base. In the root dir of the source tree run 'mvn -T C1.0 clean install'
+ You can tweak the maven build settings as you like but the previous command will execute with 1 thread per core.</li>
+<li>Build the assembly/nifi application itself. In the root dir of the source tree cd to 'assembly'.
+ Run 'mvn assembly:assembly'</li>
</ol>
-<p>Once that is done you can go to the assemblies/nifi directory and run
-<code>mvn assembly:assembly</code></p>
+<p>Now you should have a fully functioning build off the latest code in the develop branch.</p>
<h2 id="running-the-application">Running the application</h2>
<h4 id="warning"><strong> WARNING </strong></h4>
<p>Without any configuration, the application will run on port 8080 and does not require any credentials to modify
@@ -67,7 +76,7 @@ the flow. This means of running Apache N
connections from trusted computers and users can connect to port 8080. Using iptables to allow only localhost connections
to 8080 is a good start, but on systems with multiple (potentially untrusted) users, also not a sufficient protection.</p>
<h4 id="decompress-and-launch">Decompress and launch</h4>
-<p><code>mvn assembly:assembly</code> will create a tar.gz file in the target directory in <code>assemblies/nifi</code>. This tar.gz should
+<p><code>mvn assembly:assembly</code> will create a tar.gz file in the target directory in <code>assembly</code>. This tar.gz should
contain the full application. Decompressing the tar.gz should make a directory for you containing several other
directories. <code>conf</code> contains application configuration, <code>logs</code> will contain log files, <code>bin</code> contains a fairly
bare-bones script for launching the application, <code>nifi.sh</code>. On linux (and possibly OS X) running <code>bin/nifi.sh start</code>