This commit is contained in:
2021-11-29 21:00:23 +00:00
parent b83c1faf89
commit 086a03a0cb
19 changed files with 161 additions and 146 deletions

View File

@@ -21,7 +21,7 @@ Sometimes 3rd party tools may log to the log file and we may need to restrict th
## Log path
By default AyaNova logs to a "logs" folder situated below the folder where AyaNova is started.
By default AyaNova logs to a `logs` folder in the location specified by [AYANOVA_DATA_PATH](ops-config-data-path.md) setting.
You can override this and set a custom log location by command line argument or by setting the "AYANOVA_LOG_PATH" environment variable.
Example command line log path parameter

View File

@@ -18,7 +18,7 @@ The value specified should be a string containing a fully qualified file path to
Example command line parameter
`dotnet run --AYANOVA_BACKUP_PG_DUMP_PATH="/usr/lib/postgresql/14.1/bin/"` (not real)
`ayanova.exe --AYANOVA_BACKUP_PG_DUMP_PATH="/usr/lib/postgresql/14.1/bin/"` (not real)
Example environment variable

View File

@@ -0,0 +1,44 @@
# DATA PATH SETTING
This setting controls where AyaNova stores it's data by default and is required to be present unless all other path related configuration settings are specified individually.
All data path configurations default to a location under the location specified by AYANOVA_DATA_PATH as follows:
- AYANOVA_BACKUP_FILES_PATH defaults to 'backup' folder inside AYANOVA_DATA_PATH
- AYANOVA_ATTACHMENT_FILES_PATH defaults to 'attachments' folder inside AYANOVA_DATA_PATH
- AYANOVA_TEMP_FILES_PATH defaults to 'temp' folder inside AYANOVA_DATA_PATH
- AYANOVA_LOG_PATH defaults to 'logs' folder inside AYANOVA_DATA_PATH
## Override individual locations
Each of the path related configuration settings can also be specified individually, any that are left out will default to the above settings.
## Default
On Windows computers that use the installer, the default location for this setting is set by the installer the 'ProgramData' folder. There is no default for other operating systems or manual installations.
## Overriding
AyaNova expects the data path to be provided by an environment variable or command line parameter named
`AYANOVA_DATA_PATH`
The value specified should be a string containing a fully qualified file path for the platform, for example:
`c:\ProgramData\ayanova`
Example command line parameter
`ayanova.exe --AYANOVA_DATA_PATH="/var/lib/ayanova"`
Example environment variable
Windows
`set "AYANOVA_DATA_PATH=c:\ProgramData\ayanova"`
Linux / MAC
`export AYANOVA_DATA_PATH="/var/lib/ayanova"`
If both a command line parameter and an environment variable are set the command line parameter takes precedence.

View File

@@ -14,7 +14,7 @@ AyaNova expects the connection string to be provided by an environment variable
Example command line parameter:
`dotnet run --AYANOVA_DB_CONNECTION="Server=localhost;Database=MyAyaNovaDB;"`
`ayanova.exe --AYANOVA_DB_CONNECTION="Server=localhost;Database=MyAyaNovaDB;"`
Example environment variable:

View File

@@ -41,7 +41,7 @@ or
Example command line parameter
`dotnet run --AYANOVA_DEFAULT_TRANSLATION="ES"`
`ayanova.exe --AYANOVA_DEFAULT_TRANSLATION="ES"`
Example environment variable

View File

@@ -10,9 +10,10 @@ These values can all be specified as an environment variable or as a command lin
## FILE STORAGE LOCATIONS
- [AYANOVA_FOLDER_BACKUP_FILES](ops-config-folder-backup-files.md)
- [AYANOVA_FOLDER_USER_FILES](ops-config-folder-user-files.md)
- [AYANOVA_FOLDER_TEMPORARY_SERVER_FILES](ops-config-folder-temporary-files.md)
- [AYANOVA_DATA_PATH](ops-config-data-path.md)
- [AYANOVA_BACKUP_FILES_PATH](ops-config-folder-backup-files.md)
- [AYANOVA_ATTACHMENT_FILES_PATH](ops-config-folder-user-files.md)
- [AYANOVA_TEMP_FILES_PATH](ops-config-folder-temporary-files.md)
## BACKUP UTILITY "pg_dump" PATH
- [AYANOVA_BACKUP_PG_DUMP_PATH](ops-config-backup-pgdump-path.md)

View File

@@ -2,33 +2,33 @@
This setting controls where AyaNova stores backup and restore files used by the backup and restore features built into AyaNova.
Warning: this folder MUST NOT be the same location set for [AYANOVA_FOLDER_USER_FILES](ops-config-folder-user-files.md) or [AYANOVA_FOLDER_TEMPORARY_SERVER_FILES](ops-config-folder-temporary-files.md) or AyaNova will not start.
Warning: this folder MUST NOT be the same location set for [AYANOVA_ATTACHMENT_FILES_PATH](ops-config-folder-user-files.md) or [AYANOVA_TEMP_FILES_PATH](ops-config-folder-temporary-files.md) or AyaNova will not start.
## Default
If no override is specified AyaNova will store backup files in a `backupfiles` folder in the AyaNova root folder where AyaNova is started from.
If no override is specified AyaNova will store backup files in a `backup` folder in the location specified by [AYANOVA_DATA_PATH](ops-config-data-path.md) setting.
## Overriding
AyaNova expects the backup files folder path to be provided by an environment variable or command line parameter named
`AYANOVA_FOLDER_BACKUP_FILES`
`AYANOVA_BACKUP_FILES_PATH`
The value specified should be a string containing a fully qualified file path for the platform, for example:
`c:\data\ayanova\backupfiles`
Example command line parameter
`dotnet run --AYANOVA_FOLDER_BACKUP_FILES="/var/lib/ayanova/backupfiles"`
`ayanova.exe --AYANOVA_BACKUP_FILES_PATH="/var/lib/ayanova/backupfiles"`
Example environment variable
Windows
`set "AYANOVA_FOLDER_BACKUP_FILES=c:\data\ayanova\backupfiles"`
`set "AYANOVA_BACKUP_FILES_PATH=c:\data\ayanova\backupfiles"`
Linux / MAC
`export AYANOVA_FOLDER_BACKUP_FILES="/var/lib/ayanova/backupfiles"`
`export AYANOVA_BACKUP_FILES_PATH="/var/lib/ayanova/backupfiles"`
If both a command line parameter and an environment variable are set the command line parameter takes precedence.

View File

@@ -2,33 +2,33 @@
This setting controls where AyaNova stores files temporarily while servicing requests such as report generation etc.
Warning: this folder MUST NOT be the same location set for [AYANOVA_FOLDER_USER_FILES](ops-config-folder-user-files.md) or [AYANOVA_FOLDER_BACKUP_FILES](ops-config-folder-backup-files.md) or AyaNova will not start.
Warning: this folder MUST NOT be the same location set for [AYANOVA_ATTACHMENT_FILES_PATH](ops-config-folder-user-files.md) or [AYANOVA_BACKUP_FILES_PATH](ops-config-folder-backup-files.md) or AyaNova will not start.
## Default
If no override is specified AyaNova will store temporary files in a `tempfiles` folder in the AyaNova root folder where AyaNova is started from.
If no override is specified AyaNova will store temporary files in a `tempfiles` folder in the location specified by [AYANOVA_DATA_PATH](ops-config-data-path.md) setting.
## Overriding
AyaNova expects the temporary files folder path to be provided by an environment variable or command line parameter named
`AYANOVA_FOLDER_TEMPORARY_SERVER_FILES`
`AYANOVA_TEMP_FILES_PATH`
The value specified should be a string containing a fully qualified file path for the platform, for example:
`c:\data\ayanova\tempfiles`
Example command line parameter
`dotnet run --AYANOVA_FOLDER_TEMPORARY_SERVER_FILES="/var/lib/ayanova/tempfiles"`
`ayanova.exe --AYANOVA_TEMP_FILES_PATH="/var/lib/ayanova/tempfiles"`
Example environment variable
Windows
`set "AYANOVA_FOLDER_TEMPORARY_SERVER_FILES=c:\data\ayanova\tempfiles"`
`set "AYANOVA_TEMP_FILES_PATH=c:\data\ayanova\tempfiles"`
Linux / MAC
`export AYANOVA_FOLDER_TEMPORARY_SERVER_FILES="/var/lib/ayanova/tempfiles"`
`export AYANOVA_TEMP_FILES_PATH="/var/lib/ayanova/tempfiles"`
If both a command line parameter and an environment variable are set the command line parameter takes precedence.

View File

@@ -3,33 +3,33 @@
This setting controls where AyaNova stores user uploaded files used by features that allow file attachment or uploads.
AyaNova stores these files with random names in the folder specified.
Warning: this folder MUST NOT be the same location set for [AYANOVA_FOLDER_BACKUP_FILES](ops-config-folder-backup-files.md) or [AYANOVA_FOLDER_TEMPORARY_SERVER_FILES](ops-config-folder-temporary-files.md) or AyaNova will not start.
Warning: this folder MUST NOT be the same location set for [AYANOVA_BACKUP_FILES_PATH](ops-config-folder-backup-files.md) or [AYANOVA_TEMP_FILES_PATH](ops-config-folder-temporary-files.md) or AyaNova will not start.
## Default
If no override is specified AyaNova will store user files in a `userfiles` folder in the AyaNova root folder where AyaNova is started from.
If no override is specified AyaNova will store user files in a `userfiles` folder in the location specified by [AYANOVA_DATA_PATH](ops-config-data-path.md) setting.
## Overriding
AyaNova expects the user files folder path to be provided by an environment variable or command line parameter named
`AYANOVA_FOLDER_USER_FILES`
`AYANOVA_ATTACHMENT_FILES_PATH`
The value specified should be a string containing a fully qualified file path for the platform, for example:
`c:\data\ayanova\userfiles`
Example command line parameter
`dotnet run --AYANOVA_FOLDER_USER_FILES="/var/lib/ayanova/userfiles"`
`ayanova.exe --AYANOVA_ATTACHMENT_FILES_PATH="/var/lib/ayanova/userfiles"`
Example environment variable
Windows
`set "AYANOVA_FOLDER_USER_FILES=c:\data\ayanova\userfiles"`
`set "AYANOVA_ATTACHMENT_FILES_PATH=c:\data\ayanova\userfiles"`
Linux / MAC
`export AYANOVA_FOLDER_USER_FILES="/var/lib/ayanova/userfiles"`
`export AYANOVA_ATTACHMENT_FILES_PATH="/var/lib/ayanova/userfiles"`
If both a command line parameter and an environment variable are set the command line parameter takes precedence.

View File

@@ -31,7 +31,7 @@ You should use the same precautions as for choosing any other password and ensur
Example command line parameter
`dotnet run --AYANOVA_JWT_SECRET="02847This_is_my_secret_key456576"`
`ayanova.exe --AYANOVA_JWT_SECRET="02847This_is_my_secret_key456576"`
Example environment variable

View File

@@ -40,7 +40,7 @@ The value specified should be a string specifying the value as an integer, for e
Example command line parameter
`dotnet run --AYANOVA_REPORT_RENDERING_MAX_INSTANCES="5`
`ayanova.exe --AYANOVA_REPORT_RENDERING_MAX_INSTANCES="5`
Example environment variable

View File

@@ -41,7 +41,7 @@ The value specified should be a string specifying the timeout in **milliseconds*
Example command line parameter
`dotnet run --AYANOVA_REPORT_RENDERING_TIMEOUT="30000`
`ayanova.exe --AYANOVA_REPORT_RENDERING_TIMEOUT="30000`
Example environment variable

View File

@@ -20,7 +20,7 @@ The value specified should be a string used to temporarily override the super us
Example command line parameter
`dotnet run --AYANOVA_SET_SUPERUSER_PW="Th3RainInSpainFallsMainlyOnTh3Pla1n"`
`ayanova.exe --AYANOVA_SET_SUPERUSER_PW="Th3RainInSpainFallsMainlyOnTh3Pla1n"`
Example environment variable

View File

@@ -21,7 +21,7 @@ The value specified should be a string of one or more semicolon separated values
Example command line parameter
`dotnet run --AYANOVA_USE_URLS="http://*:5000"`
`ayanova.exe --AYANOVA_USE_URLS="http://*:5000"`
Example environment variable