diff --git a/docs/features/search-results.md b/docs/features/search-results.md index 848dbd003..bf879dcff 100644 --- a/docs/features/search-results.md +++ b/docs/features/search-results.md @@ -27,16 +27,16 @@ in the Content Application when using **Search Input** component. | Feature | Full | Partial | N/A | Details | | ---------------------------------------------------------------- | ---- | ------- | --- | ---------------------------------------------------------------------------------- | -| Search for a single term | X | | | [Docs](https://docs.alfresco.com/6.0/concepts/rm-searchsyntax-single.html) | -| Search for a phrase | | X | | [Docs](https://docs.alfresco.com/6.0/concepts/rm-searchsyntax-phrase.html) | -| Search for an exact term | X | | | [Docs](https://docs.alfresco.com/6.0/concepts/rm-searchsyntax-exact.html) | +| Search for a single term | 1.6 | | | [Docs](https://docs.alfresco.com/6.0/concepts/rm-searchsyntax-single.html) | +| Search for a phrase | | 1.7 | | [Docs](https://docs.alfresco.com/6.0/concepts/rm-searchsyntax-phrase.html) | +| Search for an exact term | 1.7 | | | [Docs](https://docs.alfresco.com/6.0/concepts/rm-searchsyntax-exact.html) | | Search for term expansion | | | X | [Docs](https://docs.alfresco.com/6.0/concepts/rm-searchsyntax-term.html) | -| Search for conjunctions | X | | | [Docs](https://docs.alfresco.com/6.0/concepts/rm-searchsyntax-conjunct.html) | -| Search for disjunctions | X | | | [Docs](https://docs.alfresco.com/6.0/concepts/rm-searchsyntax-disjunct.html) | +| Search for conjunctions | 1.7 | | | [Docs](https://docs.alfresco.com/6.0/concepts/rm-searchsyntax-conjunct.html) | +| Search for disjunctions | 1.7 | | | [Docs](https://docs.alfresco.com/6.0/concepts/rm-searchsyntax-disjunct.html) | | Search for negation | | | X | [Docs](https://docs.alfresco.com/6.0/concepts/rm-searchsyntax-negate.html) | | Search for optional, mandatory, and excluded elements of a query | | | X | [Docs](https://docs.alfresco.com/6.0/concepts/rm-searchsyntax-optional.html) | -| Search in fields | | X | | [Docs](https://docs.alfresco.com/6.0/concepts/rm-searchsyntax-fields.html) | -| Search for wildcards | | X | | [Docs](https://docs.alfresco.com/6.0/concepts/rm-searchsyntax-wildcards.html) | +| Search in fields | | 1.7 | | [Docs](https://docs.alfresco.com/6.0/concepts/rm-searchsyntax-fields.html) | +| Search for wildcards | | 1.7 | | [Docs](https://docs.alfresco.com/6.0/concepts/rm-searchsyntax-wildcards.html) | | Search for ranges | | | X | [Docs](https://docs.alfresco.com/6.0/concepts/rm-searchsyntax-ranges.html) | | Search for fuzzy matching | | | X | [Docs](https://docs.alfresco.com/6.0/concepts/rm-searchsyntax-fuzzy.html) | | Search for proximity | | | X | [Docs](https://docs.alfresco.com/6.0/concepts/rm-searchsyntax-proximity.html) | @@ -49,3 +49,6 @@ in the Content Application when using **Search Input** component. | Search query templates | | | X | [Docs](https://docs.alfresco.com/6.0/concepts/rm-searchsyntax-querytemplates.html) | | Search query literals | | | X | [Docs](https://docs.alfresco.com/6.0/concepts/rm-searchsyntax-literals.html) | | Search using date math | | | X | [Docs](https://docs.alfresco.com/6.0/concepts/rm-searchsyntax-datemaths.html) | + +> **Partial** support means the feature supports basic scenarios +> and there are edge cases that are not yet fully tested and might not work. diff --git a/docs/getting-started/README.md b/docs/getting-started/README.md index 486181fb0..38a7872ca 100644 --- a/docs/getting-started/README.md +++ b/docs/getting-started/README.md @@ -13,6 +13,7 @@ Learn how to start developing with the Alfresco Content Application. - [Building from source](/getting-started/building-from-source) - [Internationalization (i18n)](/getting-started/internationalization) - [CORS](/getting-started/cors) +- [Single Sign-On](/getting-started/sso) - [Configuration](/getting-started/configuration) - [Navigation](/getting-started/navigation) -- [Docker](/getting-started/docker) \ No newline at end of file +- [Docker](/getting-started/docker) diff --git a/docs/getting-started/building-from-source.md b/docs/getting-started/building-from-source.md index 5cd2bc012..418522cef 100644 --- a/docs/getting-started/building-from-source.md +++ b/docs/getting-started/building-from-source.md @@ -9,7 +9,10 @@ The Content App is based on [Angular CLI](https://cli.angular.io), and you can u ## Prerequisites for building - [Node.js](https://nodejs.org/en/) LTS -- [Angular CLI](https://cli.angular.io/) 1.7.3 +- (optional) [Angular CLI](https://cli.angular.io/) 7.3.4 or later + +> The Angular CLI libraries are already part of the setup. +> You may want installing it as a global (recommended) tool only if you intend using CLI commands separately. ## Cloning and running @@ -28,11 +31,11 @@ The application runs at port `4200` by default, and should automatically open in The Content App provides a proxy configuration for a local development server that allows you to address specific scenarios with CORS and a native authentication dialog. -You can find settings in the "proxy.conf.js" file in the project root directory. +You can find settings in the `proxy.conf.js` file in the project root directory. -**Note:** The proxy settings get automatically applied every time you run the application with the "npm start" script. +**Note:** The proxy settings get automatically applied every time you run the application with the `npm start` script. You must restart the application every time you change its settings. ## Running unit tests -Run `npm test` to execute the unit tests via [Karma](https://karma-runner.github.io). \ No newline at end of file +Run `npm test` to execute the unit tests via [Karma](https://karma-runner.github.io). diff --git a/docs/getting-started/sso.md b/docs/getting-started/sso.md new file mode 100644 index 000000000..14029f60f --- /dev/null +++ b/docs/getting-started/sso.md @@ -0,0 +1,59 @@ +--- +Title: Single Sign-On +--- + +# Single Sign-On + +Besides Basic Authentication, you can use Content Application with: + +- [Keycloak](https://www.keycloak.org/) +- [Alfresco Identity Service](https://docs.alfresco.com/identity1.0/concepts/identity-overview.html) +- Kerberos + +The application contains reasonable defaults for Single Sign-On (aka SSO) setup. +You can find the settings in the `app.config.json` file, and they look similar to the following: + +```json +{ + "providers": "ECM", + "authType": "BASIC", + "oauth2": { + "host": "http://localhost:4200/auth/realms/alfresco", + "clientId": "alfresco", + "scope": "openid", + "secret": "", + "implicitFlow": true, + "silentLogin": true, + "redirectSilentIframeUri": "./assets/silent-refresh.html", + "redirectUri": "/", + "redirectUriLogout": "/logout" + } +} +``` + +To switch from Basic Authentication to SSO mode, change the `authType` property value to `OAUTH`. +Also, the default configuration assumes you have an `alfresco` client pre-configured. + +You can experiment with authentication modes on the http://localhost:4200/#/settings page: + +![Authentication Settings](../images/aca-sso-settings.png) + +## Kerberos + +To enable support for the additional Kerberos features +please enable the `withCredentials` flag in the `app.config.json` file: + +```json +{ + "auth": { + "withCredentials": true + } +} +``` + +Note that with the `withCredentials` flag enabled, the application is not going to redirect users to Login screen +as the login process is handled entirely by Kerberos. + +## See also + +For more details on the ADF Login component and configuration options please refer to the [Login](https://www.alfresco.com/abn/adf/docs/core/login.component/#single-sign-on-sso) documentation. diff --git a/docs/images/aca-sso-settings.png b/docs/images/aca-sso-settings.png new file mode 100644 index 000000000..7fa3f3e54 Binary files /dev/null and b/docs/images/aca-sso-settings.png differ