This is an automated email from the ASF dual-hosted git repository.
alopresto pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/nifi.git
The following commit(s) were added to refs/heads/master by this push:
new 6283012 NIFI-6491 Improve installation instructions in Admin Guide
and Getting Starting Guide Clarified homebrew install instructions.
6283012 is described below
commit 62830122cb72b0b0f5b083786d4c1294ebae6976
Author: Andrew Lim <[email protected]>
AuthorDate: Fri Jan 31 12:12:29 2020 -0500
NIFI-6491 Improve installation instructions in Admin Guide and Getting
Starting Guide
Clarified homebrew install instructions.
This closes #4029.
Signed-off-by: Andy LoPresto <[email protected]>
---
.../src/main/asciidoc/administration-guide.adoc | 15 ++++++++-------
nifi-docs/src/main/asciidoc/getting-started.adoc | 20 +++++++++++++-------
2 files changed, 21 insertions(+), 14 deletions(-)
diff --git a/nifi-docs/src/main/asciidoc/administration-guide.adoc
b/nifi-docs/src/main/asciidoc/administration-guide.adoc
index 54f0d1c..7093fbd 100644
--- a/nifi-docs/src/main/asciidoc/administration-guide.adoc
+++ b/nifi-docs/src/main/asciidoc/administration-guide.adoc
@@ -19,10 +19,11 @@ Apache NiFi Team <[email protected]>
:homepage: http://nifi.apache.org
:linkattrs:
+[[system_requirements]]
== System Requirements
Apache NiFi can run on something as simple as a laptop, but it can also be
clustered across many enterprise-class servers. Therefore, the amount of
hardware and memory needed will depend on the size and nature of the dataflow
involved. The data is stored on disk while NiFi is processing it. So NiFi needs
to have sufficient disk space allocated for its various repositories,
particularly the content repository, flowfile repository, and provenance
repository (see the <<system_properties>> s [...]
-* Requires Java 8 or newer
+* Requires Java 8 or Java 11
* Supported Operating Systems:
** Linux
** Unix
@@ -34,7 +35,7 @@ Apache NiFi can run on something as simple as a laptop, but
it can also be clust
** Google Chrome: Current & (Current - 1)
** Safari: Current & (Current - 1)
-**Note** Under sustained and extremely high throughput the CodeCache settings
may need to be tuned to avoid sudden performance loss. See the
<<bootstrap_properties>> section for more information.
+NOTE: Under sustained and extremely high throughput the CodeCache settings may
need to be tuned to avoid sudden performance loss. See the
<<bootstrap_properties>> section for more information.
== How to install and start NiFi
@@ -43,11 +44,11 @@ Apache NiFi can run on something as simple as a laptop, but
it can also be clust
** Make any desired edits in files found under `<installdir>/conf`
*** At a minimum, we recommend editing the _nifi.properties_ file and entering
a password for the `nifi.sensitive.props.key` (see <<system_properties>> below)
** From the `<installdir>/bin` directory, execute the following commands by
typing `./nifi.sh <command>`:
-*** 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 for a Ctrl-C to initiate
shutdown of NiFi
-*** install: installs NiFi as a service that can then be controlled via
+*** `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 for a Ctrl-C to initiate
shutdown of NiFi
+*** `install`: installs NiFi as a service that can then be controlled via
**** `service nifi start`
**** `service nifi stop`
**** `service nifi status`
diff --git a/nifi-docs/src/main/asciidoc/getting-started.adoc
b/nifi-docs/src/main/asciidoc/getting-started.adoc
index bcb0d5e..c5ce13a 100644
--- a/nifi-docs/src/main/asciidoc/getting-started.adoc
+++ b/nifi-docs/src/main/asciidoc/getting-started.adoc
@@ -58,14 +58,20 @@ dataflows.
== Downloading and Installing NiFi
-NiFi can be downloaded from the link:http://nifi.apache.org/download.html[NiFi
Downloads Page^]. There are two packaging options
-available: a "tarball" that is tailored more to Linux and a zip file that is
more applicable for Windows users. Mac OS X users
-may also use the tarball or can install via Homebrew.
+WARNING: Before proceeding, check the Admin Guide to confirm you have the
<<administration-guide.adoc#system_requirements,minimum system requirements>>
to install and run NiFi.
-To install via Homebrew, simply run the command `brew install nifi`.
+NiFi can be downloaded from the link:http://nifi.apache.org/download.html[NiFi
Downloads page^]. There are two packaging options
+available:
+
+- a "tarball" (tar.gz) that is tailored more to Linux
+- a zip file that is more applicable for Windows users
+
+Mac OS X users may also use the tarball or can install via
link:https://brew.sh[Homebrew^] by simply running the command `brew install
nifi` from the command line terminal.
+
+NOTE: NiFi requires Java 8 or 11. It is recommended that you have installed
one of these Java versions prior to installing NiFi via Homebrew. Homebrew is
aware NiFi depends on Java but not the specific supported versions, so it may
prompt to install an incompatible JDK as part of its NiFi install.
For users who are not running OS X or do not have Homebrew installed, after
downloading the version of NiFi that you
-would like to use simply extract the archive to the location that you wish to
run the application from.
+would like to use, simply extract the archive to the location that you wish to
run the application from.
For information on how to configure the instance of NiFi (for example, to
configure security, data storage
configuration, or the port that NiFi is running on), see the
link:administration-guide.html[Admin Guide].
@@ -92,9 +98,9 @@ To run NiFi in the foreground, run `bin/nifi.sh run`. This
will leave the applic
the user presses Ctrl-C. At that time, it will initiate shutdown of the
application.
To run NiFi in the background, instead run `bin/nifi.sh start`. This will
initiate the application to
-begin running. To check the status and see if NiFi is currently running,
execute the command `bin/nifi.sh status`.
-NiFi can be shutdown by executing the command `bin/nifi.sh stop`.
+begin running. To check the status and see if NiFi is currently running,
execute the command `bin/nifi.sh status`. NiFi can be shutdown by executing the
command `bin/nifi.sh stop`.
+If NiFi was installed with Homebrew, run the commands `nifi start` or `nifi
stop` from anywhere in your file system to start or stop NiFi.
=== Installing as a Service
