This commit is contained in:
2021-12-14 17:08:55 +00:00
parent 5e8e583018
commit 1d25c471dc
5 changed files with 48 additions and 9 deletions

View File

@@ -4,7 +4,7 @@ This optional setting sets the _full_ path to the Chromium web browser executabl
If not set, AyaNova will attempt to automatically download a copy of Chromium to a `.local-chromium` folder under the AyaNova executable folder on first report rendering.
This setting is typically only required for Linux Server operating systems.
This setting is typically not required to be set.
## Default
@@ -18,6 +18,15 @@ AyaNova expects the report rendering browser path to be provided by a config.jso
The value specified should be a string containing a fully qualified file path to the Chromium browser.
Example config.json entry
```json
{
...other properties...
"AYANOVA_REPORT_RENDER_BROWSER_PATH": "/usr/bin/chromium-browser"
}
```
Example command line parameter
`ayanova.exe --AYANOVA_REPORT_RENDER_BROWSER_PATH="/usr/bin/chromium-browser"` )

View File

@@ -38,6 +38,15 @@ AyaNova expects this value to be provided by a config.json property, environment
The value specified should be a string specifying the value as an integer, for example:
`5`
Example config.json entry
```json
{
...other properties...
"AYANOVA_REPORT_RENDERING_MAX_INSTANCES": "5"
}
```
Example command line parameter
`ayanova.exe --AYANOVA_REPORT_RENDERING_MAX_INSTANCES="5`

View File

@@ -6,16 +6,15 @@ This avoids a situation where a subsequent user can not get their report because
## Performance implications
Note that increasing report rendering settings too high can result in the server running out of physical memory or CPU capacity. When increasing the limits be mindful of this potential and monitor the server carefully to ensure it's not "bottlenecking". The reporting capacity scales directly with the amount of memory and CPU capacity available to the server.
Note that increasing report rendering settings too high can result in the server running out of physical memory or CPU capacity. When increasing the limits be mindful of this potential and monitor the server carefully to ensure it's not "bottlenecking". The reporting capacity scales directly with the amount of memory and CPU capacity available to the server.
## How timeouts work
When a report is requested to be rendered AyaNova starts the process and makes note of the time and will process that report indefinitely for as long as it takes to complete. However, if a subsequent report request is made and the first report has not completed yet then AyaNova will use this setting to wait for the first report to process before starting the next one. If the timeout period completes without the first report completed rendering then AyaNova will forcibly stop processing the first report and release the resources dedicated to it and start processing the new report.
When a report is requested to be rendered AyaNova starts the process and makes note of the time and will process that report indefinitely for as long as it takes to complete. However, if a subsequent report request is made and the first report has not completed yet then AyaNova will use this setting to wait for the first report to process before starting the next one. If the timeout period completes without the first report completed rendering then AyaNova will forcibly stop processing the first report and release the resources dedicated to it and start processing the new report.
It's important to note that this timeout does not prevent AyaNova from processing a report for any length of time necessary to complete it; this timeout only takes effect if another report is requested to be rendered so if a User has to render a very large report that is known to take longer than the timeout period they would be advised to render that report when no one else is requesting a report (i.e. after hours)
The value is specified in **milliseconds** or thousandths of a second. For example a 30 second timeout is 30000 milliseconds.
The value is specified in **milliseconds** or thousandths of a second. For example a 30 second timeout is 30000 milliseconds.
## Default
@@ -39,6 +38,15 @@ AyaNova expects this value to be provided by a config.json property, environment
The value specified should be a string specifying the timeout in **milliseconds**, for example:
`30000`
Example config.json entry
```json
{
...other properties...
"AYANOVA_REPORT_RENDERING_TIMEOUT": "45000"
}
```
Example command line parameter
`ayanova.exe --AYANOVA_REPORT_RENDERING_TIMEOUT="30000`
@@ -52,5 +60,3 @@ Windows
Linux / MAC
`export AYANOVA_REPORT_RENDERING_TIMEOUT="120000"`

View File

@@ -17,6 +17,14 @@ AyaNova expects the override password to be provided by a config.json property,
The value specified should be a string used to temporarily override the super user password e.g.:
`Th3RainInSpainFallsMainlyOnTh3Pla1n`
Example config.json entry
```json
{
...other properties...
"AYANOVA_REPORT_RENDERING_TIMEOUT": "Th3RainInSpainFallsMainlyOnTh3Pla1n"
}
```
Example command line parameter
@@ -31,5 +39,3 @@ Windows
Linux / MAC
`export AYANOVA_SET_SUPERUSER_PW="Th3RainInSpainFallsMainlyOnTh3Pla1n"`

View File

@@ -19,6 +19,15 @@ AyaNova expects the PORT and URL to be provided by a config.json property, envir
The value specified should be a string of one or more semicolon separated values, for example:
`http://*:5000;http://localhost:5001;https://hostname:5002`
Example config.json entry
```json
{
...other properties...
"AYANOVA_USE_URLS": "http://*:49152"
}
```
Example command line parameter
`ayanova.exe --AYANOVA_USE_URLS="http://*:5000"`