docs/8.0/ayanova/docs/ops-config-data-path.md

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