Repository: nifi-site Updated Branches: refs/heads/master 21112cfab -> 1dac36b89
MINIFI-55 Adding MiNiFi Toolkit information to the web site and linking. Project: http://git-wip-us.apache.org/repos/asf/nifi-site/repo Commit: http://git-wip-us.apache.org/repos/asf/nifi-site/commit/1dac36b8 Tree: http://git-wip-us.apache.org/repos/asf/nifi-site/tree/1dac36b8 Diff: http://git-wip-us.apache.org/repos/asf/nifi-site/diff/1dac36b8 Branch: refs/heads/master Commit: 1dac36b8981936c276c7c57dea8be4aac5de3a5e Parents: 21112cf Author: Aldrin Piri <[email protected]> Authored: Mon Aug 8 14:33:15 2016 -0400 Committer: Aldrin Piri <[email protected]> Committed: Mon Aug 8 14:33:15 2016 -0400 ---------------------------------------------------------------------- src/includes/minifi/minifi-topbar.hbs | 3 +- src/pages/markdown/minifi/minifi-toolkit.md | 112 +++++++++++++++++++++++ 2 files changed, 114 insertions(+), 1 deletion(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/nifi-site/blob/1dac36b8/src/includes/minifi/minifi-topbar.hbs ---------------------------------------------------------------------- diff --git a/src/includes/minifi/minifi-topbar.hbs b/src/includes/minifi/minifi-topbar.hbs index cf79aeb..e5873aa 100644 --- a/src/includes/minifi/minifi-topbar.hbs +++ b/src/includes/minifi/minifi-topbar.hbs @@ -27,7 +27,8 @@ <a href="#">Documentation</a> <ul class="dropdown"> <li><a href="faq.html"><i class="fa"></i>FAQ</a></li> - <li><a href="system-admin-guide.html"><i class="fa"></i>MiNiFi Administrator's Guide</a></li> + <li><a href="system-admin-guide.html"><i class="fa"></i>Administrator's Guide</a></li> + <li><a href="minifi-toolkit.html"><i class="fa"></i>Converter Toolkit</a></li> <li><a href="https://cwiki.apache.org/confluence/display/MiNiFi";><i class="fa fa-external-link external-link"></i>Wiki</a></li> </ul> </li> http://git-wip-us.apache.org/repos/asf/nifi-site/blob/1dac36b8/src/pages/markdown/minifi/minifi-toolkit.md ---------------------------------------------------------------------- diff --git a/src/pages/markdown/minifi/minifi-toolkit.md b/src/pages/markdown/minifi/minifi-toolkit.md new file mode 100644 index 0000000..1c22bb6 --- /dev/null +++ b/src/pages/markdown/minifi/minifi-toolkit.md @@ -0,0 +1,112 @@ +--- +title: Apache NiFi MiNiFi Toolkit Guide +--- + +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + 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 + 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. + See the License for the specific language governing permissions and + limitations under the License. +--> +# Apache NiFi - MiNiFi - Toolkit + +MiNiFi is a child project effort of Apache NiFi. The MiNiFi toolkit aids in creating MiNiFi configuration files from exported NiFi templates. + +## Table of Contents + +- [Requirements](#requirements) +- [Getting Started](#getting-started) +- [Getting Help](#getting-help) +- [Documentation](#documentation) +- [License](#license) +- [Export Control](#export-control) + +## Requirements +* JRE 1.8 + +## Getting Started + +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 + + - Windows + execute bin/config.bat + +- Usage Information + + Usage: + + java org.apache.nifi.minifi.toolkit.configuration.ConfigMain <command> options + + Valid commands include: + transform: Transform template xml into MiNiFi config YAML + validate: Validate config YAML + +## 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)). +We're also often available in IRC: #nifi on +[irc.freenode.net](http://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. + +## 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) + +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 + +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. +See the License for the specific language governing permissions and +limitations under the License. + +## Export Control + +This distribution includes cryptographic software. The country in which you +currently reside may have restrictions on the import, possession, use, and/or +re-export to another country, of encryption software. BEFORE using any +encryption software, please check your country's laws, regulations and +policies concerning the import, possession, or use, and re-export of encryption +software, to see if this is permitted. See <http://www.wassenaar.org/> for more +information. + +The U.S. Government Department of Commerce, Bureau of Industry and Security +(BIS), has classified this software as Export Commodity Control Number (ECCN) +5D002.C.1, which includes information security software using or performing +cryptographic functions with asymmetric algorithms. The form and manner of this +Apache Software Foundation distribution makes it eligible for export under the +License Exception ENC Technology Software Unrestricted (TSU) exception (see the +BIS Export Administration Regulations, Section 740.13) for both object code and +source code. + +The following provides more details on the included cryptographic software: + +Apache NiFi - MiNiFi uses BouncyCastle, Jasypt, JCraft Inc., and the built-in +java cryptography libraries for SSL, SSH, and the protection +of sensitive configuration parameters. See +http://bouncycastle.org/about.html +http://www.jasypt.org/faq.html +http://jcraft.com/c-info.html +http://www.oracle.com/us/products/export/export-regulations-345813.html +for more details on each of these libraries cryptography features.
