diff --git a/docs/README.md b/docs/README.md index 51bac6553..c0863071c 100644 --- a/docs/README.md +++ b/docs/README.md @@ -40,6 +40,8 @@ The documentation is divided into the following sections: | ACA Version | Built with | Tested on | | ----------- | ---------- | --------- | +| ACA 3.1.0 | ADF 5.1.0 | ACS 7.3 | +| ACA 3.0.0 | ADF 5.0.0 | ACS 7.3 | | ACA 2.4.0 | ADF 4.4.0 | ACS 6.2 | | ACA 2.3.0 | ADF 4.3.0 | ACS 6.2 | | ACA 2.2.0 | ADF 4.2.0 | ACS 6.2 | @@ -60,35 +62,37 @@ The documentation is divided into the following sections: ## Available Features -| Version | Feature | Description | -| ------- | ---------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| 1.5 | My Files | Folder/File browsing of Personal Files. | -| 1.5 | File Libraries | Create, find, join and browse the file libraries of sites created in the repository. | -| 1.5 | Shared Files | Lists all files that have shared. | -| 1.5 | Recent Files | List files created and/or modified by the logged users within the last 30 days. | -| 1.5 | Favorites | Lists all favorite files for the user. | -| 1.5 | Trash | Lists all deleted items stored in the trash can, users can restore or permanently remove. Admin user will see items deleted by all users. | -| 1.5 | Upload | Files and folders can be uploaded through the New button or by dragging and dropping into the browser. | -| 1.5 | Search | Quick search with live results, and full faceted search results page. | -| 1.5 | Actions | A number of actions can be performed on files and/or folders, either individually or multiples at a time. | -| 1.5 | Viewer | Viewing files in natively in the browser, unsupported formats are transformed by the repository. | +| Version | Feature | Description | +| ------- | ---------------------------------- | ---------------------------------- | +| 3.1 | Folder Rules | Early preview of the Folder Rules | +| 3.0 | Angular 14 and ADF 5 | Upgrade to the latest version of Angular (14.x) and ADF (5.x) | +| 1.5 | My Files | Folder/File browsing of Personal Files. | +| 1.5 | File Libraries | Create, find, join and browse the file libraries of sites created in the repository. | +| 1.5 | Shared Files | Lists all files that have shared. | +| 1.5 | Recent Files | List files created and/or modified by the logged users within the last 30 days. | +| 1.5 | Favorites | Lists all favorite files for the user. | +| 1.5 | Trash | Lists all deleted items stored in the trash can, users can restore or permanently remove. Admin user will see items deleted by all users. | +| 1.5 | Upload | Files and folders can be uploaded through the New button or by dragging and dropping into the browser. | +| 1.5 | Search | Quick search with live results, and full faceted search results page. | +| 1.5 | Actions | A number of actions can be performed on files and/or folders, either individually or multiples at a time. | +| 1.5 | Viewer | Viewing files in natively in the browser, unsupported formats are transformed by the repository. | | 1.5 | Metadata | The information drawer can be configured in the app.config.json to display metadata information, by default file the Properties Aspect is shown and images will also include EXIF information. | -| 1.5 | File Sharing | Share files, with time expiry if required, externally with uniquely generated URLs. | -| 1.5 | Versioning | The version manager provides access and management of previous file versions, and the ability to upload new versions. | -| 1.5 | Permissions | Granular user permission management of the folders and files throughout the repository. | -| 1.5 | Extensibility | The application provides safe extension points allowing full customisation; see [Documentation](https://alfresco-content-app.netlify.com/#/extending/) for details. | -| 1.6 | Library management | Join and favorite libraries. New search input to find Libraries, files and/or folders. | -| 1.7 | Edit Offline | Lock and unlock for editing, download current version, upload new version. | -| 1.7 | Edit with Microsoft Office | Extension to edit online with Alfresco Office Services (AOS) | -| 1.7 | Single Sign-On (SSO) | Support for Alfresco Identity Service, with ADF 3.0.0 | -| 1.7 | Search Query Language | Enhanced search input using the Alfresco Search Query Language | -| 1.8 | Localizations . | Arabic, Czech, Danish, Finnish, Polish and Swedish | -| 1.8 | Metadata improvements | Automatic display of aspects and properties | -| 1.8 | Search facet improvements | Facet intervals and grouped facet queries | -| 1.8 | Extensibility improvements | Various - see [release notes](https://github.com/Alfresco/alfresco-content-app/releases) for details | -| 1.9 | Single Log Out | Users will be automatically logged out from the Content App after logging out from another application in the same browser session | -| 1.9 | Accessibility improvements | Various - see [release notes](https://github.com/Alfresco/alfresco-content-app/releases) for details | -| 1.10 | Create (file/folder) from template | Users can create files and folders structures from pre-set templates | +| 1.5 | File Sharing | Share files, with time expiry if required, externally with uniquely generated URLs. | +| 1.5 | Versioning | The version manager provides access and management of previous file versions, and the ability to upload new versions. | +| 1.5 | Permissions | Granular user permission management of the folders and files throughout the repository. | +| 1.5 | Extensibility | The application provides safe extension points allowing full customisation; see [Documentation](https://alfresco-content-app.netlify.com/#/extending/) for details. | +| 1.6 | Library management | Join and favorite libraries. New search input to find Libraries, files and/or folders. | +| 1.7 | Edit Offline | Lock and unlock for editing, download current version, upload new version. | +| 1.7 | Edit with Microsoft Office | Extension to edit online with Alfresco Office Services (AOS) | +| 1.7 | Single Sign-On (SSO) | Support for Alfresco Identity Service, with ADF 3.0.0 | +| 1.7 | Search Query Language | Enhanced search input using the Alfresco Search Query Language | +| 1.8 | Localizations . | Arabic, Czech, Danish, Finnish, Polish and Swedish | +| 1.8 | Metadata improvements | Automatic display of aspects and properties | +| 1.8 | Search facet improvements | Facet intervals and grouped facet queries | +| 1.8 | Extensibility improvements | Various - see [release notes](https://github.com/Alfresco/alfresco-content-app/releases) for details | +| 1.9 | Single Log Out | Users will be automatically logged out from the Content App after logging out from another application in the same browser session | +| 1.9 | Accessibility improvements | Various - see [release notes](https://github.com/Alfresco/alfresco-content-app/releases) for details | +| 1.10 | Create (file/folder) from template | Users can create files and folders structures from pre-set templates | For the full list of features please refer to the [Releases](https://github.com/Alfresco/alfresco-content-app/releases). diff --git a/docs/getting-started/README.md b/docs/getting-started/README.md index d588d907d..777b9fa5e 100644 --- a/docs/getting-started/README.md +++ b/docs/getting-started/README.md @@ -15,4 +15,3 @@ Learn how to start developing with the Alfresco Content Application. - [CORS](/getting-started/cors) - [Single Sign-On](/getting-started/sso) - [Navigation](/getting-started/navigation) -- [Docker](/getting-started/docker) diff --git a/docs/getting-started/building-from-source.md b/docs/getting-started/building-from-source.md index 3845ead66..33ec9ecea 100644 --- a/docs/getting-started/building-from-source.md +++ b/docs/getting-started/building-from-source.md @@ -8,8 +8,9 @@ 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 -- (optional) [Angular CLI](https://cli.angular.io/) 7.3.4 or later +- [Node.js](https://nodejs.org/en/) 14.x +- NPM 6.x +- (optional) [Angular CLI](https://cli.angular.io/) 14.x 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. @@ -29,26 +30,21 @@ The application runs at port `4200` by default, and should automatically open in ## Setting up environment variables -We need to set some environment variable to be able to run the local dev server. In the project root folder, create an `.env` file (this is gitignored) with the following data: +You need to set some environment variables to be able to run the local dev server. In the project root folder, create an `.env` file (this is gitignored) with the following data: -```bash +```yml # App config settings -APP_CONFIG_ECM_HOST="" -APP_CONFIG_OAUTH2_HOST="" -APP_CONFIG_PROVIDER="BPM" -APP_CONFIG_AUTH_TYPE="BASIC" -APP_CONFIG_OAUTH2_CLIENTID="clientid" -APP_CONFIG_OAUTH2_IMPLICIT_FLOW=true -APP_CONFIG_OAUTH2_SILENT_LOGIN=true -APP_CONFIG_OAUTH2_REDIRECT_SILENT_IFRAME_URI="{protocol}//{hostname}{:port}/assets/silent-refresh.html" -APP_CONFIG_OAUTH2_REDIRECT_LOGIN=/ -APP_CONFIG_OAUTH2_REDIRECT_LOGOUT=/ +APP_CONFIG_ECM_HOST="" +APP_CONFIG_PLUGIN_AOS=false +APP_CONFIG_PLUGIN_CONTENT_SERVICE=true +APP_CONFIG_PLUGIN_FOLDER_RULES=true +``` ## Proxy settings 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's `src` directory. By default, your settings coming from environment variables are preferenced. +You can find settings in the `proxy.conf.js` file in the project `src` directory. By default, settings coming from environment variables have higher priority. **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. diff --git a/docs/getting-started/docker.md b/docs/getting-started/docker.md deleted file mode 100644 index 6c816e279..000000000 --- a/docs/getting-started/docker.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -Title: Docker ---- - -# Docker - -ACA comes with the ACS 6.0 Community Edition preconfigured. - -The application runs in two modes: - -- Development (runs latest source code, requires building application) -- Preview (runs with latest published containers, master branch) - -## Development Mode - -Run the local instance of the application packaged into the docker image together with the ACS images: - -```sh -npm run build.release -npm run start:docker -``` - -The ACA runs on port `8080` when served from within container. - -Use the following command to stop all the containers: - -```sh -npm run stop:docker -``` - -You can also develop the application and run in default port (4200), -it is going to use the same docker containers automatically. diff --git a/docs/getting-started/prerequisites.md b/docs/getting-started/prerequisites.md index 96da8251c..f8ce70132 100644 --- a/docs/getting-started/prerequisites.md +++ b/docs/getting-started/prerequisites.md @@ -6,7 +6,7 @@ Title: Prerequisites This application uses the latest releases from Alfresco: -- [Alfresco ADF (3.3.0)](https://community.alfresco.com/community/application-development-framework/pages/get-started) +- [Alfresco ADF (5.0.0)](https://community.alfresco.com/community/application-development-framework/pages/get-started) - [Alfresco Content Services (6.1)](https://www.alfresco.com/platform/content-services-ecm) or [Alfresco Community Edition (6.1 - General Availability 201901)](https://www.alfresco.com/products/community/download) diff --git a/docs/toc.md b/docs/toc.md index 8517bb8ff..013afb6c6 100644 --- a/docs/toc.md +++ b/docs/toc.md @@ -15,9 +15,8 @@ - [Building from source](/getting-started/building-from-source) - [Internationalization (i18n)](/getting-started/internationalization) - [CORS](/getting-started/cors) - - [Configuration](/getting-started/configuration) + - [Configuration](/configuration/) - [Navigation](/getting-started/navigation) - - [Docker](/getting-started/docker) - [Extending](/extending/) - [Extensibility features](/extending/extensibility-features) - [Extension format](/extending/extension-format)