Repository: nifi-registry Updated Branches: refs/heads/master e3e24c10b -> f87b927e5
NIFIREG-123 Made external links open in new windows This closes #93. Signed-off-by: Kevin Doran <[email protected]> Project: http://git-wip-us.apache.org/repos/asf/nifi-registry/repo Commit: http://git-wip-us.apache.org/repos/asf/nifi-registry/commit/f87b927e Tree: http://git-wip-us.apache.org/repos/asf/nifi-registry/tree/f87b927e Diff: http://git-wip-us.apache.org/repos/asf/nifi-registry/diff/f87b927e Branch: refs/heads/master Commit: f87b927e53a1e72808e0ac8dd5bff344f0beeac0 Parents: e3e24c1 Author: Andrew Lim <[email protected]> Authored: Mon Jan 22 15:26:37 2018 -0500 Committer: Kevin Doran <[email protected]> Committed: Tue Jan 23 11:21:25 2018 -0500 ---------------------------------------------------------------------- .../src/main/asciidoc/administration-guide.adoc | 5 +++-- .../src/main/asciidoc/getting-started.adoc | 14 ++++++++------ 2 files changed, 11 insertions(+), 8 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/nifi-registry/blob/f87b927e/nifi-registry-docs/src/main/asciidoc/administration-guide.adoc ---------------------------------------------------------------------- diff --git a/nifi-registry-docs/src/main/asciidoc/administration-guide.adoc b/nifi-registry-docs/src/main/asciidoc/administration-guide.adoc index bc804e1..93864af 100644 --- a/nifi-registry-docs/src/main/asciidoc/administration-guide.adoc +++ b/nifi-registry-docs/src/main/asciidoc/administration-guide.adoc @@ -17,6 +17,7 @@ = Apache NiFi Registry System Administrator's Guide Apache NiFi Team <[email protected]> :homepage: http://nifi.apache.org +:linkattrs: == System Requirements @@ -769,9 +770,9 @@ See <<kerberos_properties>> for complete documentation. * Kerberos is case-sensitive in many places and the error messages (or lack thereof) may not be sufficiently explanatory. Check the case sensitivity of the service principal in your configuration files. The convention is `HTTP/fully.qualified.domain@REALM`. * Browsers have varying levels of restriction when dealing with SPNEGO negotiations. - Some will provide the local Kerberos ticket to any domain that requests it, while others whitelist the trusted domains. See link:http://docs.spring.io/autorepo/docs/spring-security-kerberos/1.0.2.BUILD-SNAPSHOT/reference/htmlsingle/#browserspnegoconfig[Spring Security Kerberos - Reference Documentation: Appendix E. Configure browsers for SPNEGO Negotiation] for common browsers. + Some will provide the local Kerberos ticket to any domain that requests it, while others whitelist the trusted domains. See link:http://docs.spring.io/autorepo/docs/spring-security-kerberos/1.0.2.BUILD-SNAPSHOT/reference/htmlsingle/#browserspnegoconfig[Spring Security Kerberos - Reference Documentation: Appendix E. Configure browsers for SPNEGO Negotiation^] for common browsers. * Some browsers (legacy IE) do not support recent encryption algorithms such as AES, and are restricted to legacy algorithms (DES). This should be noted when generating keytabs. -* The KDC must be configured and a service principal defined for NiFi and a keytab exported. Comprehensive instructions for Kerberos server configuration and administration are beyond the scope of this document (see link:http://web.mit.edu/kerberos/krb5-current/doc/admin/index.html[MIT Kerberos Admin Guide]), but an example is below: +* The KDC must be configured and a service principal defined for NiFi and a keytab exported. Comprehensive instructions for Kerberos server configuration and administration are beyond the scope of this document (see link:http://web.mit.edu/kerberos/krb5-current/doc/admin/index.html[MIT Kerberos Admin Guide^]), but an example is below: * Kerberos tickets may use AES encryption with keys up to 256-bits in length, and therefore unlimited strength encryption policies may be required for the Jave Runtime Environment (JRE) used for NiFi Registry when Kerberos SPNEGO is configured. Adding a service principal for a server at `nifi.nifi.apache.org` and exporting the keytab from the KDC: http://git-wip-us.apache.org/repos/asf/nifi-registry/blob/f87b927e/nifi-registry-docs/src/main/asciidoc/getting-started.adoc ---------------------------------------------------------------------- diff --git a/nifi-registry-docs/src/main/asciidoc/getting-started.adoc b/nifi-registry-docs/src/main/asciidoc/getting-started.adoc index fef0132..180e58a 100644 --- a/nifi-registry-docs/src/main/asciidoc/getting-started.adoc +++ b/nifi-registry-docs/src/main/asciidoc/getting-started.adoc @@ -17,10 +17,11 @@ = Getting Started with Apache NiFi Registry Apache NiFi Team <[email protected]> :homepage: http://nifi.apache.org +:linkattrs: == Who is This Guide For? -This guide is written for users who have basic experience with NiFi but have little familiarity with the NiFi Registry. This guide is not intended to be an exhaustive instruction manual or a reference guide. The link:user-guide.html[NiFi Registry User Guide] and link:https://nifi.apache.org/docs/nifi-docs/html/user-guide.html[NiFi User Guide] provide a great deal more information about using the Registry and integrating it with NiFi. This guide, in comparison, is intended to provide users with just the information needed in order to understand how to configure NiFi Registry, connect with NiFi and start using versioned NiFi dataflows. +This guide is written for users who have basic experience with NiFi but have little familiarity with the NiFi Registry. This guide is not intended to be an exhaustive instruction manual or a reference guide. The link:user-guide.html[NiFi Registry User Guide] and link:https://nifi.apache.org/docs/nifi-docs/html/user-guide.html[NiFi User Guide^] provide a great deal more information about using the Registry and integrating it with NiFi. This guide, in comparison, is intended to provide users with just the information needed in order to understand how to configure NiFi Registry, connect with NiFi and start using versioned NiFi dataflows. == Terminology Used in This Guide @@ -32,7 +33,7 @@ In order to talk about NiFi Registry, there are a few key terms that readers sho == Downloading and Installing NiFi Registry -NiFi Registry can be downloaded from the link:https://nifi.apache.org/registry.html[NiFi Registry Page]. There are two packaging options available: a tarball and a zip file. Supported operating systems include Linux, Unix and Mac OS X. +NiFi Registry can be downloaded from the link:https://nifi.apache.org/registry.html[NiFi Registry Page^]. There are two packaging options available: a tarball and a zip file. Supported operating systems include Linux, Unix and Mac OS X. For users who are not running OS X, after downloading NiFi Registry simply extract the archive to the location that you wish to run the application from. The registry is unsecured by default. @@ -57,7 +58,8 @@ Once installed, the service can be started and stopped using the appropriate com == I Started NiFi Registry. Now What? -Now that NiFi Registry has been started, we can bring up the User Interface (UI). To get started, open a web browser and navigate to `http://localhost:18080/nifi-registry`. The port can be changed by editing the `nifi-registry.properties` file in the NiFi Registry _conf_ directory, but the default port is 18080. +Now that NiFi Registry has been started, we can bring up the User Interface (UI). To get started, open a web browser and navigate to +link:http://localhost:18080/nifi-registry[`http://localhost:18080/nifi-registry`^]. The port can be changed by editing the `nifi-registry.properties` file in the NiFi Registry _conf_ directory, but the default port is 18080. This will bring up the Registry UI, which at this point is empty as there are no flow resources available to share yet: @@ -158,11 +160,11 @@ In addition to this Getting Started Guide, more information about NiFi Registry - link:user-guide.html[Apache NiFi Registry User Guide] - This guide provides information on how to navigate the Registry UI and explains in detail how to manage flows/policies/special privileges and configure users/groups when the Registry is secured. - link:administration-guide.html[Apache NiFi Registry System Administrator's Guide] - A guide for setting up and administering Apache NiFi Registry. Topics covered include: system requirements, security configuration, user authentication, authorization, proxy configuration and details about the different system-level settings. -- link:https://nifi.apache.org/docs/nifi-docs/html/user-guide.html[Apache NiFi User Guide] - A fairly extensive guide that is often used more as a Reference Guide, as it provides information on each of the different components available in NiFi and explains how to use the different features provided by the application. It includes the section "Versioning a Dataflow" which covers the integration of NiFi with NiFi Registry. Topics covered include: connecting to a registry, version states, importing a versioned flow and managing local changes. -- link:https://cwiki.apache.org/confluence/display/NIFI/Contributor+Guide[Contributor's Guide] - A guide for explaining how to contribute work back to the Apache NiFi community so that others can make use of it. +- link:https://nifi.apache.org/docs/nifi-docs/html/user-guide.html[Apache NiFi User Guide^] - A fairly extensive guide that is often used more as a Reference Guide, as it provides information on each of the different components available in NiFi and explains how to use the different features provided by the application. It includes the section "Versioning a Dataflow" which covers the integration of NiFi with NiFi Registry. Topics covered include: connecting to a registry, version states, importing a versioned flow and managing local changes. +- link:https://cwiki.apache.org/confluence/display/NIFI/Contributor+Guide[Contributor's Guide^] - A guide for explaining how to contribute work back to the Apache NiFi community so that others can make use of it. In addition to the guides provided here, you can browse the different -link:https://nifi.apache.org/mailing_lists.html[NiFi Mailing Lists] or send an e-mail to one of the mailing lists at +link:https://nifi.apache.org/mailing_lists.html[NiFi Mailing Lists^] or send an e-mail to one of the mailing lists at link:mailto:[email protected][[email protected]] or link:mailto:[email protected][[email protected]].
