Author: markap14
Date: Tue Dec 16 20:26:15 2014
New Revision: 1646064
URL: http://svn.apache.org/r1646064
Log:
Updated to reflect new bootstrap module
Modified:
incubator/nifi/site/trunk/content/development/quickstart.md
Modified: incubator/nifi/site/trunk/content/development/quickstart.md
URL:
http://svn.apache.org/viewvc/incubator/nifi/site/trunk/content/development/quickstart.md?rev=1646064&r1=1646063&r2=1646064&view=diff
==============================================================================
--- incubator/nifi/site/trunk/content/development/quickstart.md (original)
+++ incubator/nifi/site/trunk/content/development/quickstart.md Tue Dec 16
20:26:15 2014
@@ -60,10 +60,25 @@ to 8080 is a good start, but on systems
`mvn assembly:assembly` will create a tar.gz file in the target directory in
`assembly`. This tar.gz should
contain the full application. Decompressing the tar.gz should make a directory
for you containing several other
-directories. `conf` contains application configuration, `logs` will contain
log files, `bin` contains a fairly
-bare-bones script for launching the application, `nifi.sh`. On linux (and
possibly OS X) running `bin/nifi.sh start`
-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. `conf` contains application configuration, `logs` will contain
log files, `bin` contains scripts
+for launching the application. On linux and OSX, NiFi can be run using
`bin/nifi.sh <command>` where
+`<command>` is one of:
+
++ start: starts NiFi in the background
++ stop: stops NiFi that is running in the background
++ status: provides the current status of NiFi
++ run: runs NiFi in the foreground and waits to receive a Ctrl-C, which then
shuts down NiFi.
++ install: (available in Linux only, not OSX): installs NiFi as a service that
can then be controlled
+via `service nifi start`, `service nifi stop`, `service nifi status`.
+
+
+For Windows users, there exist several scripts in the `bin` directory that are
analogous to those above:
+`start-nifi.bat`, `stop-nifi.bat`, `nifi-status.bat`, and `run-nifi.bat`.
+
+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
`conf/bootstrap.conf` file.
+
+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.
