How to install and start NiFi

  • Linux/Unix/OS X

    • Decompress and untar into desired installation directory

    • 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

        • service nifi start

        • service nifi stop

        • service nifi status

  • Windows

    • Decompress into the desired installation directory

    • Make any desired edits in the 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)

    • Navigate to the <installdir>/bin directory

    • Double-click run-nifi.bat. This runs NiFi in the foreground and waits for a Ctrl-C to initiate shutdown of NiFi

    • To see the current status of NiFi, double-click status-nifi.bat

When NiFi first starts up, the following files and directories are created:

  • content_repository

  • database_repository

  • flowfile_repository

  • provenance_repository

  • work directory

  • logs directory

  • Within the conf directory, the flow.xml.gz file is created

See the System Properties section of this guide for more information about configuring NiFi repositories and configuration files.