documentation fixes (#2730)

This commit is contained in:
Denys Vuika
2022-10-19 13:18:47 +01:00
committed by GitHub
parent 1e8ad373bb
commit 2fba46c690
6 changed files with 45 additions and 79 deletions

View File

@@ -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)

View File

@@ -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="<url>"
APP_CONFIG_OAUTH2_HOST="<url>"
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="<URL>"
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.

View File

@@ -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.

View File

@@ -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)