Repository: nifi-minifi Updated Branches: refs/heads/master 38c7a8e0d -> 8431750dc
MINIFI-55 Adding links to the downloads for the MiNiFi Toolkit. Changing HTTP links to HTTPS where applicable Including reference to the MiNiFi Toolkit from the System Administrator guide. Project: http://git-wip-us.apache.org/repos/asf/nifi-minifi/repo Commit: http://git-wip-us.apache.org/repos/asf/nifi-minifi/commit/8431750d Tree: http://git-wip-us.apache.org/repos/asf/nifi-minifi/tree/8431750d Diff: http://git-wip-us.apache.org/repos/asf/nifi-minifi/diff/8431750d Branch: refs/heads/master Commit: 8431750dc12d1994fb2c5eff518a2f7e8f086ec2 Parents: 38c7a8e Author: Aldrin Piri <[email protected]> Authored: Fri Aug 5 13:23:00 2016 -0400 Committer: Aldrin Piri <[email protected]> Committed: Mon Aug 8 14:47:00 2016 -0400 ---------------------------------------------------------------------- README.md | 18 +++++++++--------- .../src/main/markdown/System_Admin_Guide.md | 4 ++++ minifi-toolkit/minifi-toolkit-assembly/README.md | 5 +++-- 3 files changed, 16 insertions(+), 11 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/nifi-minifi/blob/8431750d/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md index e7d7f5a..97f1f08 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ The ASF licenses this file to You under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 + https://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -28,7 +28,7 @@ MiNiFi is a child project effort of Apache NiFi ## Features -Apache NiFi - MiNiFi is a complementary data collection approach that supplements the core tenets of [NiFi](http://nifi.apache.org/) in dataflow management, focusing on the collection of data at the source of its creation. +Apache NiFi - MiNiFi is a complementary data collection approach that supplements the core tenets of [NiFi](https://nifi.apache.org/) in dataflow management, focusing on the collection of data at the source of its creation. Specific goals for MiNiFi are comprised of: - small and lightweight footprint @@ -46,7 +46,7 @@ Perspectives of the role of MiNiFi should be from the perspective of the agent a To build: - Execute `mvn clean install` or for parallel build execute `mvn -T 2.0C clean install`. On a - modest development laptop that is a couple of years old, the latter build takes a bit under ten + modest development laptop that is a couple of years old, the latter build takes a bit under two minutes. After a large amount of output you should eventually see a success message. $ mvn -T 2.0C clean install @@ -75,7 +75,7 @@ To run: location make use of either the tarball or zipfile and unpack them wherever you like. The distribution will be within a common parent directory named for the version. - $ mkdir ~/example-nifi-deploy + $ mkdir ~/example-minifi-deploy $ tar xzf target/minifi-*-bin.tar.gz -C ~/example-minifi-deploy $ ls -lh ~/example-minifi-deploy/ total 0 @@ -99,24 +99,24 @@ To run MiNiFi: ## Getting Help If you have questions, you can reach out to our mailing list: [email protected] -([archive](http://mail-archives.apache.org/mod_mbox/nifi-dev)). +([archive](https://mail-archives.apache.org/mod_mbox/nifi-dev)). We're also often available in IRC: #nifi on -[irc.freenode.net](http://webchat.freenode.net/?channels=#nifi). +[irc.freenode.net](https://webchat.freenode.net/?channels=#nifi). ## Documentation -See http://nifi.apache.org/minifi and https://cwiki.apache.org/confluence/display/NIFI/MiNiFi for the latest documentation. +See https://nifi.apache.org/minifi and https://cwiki.apache.org/confluence/display/MINIFI for the latest documentation. ## License Except as otherwise noted this software is licensed under the -[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html) +[Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0.html) Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 + https://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, http://git-wip-us.apache.org/repos/asf/nifi-minifi/blob/8431750d/minifi-docs/src/main/markdown/System_Admin_Guide.md ---------------------------------------------------------------------- diff --git a/minifi-docs/src/main/markdown/System_Admin_Guide.md b/minifi-docs/src/main/markdown/System_Admin_Guide.md index c731a7d..8a249ad 100644 --- a/minifi-docs/src/main/markdown/System_Admin_Guide.md +++ b/minifi-docs/src/main/markdown/System_Admin_Guide.md @@ -162,6 +162,10 @@ bulletinList=null}], connectionStatusList=null, remoteProcessingGroupStatusList= The config.yml in the _conf_ directory is the main configuration file for controlling how MiNiFi runs. This section provides an overview of the properties in this file. The file is a YAML and follows the YAML format laid out [here](http://www.yaml.org/). +Alternatively, the MiNiFi Toolkit Converter can aid in creating a config.yml from a generated template exported from a NiFi instance. This +tool can be downloaded from http://nifi.apache.org/minifi/download.html under the `MiNiFi Toolkit Binaries` section. Information on the toolkit's usage is +available at https://nifi.apache.org/minifi/minifi-toolkit.html. + NOTE: Note that values for periods of time and data sizes must include the unit of measure, for example "10 sec" or "10 MB", not simply "10". http://git-wip-us.apache.org/repos/asf/nifi-minifi/blob/8431750d/minifi-toolkit/minifi-toolkit-assembly/README.md ---------------------------------------------------------------------- diff --git a/minifi-toolkit/minifi-toolkit-assembly/README.md b/minifi-toolkit/minifi-toolkit-assembly/README.md index b21441d..c4a49a6 100644 --- a/minifi-toolkit/minifi-toolkit-assembly/README.md +++ b/minifi-toolkit/minifi-toolkit-assembly/README.md @@ -27,10 +27,11 @@ MiNiFi is a child project effort of Apache NiFi. The MiNiFi toolkit aids in cre ## Requirements * JRE 1.8 - ## Getting Started -To run the MiNiFi Toolkit Converter: +The latest version of the MiNiFi Toolkit Converter can be found at http://nifi.apache.org/minifi/download.html under the `MiNiFi Toolkit Binaries` section. + +After downloading the binary and extracting it, to run the MiNiFi Toolkit Converter: - Change directory to the location where you installed MiNiFi Toolkit and run it and view usage information - Linux / OS X $ ./config.sh
