This is an automated email from the ASF dual-hosted git repository. joewitt pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/nifi.git
The following commit(s) were added to refs/heads/main by this push: new eb154d0640 NIFI-13518 Removed duplicative Windows start scripts This closes #9052 eb154d0640 is described below commit eb154d0640485fdbe028095a65d32b8c32d7e45e Author: exceptionfactory <exceptionfact...@apache.org> AuthorDate: Fri Jul 5 08:53:34 2024 -0500 NIFI-13518 Removed duplicative Windows start scripts This closes #9052 - Removed run-nifi.bat in favor of nifi.cmd Signed-off-by: Joseph Witt <joew...@apache.org> --- nifi-assembly/README.md | 2 +- .../src/main/asciidoc/administration-guide.adoc | 7 +-- nifi-docs/src/main/asciidoc/getting-started.adoc | 2 +- .../src/main/resources/bin/dump-nifi.bat | 50 ---------------------- .../src/main/resources/bin/nifi-env.bat | 29 ------------- .../src/main/resources/bin/run-nifi.bat | 50 ---------------------- .../src/main/resources/bin/status-nifi.bat | 49 --------------------- 7 files changed, 6 insertions(+), 183 deletions(-) diff --git a/nifi-assembly/README.md b/nifi-assembly/README.md index f3f2361c20..394a1181ed 100644 --- a/nifi-assembly/README.md +++ b/nifi-assembly/README.md @@ -50,7 +50,7 @@ Apache NiFi was made for dataflow. It supports highly configurable directed grap To start NiFi: - [linux/osx] execute bin/nifi.sh start -- [windows] execute bin/run-nifi.bat +- [windows] execute bin/nifi.cmd start - Obtain the generated username and password from logs/nifi-app.log - [linux/osx] For example: `cat logs/nifi-app.log | grep Generated` - Direct your browser to https://localhost:8443/nifi/ diff --git a/nifi-docs/src/main/asciidoc/administration-guide.adoc b/nifi-docs/src/main/asciidoc/administration-guide.adoc index 0b2a0e5ebf..76a06f1ebc 100644 --- a/nifi-docs/src/main/asciidoc/administration-guide.adoc +++ b/nifi-docs/src/main/asciidoc/administration-guide.adoc @@ -58,9 +58,10 @@ NOTE: Under sustained and extremely high throughput the CodeCache settings may n ** 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` +** From the `<installdir>\bin` directory, execute the following commands by typing `.\nifi.cmd <command>`: +*** `start`: starts NiFi in the background +*** `stop`: stops NiFi that is running in the background +*** `status`: provides the current status of NiFi When NiFi first starts up, the following files and directories are created: diff --git a/nifi-docs/src/main/asciidoc/getting-started.adoc b/nifi-docs/src/main/asciidoc/getting-started.adoc index 08b7d96bc1..657cddf838 100644 --- a/nifi-docs/src/main/asciidoc/getting-started.adoc +++ b/nifi-docs/src/main/asciidoc/getting-started.adoc @@ -83,7 +83,7 @@ appropriate for your operating system. === For Windows Users For Windows users, navigate to the folder where NiFi was installed. Within this folder is a subfolder -named `bin`. Navigate to this subfolder and double-click the `run-nifi.bat` file. +named `bin`. Navigate to this subfolder and run `nifi.cmd start` file. This will launch NiFi and leave it running in the foreground. To shut down NiFi, select the window that was launched and hold the Ctrl key while pressing C. diff --git a/nifi-framework-bundle/nifi-framework/nifi-resources/src/main/resources/bin/dump-nifi.bat b/nifi-framework-bundle/nifi-framework/nifi-resources/src/main/resources/bin/dump-nifi.bat deleted file mode 100644 index e980a6eae9..0000000000 --- a/nifi-framework-bundle/nifi-framework/nifi-resources/src/main/resources/bin/dump-nifi.bat +++ /dev/null @@ -1,50 +0,0 @@ -@echo off -rem -rem Licensed to the Apache Software Foundation (ASF) under one or more -rem contributor license agreements. See the NOTICE file distributed with -rem this work for additional information regarding copyright ownership. -rem The ASF licenses this file to You under the Apache License, Version 2.0 -rem (the "License"); you may not use this file except in compliance with -rem the License. You may obtain a copy of the License at -rem -rem http://www.apache.org/licenses/LICENSE-2.0 -rem -rem Unless required by applicable law or agreed to in writing, software -rem distributed under the License is distributed on an "AS IS" BASIS, -rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -rem See the License for the specific language governing permissions and -rem limitations under the License. -rem - -rem Set environment variables - -call %~sdp0\nifi-env.bat - -rem Use JAVA_HOME if it's set; otherwise, just use java - -if "%JAVA_HOME%" == "" goto noJavaHome -if not exist "%JAVA_HOME%\bin\java.exe" goto noJavaHome -set JAVA_EXE=%JAVA_HOME%\bin\java.exe -goto startNifi - -:noJavaHome -echo The JAVA_HOME environment variable is not defined correctly. -echo Instead the PATH will be used to find the java executable. -echo. -set JAVA_EXE=java -goto startNifi - -:startNifi -pushd "%NIFI_ROOT%" -set LIB_DIR=lib\bootstrap -set CONF_DIR=conf - -set BOOTSTRAP_CONF_FILE=%CONF_DIR%\bootstrap.conf -set JAVA_ARGS=-Dorg.apache.nifi.bootstrap.config.log.dir=%NIFI_LOG_DIR% -Dorg.apache.nifi.bootstrap.config.pid.dir=%NIFI_PID_DIR% -Dorg.apache.nifi.bootstrap.config.file=%BOOTSTRAP_CONF_FILE% - -SET JAVA_PARAMS=-cp %CONF_DIR%;%LIB_DIR%\* -Xms12m -Xmx24m %JAVA_ARGS% org.apache.nifi.bootstrap.RunNiFi -set BOOTSTRAP_ACTION=dump - -cmd.exe /C "%JAVA_EXE%" %JAVA_PARAMS% %BOOTSTRAP_ACTION% - -popd diff --git a/nifi-framework-bundle/nifi-framework/nifi-resources/src/main/resources/bin/nifi-env.bat b/nifi-framework-bundle/nifi-framework/nifi-resources/src/main/resources/bin/nifi-env.bat deleted file mode 100644 index 64632cf5a8..0000000000 --- a/nifi-framework-bundle/nifi-framework/nifi-resources/src/main/resources/bin/nifi-env.bat +++ /dev/null @@ -1,29 +0,0 @@ -@echo off -rem -rem Licensed to the Apache Software Foundation (ASF) under one or more -rem contributor license agreements. See the NOTICE file distributed with -rem this work for additional information regarding copyright ownership. -rem The ASF licenses this file to You under the Apache License, Version 2.0 -rem (the "License"); you may not use this file except in compliance with -rem the License. You may obtain a copy of the License at -rem -rem http://www.apache.org/licenses/LICENSE-2.0 -rem -rem Unless required by applicable law or agreed to in writing, software -rem distributed under the License is distributed on an "AS IS" BASIS, -rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -rem See the License for the specific language governing permissions and -rem limitations under the License. -rem - - -rem The java implementation to use -rem set JAVA_HOME="C:\Program Files\Java\jdk" - -set NIFI_ROOT=%~sdp0..\ - -rem The directory for the NiFi pid file -set NIFI_PID_DIR=%NIFI_ROOT%\run - -rem The directory for NiFi log files -set NIFI_LOG_DIR=%NIFI_ROOT%\logs \ No newline at end of file diff --git a/nifi-framework-bundle/nifi-framework/nifi-resources/src/main/resources/bin/run-nifi.bat b/nifi-framework-bundle/nifi-framework/nifi-resources/src/main/resources/bin/run-nifi.bat deleted file mode 100644 index 7629abcd28..0000000000 --- a/nifi-framework-bundle/nifi-framework/nifi-resources/src/main/resources/bin/run-nifi.bat +++ /dev/null @@ -1,50 +0,0 @@ -@echo off -rem -rem Licensed to the Apache Software Foundation (ASF) under one or more -rem contributor license agreements. See the NOTICE file distributed with -rem this work for additional information regarding copyright ownership. -rem The ASF licenses this file to You under the Apache License, Version 2.0 -rem (the "License"); you may not use this file except in compliance with -rem the License. You may obtain a copy of the License at -rem -rem http://www.apache.org/licenses/LICENSE-2.0 -rem -rem Unless required by applicable law or agreed to in writing, software -rem distributed under the License is distributed on an "AS IS" BASIS, -rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -rem See the License for the specific language governing permissions and -rem limitations under the License. -rem - -rem Set environment variables - -call %~sdp0\nifi-env.bat - -rem Use JAVA_HOME if it's set; otherwise, just use java - -if "%JAVA_HOME%" == "" goto noJavaHome -if not exist "%JAVA_HOME%\bin\java.exe" goto noJavaHome -set JAVA_EXE=%JAVA_HOME%\bin\java.exe -goto startNifi - -:noJavaHome -echo The JAVA_HOME environment variable is not defined correctly. -echo Instead the PATH will be used to find the java executable. -echo. -set JAVA_EXE=java -goto startNifi - -:startNifi -pushd "%NIFI_ROOT%" -set LIB_DIR=lib\bootstrap -set CONF_DIR=conf - -set BOOTSTRAP_CONF_FILE=%CONF_DIR%\bootstrap.conf -set JAVA_ARGS=-Dorg.apache.nifi.bootstrap.config.log.dir=%NIFI_LOG_DIR% -Dorg.apache.nifi.bootstrap.config.pid.dir=%NIFI_PID_DIR% -Dorg.apache.nifi.bootstrap.config.file=%BOOTSTRAP_CONF_FILE% - -SET JAVA_PARAMS=-cp %CONF_DIR%;%LIB_DIR%\* -Xms12m -Xmx24m %JAVA_ARGS% org.apache.nifi.bootstrap.RunNiFi -set BOOTSTRAP_ACTION=run - -cmd.exe /C "%JAVA_EXE%" %JAVA_PARAMS% %BOOTSTRAP_ACTION% - -popd diff --git a/nifi-framework-bundle/nifi-framework/nifi-resources/src/main/resources/bin/status-nifi.bat b/nifi-framework-bundle/nifi-framework/nifi-resources/src/main/resources/bin/status-nifi.bat deleted file mode 100644 index a0980ac3a1..0000000000 --- a/nifi-framework-bundle/nifi-framework/nifi-resources/src/main/resources/bin/status-nifi.bat +++ /dev/null @@ -1,49 +0,0 @@ -@echo off -rem -rem Licensed to the Apache Software Foundation (ASF) under one or more -rem contributor license agreements. See the NOTICE file distributed with -rem this work for additional information regarding copyright ownership. -rem The ASF licenses this file to You under the Apache License, Version 2.0 -rem (the "License"); you may not use this file except in compliance with -rem the License. You may obtain a copy of the License at -rem -rem http://www.apache.org/licenses/LICENSE-2.0 -rem -rem Unless required by applicable law or agreed to in writing, software -rem distributed under the License is distributed on an "AS IS" BASIS, -rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -rem See the License for the specific language governing permissions and -rem limitations under the License. -rem - - -call %~sdp0\nifi-env.bat - -rem Use JAVA_HOME if it's set; otherwise, just use java - -if "%JAVA_HOME%" == "" goto noJavaHome -if not exist "%JAVA_HOME%\bin\java.exe" goto noJavaHome -set JAVA_EXE=%JAVA_HOME%\bin\java.exe -goto startNifi - -:noJavaHome -echo The JAVA_HOME environment variable is not defined correctly. -echo Instead the PATH will be used to find the java executable. -echo. -set JAVA_EXE=java -goto startNifi - -:startNifi -pushd "%NIFI_ROOT%" -set LIB_DIR=lib\bootstrap -set CONF_DIR=conf - -set BOOTSTRAP_CONF_FILE=%CONF_DIR%\bootstrap.conf -set JAVA_ARGS=-Dorg.apache.nifi.bootstrap.config.log.dir=%NIFI_LOG_DIR% -Dorg.apache.nifi.bootstrap.config.pid.dir=%NIFI_PID_DIR% -Dorg.apache.nifi.bootstrap.config.file=%BOOTSTRAP_CONF_FILE% - -set JAVA_PARAMS=-cp %LIB_DIR%\* -Xms12m -Xmx24m %JAVA_ARGS% org.apache.nifi.bootstrap.RunNiFi -set BOOTSTRAP_ACTION=status - -cmd.exe /C "%JAVA_EXE%" %JAVA_PARAMS% %BOOTSTRAP_ACTION% - -popd