alfresco-content-app/docs/configuration.md
Denys Vuika ebc3111824
Sync with latest development (#139)
* Update index.html

* Update features.md

* Update header.md

* Update header.md

* Update header.md

* Add files via upload

* Update header.md

* Update header.md

* Add files via upload

* Update header.md

* Add files via upload

* Add files via upload

* Update header.md

* Add files via upload

* Delete sid-nav.png

* Add files via upload

* Update side-nav.md

* Add files via upload

* Update side-nav.md

* Update side-nav.md

* Update doc-list.md

* Add files via upload

* Update doc-list.md

* Update doc-list.md

* Delete doclist.png

* Add files via upload

* small changes to docs

* [ACA-1038] 'Load more' doesn't work correctly on destination picker (#135)

made sure that a search is performed only if there is a search string to search for

* [ACA-951] Color theme and logo (#138)

- documented customization of the logo and header background color
2017-12-13 17:39:14 +00:00

4.0 KiB

Application Configuration

The Content Application provides support for a global settings file app.config.json that you can use to customize the behavior of ACA and ADF components.

Server settings

Once the Content Application starts, it needs to know where the Alfresco Content Services (either Community or Enterprise) server is. The "ecmHost" property allows you to set the address of the server using the dynamic or static format.

Dynamic address

The example below demonstrates the most common dynamic format for development environment:

{
    "ecmHost": "http://{hostname}{:port}",
    ...
}

The configuration above assumes you are running ACS and Content App on the same server and port and allows deploying to different servers having the same unified configuration file.

For example, a proxy server at localhost:3000 hosting the Content App as the root application, and localhost:3000/alfresco for the ACS repository.

At runtime, the application is going to automatically substitute the "{hostname}" value with the original hostname. Optionally it can also use the value of the original port if present, for example, "3000" at local machines, or skip the value for port 80.

Static address

Alternatively, you can provide a static address for the ACS server if necessary:

{
    "ecmHost": "http://localhost:3000",
    ...
}

Application settings

There are many settings you can change to alter the default behavior of the application.

Application Name

The following block allows you to change the name of the application.

{
    ...,
    "application": {
        "name": "Alfresco Example Content Application"
    }
}

The value of the application.name key gets appended to every browser tab title at runtime with the format [page title] - [application name], for example: "Personal Files - Alfresco Example Content Application".

The default logo displayed in the top left corner of the Alfresco Content Application can be changed with the one you want:

  1. Place the custom logo image file in the [app-name]/src/assets/images folder. The displayed image will be resized to fit the design, but please be aware that an image with extreme width/height might not look good after resizing.

  2. In the app.config.json file, set the value of the application.logo to contain the name of the custom logo image: "logo": "/assets/images/[image-name].[extension]"

{
    ...,
    "application": {
        "logo": "/assets/images/alfresco-logo-white.svg"
    }
}

Header Background color

You can change the header background color by specifying the wanted color code for the "headerColor" key:

{
    ...,
    "headerColor": "#2196F3"
}

Restricted content

You can restrict users from uploading certain types of files and folders by setting or extending the list of rules at the "files.excluded" path.

By default, the application ships with the following rules already predefined:

{
    ...,
    "files": {
        "excluded": [
            ".DS_Store",
            "desktop.ini",
            "thumbs.db",
            ".git"
        ]
    },
    ...
}

You can get more details on the supported rules in the following article: [Upload Service](https://github.com/Alfresco/alfresco-ng2-components/blob/master/docs/upload.service.md).

Pagination settings

You can change the default settings of the pagination that gets applied to all the document lists in the application.

{
    ...,
    "document-list": {
        "supportedPageSizes": [
            25,
            50,
            100
        ]
    },
    ...
}

Your custom settings

You can store any information in the application configuration file, and access it at runtime by using the AppConfigService service provided by ADF.

Please refer to the [AppConfigService](https://github.com/Alfresco/alfresco-ng2-components/blob/master/docs/app-config.service.md) documentation to get more details on Application Configuration features and API available.