Skip to content

Commit

Permalink
MGR-95
Browse files Browse the repository at this point in the history
  • Loading branch information
madness-inc committed Feb 3, 2020
1 parent e190a68 commit d59d648
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 7 deletions.
12 changes: 7 additions & 5 deletions src/main/asciidoc/parts/site-properties.adoc
Expand Up @@ -30,6 +30,13 @@ A detailed list of the available properties can be found here:
|authLogoutActionValue|text|Backend|The value for the parameter defining the action on the `authLogoutPage`|`logout`
|authLogoutPage|text|Backend|The name of the logout-page within the application defined in `authApplication`|`webform`
|authLogoutRef|text|Backend|The reference-path for the logout-action|`webform/logout`
|cacheEnabled|boolean|Caching|Set to `true` to enable caching for this site.|`false`
|cacheExceptions|multiline text|Caching|URL path prefixes which are never cached. Contains one prefix per line (multiline value).|`/manager`
|cacheStatistics|boolean|Caching|Set to `true` to enable caching statistics|`false`
|cacheTimeToLive|int|Caching|The default TTL for a cache entry in seconds, if there's no matching path defined in `cacheTimeouts`.|`1800`
|cacheTimeouts|multiline text|Caching|The cache timeouts as a multiline property, key=value|
|cacheTimeoutsAntStyle|boolean|Caching|Use Ant-style path matching for `cacheTimeouts`?|`true`
|cacheClearOnShutdown|boolean|Caching|Whether or not the Ehcache is cleared on a site shutdown/reload|`true`
|csrfProtectionEnabled|boolean|Backend|Set to `true` to enable CSRF-protection for this site|`false`
|csrfProtectedMethods|text|Backend|a comma-separated list of HTTP-methods to enable CSRF protection for (see `csrfProtectionEnabled`)|`POST,PUT`
|csrfProtectedPaths|text|Backend|a comma-separated list of path-prefixes to enable CSRF protection for (see `csrfProtectionEnabled`)|`/manager`
Expand All @@ -38,11 +45,6 @@ A detailed list of the available properties can be found here:
|defaultPageSize|int|UI|The default page size (items per page)|`25`
|defaultApplication|text|Backend|The application to be called after a successful login|`appng-manager`
|documentDir|text|Content|A semicolon-separated list of folder-names (relative to `wwwDir`) containing JSP-files and static resources|`/de`
|ehcacheEnabled|boolean|Caching|Set to `true` to enable Ehcache for this site|`false`
|ehcacheExceptions|multilined text|Caching|URL path prefixes which are never cached. Contains one prefix per line.|`/manager`
|ehcacheBlockingTimeout|int|Caching|The time, in milliseconds, to wait for the filter before a `LockTimeoutException` is thrown|`10000`
|ehcacheStatistics|boolean|Caching|Set to `true` to enable Ehcache statistics|`false`
|ehcacheClearOnShutdown|boolean|Caching|Whether or not the Ehcache is cleared on a site shutdown/reload|`true`
|encoding|text|Content|The encoding for file-resources|`UTF-8`
|enforcePrimaryDomain|boolean|Backend|Set to `true` to enforce the protocol used by the site (http or https)|`false`
|errorPage|text|Content|The name of the default error-page (without extension) relative to `wwwDir`|`error`
Expand Down
4 changes: 2 additions & 2 deletions src/main/asciidoc/parts/sites.adoc
Expand Up @@ -62,7 +62,7 @@ In addition to the site attributes, there are a lot of site properties. With sit

As long as a property value has not been changed for a site, appNG uses the `Default-Value`. In this case both fields `Value` and `Multilined value` are empty.

To update a property, enter a value in either the `Value` or `Multilined value` field. Note that it is not possible to save the property if both fields are filled. appNG will use the content of the `Value` or the `Multilined value` field, if it is not empty. After updating a property, a site reload is required.
To update a property, enter a value in either the `Value` or `Multiline value` field. Note that it is not possible to save the property if both fields are filled. appNG will use the content of the `Value` or the `Multilined value` field, if it is not empty. After updating a property, a site reload is required.

A site property has the following attributes:

Expand All @@ -72,7 +72,7 @@ A site property has the following attributes:
| Name | The name of the property.
| Active Value | As described in <<Reloading a site>>, a property update will be only taken into account after a site reload. This attribute shows the value of the property after the next site reload.
| Default Value | The default value defined by the platform on site creation.
| Multilined Value | A _normal_ value has a limited length of 255 characters. If a bigger value is needed, it must be defined in the `Multilined Value` field of a property.
| Multiline Value | A _normal_ value has a limited length of 255 characters. If a bigger value is needed, it must be defined in the `Multilined Value` field of a property.
| Description | A short description of the property
| Changed Value | Is shown in the list of properties. Indicates if a value has been changed for that site (yellow) or if it still uses the platform default (green).
|====================
Expand Down

0 comments on commit d59d648

Please sign in to comment.