From 1de2ff0cc94433227df578ce4903563f6762382f Mon Sep 17 00:00:00 2001 From: Eugenio Romano Date: Fri, 22 Nov 2019 12:58:33 +0000 Subject: [PATCH] [DOCS-5508] Add more info for kerberos (#5280) * Add more info for kerberos * fix * Minor updates --- docs/core/components/login.component.md | 14 ++++++-------- docs/core/directives/logout.directive.md | 9 +++++++++ docs/user-guide/README.md | 1 + docs/user-guide/kerberos.md | 19 +++++++++++++++++++ 4 files changed, 35 insertions(+), 8 deletions(-) create mode 100644 docs/user-guide/kerberos.md diff --git a/docs/core/components/login.component.md b/docs/core/components/login.component.md index bfd1a1d209..7c02720d04 100644 --- a/docs/core/components/login.component.md +++ b/docs/core/components/login.component.md @@ -346,17 +346,15 @@ To enable public accessible urls, that don't need authentication, these must be } ``` + ### Kerberos -Setting the `withCredentials` property to true in the `auth` section of -`app.config.json` will enable Kerberos and bypass the normal login: +The configuration for Kerberos authentication will allow users to access Alfresco products by entering their credentials only once when first logging into their Windows environment. + +**You don't need to use the login component in order to enable Kerberos SSO in ADF**. + +See [Kerberos Configuration](../../../docs/user-guide/kerberos.md) for instructions on configuring Kerberos for an ADF app. -```json -{ - "auth": { - "withCredentials": "true" - }, -``` ## See Also diff --git a/docs/core/directives/logout.directive.md b/docs/core/directives/logout.directive.md index 381fa408b3..4a40c1d52b 100644 --- a/docs/core/directives/logout.directive.md +++ b/docs/core/directives/logout.directive.md @@ -24,6 +24,15 @@ Logs the user out when the decorated element is clicked. | enableRedirect | `boolean` | true | Enable redirecting after logout | | redirectUri | `string` | "/login" | URI to redirect to after logging out. | + +## Kerberos + +The configuration for Kerberos authentication will allow users to access Alfresco products by entering their credentials only once when logging into their Windows environment. + +**You don't need to use the logout directive when Kerberos SSO is enabled in ADF**. + +See [Kerberos Configuration](../../../docs/user-guide/kerberos.md) for instructions on configuring Kerberos for an ADF app. + ## See also - [Login component](../components/login.component.md) diff --git a/docs/user-guide/README.md b/docs/user-guide/README.md index 47553e4f65..2439bfe531 100644 --- a/docs/user-guide/README.md +++ b/docs/user-guide/README.md @@ -21,5 +21,6 @@ on an item below to see the corresponding guide page. - [Transclusion](transclusion.md) - [Typography](typography.md) - [Walkthrough - adding indicators to highlight information about a node](metadata-indicators.md) +- [kerberos](kerberos.md) diff --git a/docs/user-guide/kerberos.md b/docs/user-guide/kerberos.md new file mode 100644 index 0000000000..629595d617 --- /dev/null +++ b/docs/user-guide/kerberos.md @@ -0,0 +1,19 @@ +--- +Title: Kerberos +Added: v3.6.0 +--- + +# Kerberos +The configuration for Kerberos authentication will allow users to access ADF applications by entering their credentials only once when logging into their Windows environment. + +To enable Kerberos SSO and bypass the normal login, set the `withCredentials` property to `true` in the `auth` section of the `app.config.json`: + +```json +{ + "auth": { + "withCredentials": "true" + } +} +``` + +**Note**: You don't need to use the [login component](../../docs/core/components/login.component.md) and [logout directive](../../docs/core/directives/logout.directive.md) in your app when using Kerberos.