Author: buildbot
Date: Tue Dec 16 20:26:19 2014
New Revision: 933032
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 20:26:19 2014
@@ -1 +1 @@
-1646045
+1646064
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
20:26:19 2014
@@ -78,10 +78,22 @@ to 8080 is a good start, but on systems
<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>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>
-should start the application in the foreground after trying to detect a Java
installation. There are scripts to help with
-startup on windows as well. The entire concept of how the application will
integrate to a given OS and run as an
+directories. <code>conf</code> contains application configuration,
<code>logs</code> will contain log files, <code>bin</code> contains scripts
+for launching the application. On linux and OSX, NiFi can be run using
<code>bin/nifi.sh <command></code> where
+<code><command></code> is one of:</p>
+<ul>
+<li>start: starts NiFi in the background</li>
+<li>stop: stops NiFi that is running in the background</li>
+<li>status: provides the current status of NiFi</li>
+<li>run: runs NiFi in the foreground and waits to receive a Ctrl-C, which then
shuts down NiFi.</li>
+<li>install: (available in Linux only, not OSX): installs NiFi as a service
that can then be controlled
+via <code>service nifi start</code>, <code>service nifi stop</code>,
<code>service nifi status</code>.</li>
+</ul>
+<p>For Windows users, there exist several scripts in the <code>bin</code>
directory that are analogous to those above:
+<code>start-nifi.bat</code>, <code>stop-nifi.bat</code>,
<code>nifi-status.bat</code>, and <code>run-nifi.bat</code>.</p>
+<p>The configuration that is to be used when launching NiFi, such as Java heap
size, the user
+to run as, which Java command to use, etc. are configurable via the
<code>conf/bootstrap.conf</code> file.</p>
+<p>The entire concept of how the application will integrate to a given OS and
run as an
enduring service is something we're working hard on and would appreciate ideas
for. The user experience needs to
be excellent.</p>
<p>With the default settings you can point a web browser at
<code>http://localhost:8080/nifi/</code></p>