Apache
/
nifi
mirror of https://github.com/apache/nifi.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

NIFI-7978 - update Homebrew getting started instructions 

NIFI-7978 Removed a few more OS X references.

This closes #4647

Signed-off-by: Mike Thomsen <mthomsen@apache.org>
This commit is contained in:
Dustin Rodrigues 2020-11-03 20:11:09 -05:00 committed by Mike Thomsen
parent 71a5735f63
commit 0805670263
No known key found for this signature in database
GPG Key ID: 88511C3D4CAD246F
3 changed files with 11 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
nifi-docs/src/main/asciidoc/administration-guide.adoc
View File

@ -28,7 +28,7 @@ Apache NiFi can run on something as simple as a laptop, but it can also be clust
** Linux ** Linux
** Unix ** Unix
** Windows ** Windows
** Mac OS X ** macOS
* Supported Web Browsers: * Supported Web Browsers:
** Microsoft Edge: Current & (Current - 1) ** Microsoft Edge: Current & (Current - 1)
** Mozilla FireFox: Current & (Current - 1) ** Mozilla FireFox: Current & (Current - 1)
@ -39,7 +39,7 @@ NOTE: Under sustained and extremely high throughput the CodeCache settings may n
== How to install and start NiFi == How to install and start NiFi
* Linux/Unix/OS X * Linux/Unix/macOS
** Decompress and untar into desired installation directory ** Decompress and untar into desired installation directory
** Make any desired edits in files found under `<installdir>/conf` ** 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) *** At a minimum, we recommend editing the _nifi.properties_ file and entering a password for the `nifi.sensitive.props.key` (see <<system_properties>> below)
@ -476,7 +476,7 @@ NOTE: Any identity mapping rules specified in _nifi.properties_ will also be app
The ShellUserGroupProvider fetches user and group details from Unix-like systems using shell commands. The ShellUserGroupProvider fetches user and group details from Unix-like systems using shell commands.
This provider executes various shell pipelines with commands such as `getent` on Linux and `dscl` on MacOS. This provider executes various shell pipelines with commands such as `getent` on Linux and `dscl` on macOS.
Supported systems may be configured to retrieve users and groups from an external source, such as LDAP or NIS. In these cases the shell commands Supported systems may be configured to retrieve users and groups from an external source, such as LDAP or NIS. In these cases the shell commands
will return those external users and groups. This provides administrators another mechanism to integrate user and group directory services. will return those external users and groups. This provides administrators another mechanism to integrate user and group directory services.
@ -3314,7 +3314,7 @@ These properties pertain to the web-based User Interface.
|*Property*|*Description* |*Property*|*Description*
|`nifi.web.http.host`|The HTTP host. It is blank by default. |`nifi.web.http.host`|The HTTP host. It is blank by default.
|`nifi.web.http.port`|The HTTP port. The default value is `8080`. |`nifi.web.http.port`|The HTTP port. The default value is `8080`.
|`nifi.web.http.port.forwarding`|The port which forwards incoming HTTP requests to `nifi.web.http.host`. This property is designed to be used with 'port forwarding', when NiFi has to be started by a non-root user for better security, yet it needs to be accessed via low port to go through a firewall. For example, to expose NiFi via HTTP protocol on port 80, but actually listening on port 8080, you need to configure OS level port forwarding such as `iptables` (Linux/Unix) or `pfctl` (OS X) that redirects requests from 80 to 8080. Then set `nifi.web.http.port` as 8080, and `nifi.web.http.port.forwarding` as 80. It is blank by default. |`nifi.web.http.port.forwarding`|The port which forwards incoming HTTP requests to `nifi.web.http.host`. This property is designed to be used with 'port forwarding', when NiFi has to be started by a non-root user for better security, yet it needs to be accessed via low port to go through a firewall. For example, to expose NiFi via HTTP protocol on port 80, but actually listening on port 8080, you need to configure OS level port forwarding such as `iptables` (Linux/Unix) or `pfctl` (macOS) that redirects requests from 80 to 8080. Then set `nifi.web.http.port` as 8080, and `nifi.web.http.port.forwarding` as 80. It is blank by default.
|`nifi.web.http.network.interface`*|The name of the network interface to which NiFi should bind for HTTP requests. It is blank by default. + |`nifi.web.http.network.interface`*|The name of the network interface to which NiFi should bind for HTTP requests. It is blank by default. +
+ +
*NOTE*: Multiple network interfaces can be specified by using the `nifi.web.http.network.interface.` prefix with unique suffixes and separate network interface names as values. + *NOTE*: Multiple network interfaces can be specified by using the `nifi.web.http.network.interface.` prefix with unique suffixes and separate network interface names as values. +

12
nifi-docs/src/main/asciidoc/getting-started.adoc
View File

@ -66,11 +66,9 @@ available:
- a "tarball" (tar.gz) that is tailored more to Linux - a "tarball" (tar.gz) that is tailored more to Linux
- a zip file that is more applicable for Windows users - 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. macOS 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 macOS or do not have Homebrew installed, after downloading the version of NiFi that you
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 For information on how to configure the instance of NiFi (for example, to configure security, data storage
@ -91,9 +89,9 @@ This will launch NiFi and leave it running in the foreground. To shut down NiFi,
was launched and hold the Ctrl key while pressing C. was launched and hold the Ctrl key while pressing C.
=== For Linux/Mac OS X users === For Linux/macOS users
For Linux and OS X users, use a Terminal window to navigate to the directory where NiFi was installed. For Linux and macOS users, use a Terminal window to navigate to the directory where NiFi was installed.
To run NiFi in the foreground, run `bin/nifi.sh run`. This will leave the application running until To run NiFi in the foreground, run `bin/nifi.sh run`. This will leave the application running until
the user presses Ctrl-C. At that time, it will initiate shutdown of the application. the user presses Ctrl-C. At that time, it will initiate shutdown of the application.
@ -104,7 +102,7 @@ If NiFi was installed with Homebrew, run the commands `nifi start` or `nifi stop
=== Installing as a Service === Installing as a Service
Currently, installing NiFi as a service is supported only for Linux and Mac OS X users. To install the application Currently, installing NiFi as a service is supported only for Linux and macOS users. To install the application
as a service, navigate to the installation directory in a Terminal window and execute the command `bin/nifi.sh install` as a service, navigate to the installation directory in a Terminal window and execute the command `bin/nifi.sh install`
to install the service with the default name `nifi`. To specify a custom name for the service, execute the command to install the service with the default name `nifi`. To specify a custom name for the service, execute the command
with an optional second argument that is the name of the service. For example, to install NiFi as a service with the with an optional second argument that is the name of the service. For example, to install NiFi as a service with the

4
nifi-docs/src/main/asciidoc/walkthroughs.adoc
View File

@ -38,7 +38,7 @@ Apache NiFi is an easy to use, powerful, and reliable system to process and dist
|Estimated Duration | 1 minute + download time |Estimated Duration | 1 minute + download time
|======================================================================================================================= |=======================================================================================================================
NOTE: The following instructions are for installing a single node of NiFi. This guide assumes Mac OS X / macOS 10.11.0+ but should work for any modern operating system. *nix commands are used by default, but Windows equivalents are provided where available. NOTE: The following instructions are for installing a single node of NiFi. This guide assumes macOS 10.11.0+ but should work for any modern operating system. *nix commands are used by default, but Windows equivalents are provided where available.
. Go to the link:http://nifi.apache.org/download.html[Apache NiFi Downloads^] page. . Go to the link:http://nifi.apache.org/download.html[Apache NiFi Downloads^] page.
. Download the latest version of NiFi via the compressed binary files. For example, if the latest version is 1.11.4: . Download the latest version of NiFi via the compressed binary files. For example, if the latest version is 1.11.4:
@ -69,7 +69,7 @@ image::verify-release-gpg-and-checksums.png["Verifying the GPG signature and che
|Estimated Duration | 10 - 35 minutes + download time |Estimated Duration | 10 - 35 minutes + download time
|======================================================================================================================= |=======================================================================================================================
NOTE: This guide assumes Mac OS X / macOS 10.11.0+ but should work for any modern operating system. *nix commands are used by default, but Windows equivalents are provided where available. NOTE: This guide assumes macOS 10.11.0+ but should work for any modern operating system. *nix commands are used by default, but Windows equivalents are provided where available.
. Go to the link:http://nifi.apache.org/download.html[Apache NiFi Downloads^] page. . Go to the link:http://nifi.apache.org/download.html[Apache NiFi Downloads^] page.
. Download the latest version of NiFi source code via the compressed files. For example, if the latest version is 1.11.4: . Download the latest version of NiFi source code via the compressed files. For example, if the latest version is 1.11.4: