diff --git a/.vscode/launch.json b/.vscode/launch.json index 7d4c3b62..18d9e3ab 100644 --- a/.vscode/launch.json +++ b/.vscode/launch.json @@ -51,7 +51,7 @@ "AYANOVA_SERVER_TEST_MODE": "false", "AYANOVA_REPORT_RENDERING_TIMEOUT":"1", "AYANOVA_SERVER_TEST_MODE_SEEDLEVEL": "small", - "AYANOVA_BACKUP_PG_DUMP_PATH": "C:\\data\\code\\postgres_14\\bin\\" + "AYANOVA_BACKUP_PG_DUMP_PATH": "C:data\\code\\postgres_14\\bin" }, "sourceFileMap": { "/Views": "${workspaceFolder}/Views" diff --git a/docs/8.0/ayanova/docs/ops-config-backup-pgdump-path.md b/docs/8.0/ayanova/docs/ops-config-backup-pgdump-path.md index f23719a3..648e6d0a 100644 --- a/docs/8.0/ayanova/docs/ops-config-backup-pgdump-path.md +++ b/docs/8.0/ayanova/docs/ops-config-backup-pgdump-path.md @@ -16,7 +16,7 @@ AyaNova expects the pg_dump utility path to be provided by a config.json propert The value specified should be a string containing a fully qualified file path to the pg_dump utility. -Example config.json entry +Example LINUX config.json entry ```json { @@ -25,6 +25,16 @@ Example config.json entry } ``` +Example WINDOWS config.json entry +(Back slashes need to be **doubled** in config.json file or the server will fail to start) + +```json +{ + ...other properties... + "AYANOVA_BACKUP_PG_DUMP_PATH": "c:\\Program files\\postgresql\\14.1\\bin" +} +``` + Example command line parameter `ayanova.exe --AYANOVA_BACKUP_PG_DUMP_PATH="/usr/lib/postgresql/14.1/bin/"` (not real) diff --git a/docs/8.0/ayanova/docs/ops-config-data-path.md b/docs/8.0/ayanova/docs/ops-config-data-path.md index 0d326163..71d72766 100644 --- a/docs/8.0/ayanova/docs/ops-config-data-path.md +++ b/docs/8.0/ayanova/docs/ops-config-data-path.md @@ -23,15 +23,24 @@ AyaNova expects the data path to be provided by a config.json property, environm `AYANOVA_DATA_PATH` -The value specified should be a string containing a fully qualified file path for the platform, for example: -`c:\ProgramData\ayanova` +The value specified should be a string containing a fully qualified file path for the platform. -Example config.json entry +Example LINUX config.json entry ```json { ...other properties... - "AYANOVA_DATA_PATH": "c:\ProgramData\ayanova" + "AYANOVA_DATA_PATH": "/var/lib/ayanova" +} +``` + +Example WINDOWS config.json entry +(Back slashes need to be **doubled** in config.json file or the server will fail to start) + +```json +{ + ...other properties... + "AYANOVA_DATA_PATH": "c:\\ProgramData\\ayanova" } ``` diff --git a/docs/8.0/ayanova/docs/ops-config-db.md b/docs/8.0/ayanova/docs/ops-config-db.md index 64d2d0c9..99f9803f 100644 --- a/docs/8.0/ayanova/docs/ops-config-db.md +++ b/docs/8.0/ayanova/docs/ops-config-db.md @@ -21,6 +21,8 @@ Example config.json entry } ``` +(Note: if any back slashes are in the db connection string they need to be **doubled** in config.json file or the server will fail to start) + Example command line parameter: `ayanova.exe --AYANOVA_DB_CONNECTION="Server=localhost;Database=MyAyaNovaDB;"` diff --git a/docs/8.0/ayanova/docs/ops-config-environment-variables.md b/docs/8.0/ayanova/docs/ops-config-environment-variables.md index f9fe158f..8e78d231 100644 --- a/docs/8.0/ayanova/docs/ops-config-environment-variables.md +++ b/docs/8.0/ayanova/docs/ops-config-environment-variables.md @@ -31,6 +31,14 @@ Here is an example config.json file contents, note that each property and value If you add a property to this file **be sure** to place a comma after the preceding item or the config.json file will be invalid. +### Backslashes in config.json + +JSON files require **double backslashes** to be valid. + +Windows paths in config.json must have double backslashes as in the example above. + +Linux uses the forward slash character for paths so this rule doesn't apply. + ## ENVIRONMENT VARIABLES Set the AyaNova environment variables in the manner appropriate for your operating system, either from the command line or as a host setting. For example: diff --git a/docs/8.0/ayanova/docs/ops-config-folder-backup-files.md b/docs/8.0/ayanova/docs/ops-config-folder-backup-files.md index f9bfecd9..261262f8 100644 --- a/docs/8.0/ayanova/docs/ops-config-folder-backup-files.md +++ b/docs/8.0/ayanova/docs/ops-config-folder-backup-files.md @@ -14,15 +14,24 @@ AyaNova expects the backup files folder path to be provided by a config.json pro `AYANOVA_BACKUP_FILES_PATH` -The value specified should be a string containing a fully qualified file path for the platform, for example: -`c:\ProgramData\ayanova\backupfiles` +The value specified should be a string containing a fully qualified file path for the platform. -Example config.json entry +Example LINUX config.json entry ```json { ...other properties... - "AYANOVA_BACKUP_FILES_PATH": "c:\ProgramData\ayanova\backupfiles" + "AYANOVA_BACKUP_FILES_PATH": "/var/lib/ayanova/backupfiles" +} +``` + +Example WINDOWS config.json entry +(Back slashes need to be **doubled** in config.json file or the server will fail to start) + +```json +{ + ...other properties... + "AYANOVA_BACKUP_FILES_PATH": "c:\\ProgramData\\backupfiles" } ``` diff --git a/docs/8.0/ayanova/docs/ops-config-folder-temporary-files.md b/docs/8.0/ayanova/docs/ops-config-folder-temporary-files.md index bf25394b..e30d4934 100644 --- a/docs/8.0/ayanova/docs/ops-config-folder-temporary-files.md +++ b/docs/8.0/ayanova/docs/ops-config-folder-temporary-files.md @@ -14,15 +14,24 @@ AyaNova expects the temporary files folder path to be provided by a config.json `AYANOVA_TEMP_FILES_PATH` -The value specified should be a string containing a fully qualified file path for the platform, for example: -`c:\ProgramData\ayanova\tempfiles` +The value specified should be a string containing a fully qualified file path for the platform. -Example config.json entry +Example LINUX config.json entry ```json { ...other properties... - "AYANOVA_TEMP_FILES_PATH": "c:\ProgramData\ayanova\tempfiles" + "AYANOVA_TEMP_FILES_PATH": "/var/lib/ayanova/tempfiles" +} +``` + +Example WINDOWS config.json entry +(Back slashes need to be **doubled** in config.json file or the server will fail to start) + +```json +{ + ...other properties... + "AYANOVA_TEMP_FILES_PATH": "c:\\ProgramData\\ayanova\\tempfiles" } ``` diff --git a/docs/8.0/ayanova/docs/ops-config-folder-user-files.md b/docs/8.0/ayanova/docs/ops-config-folder-user-files.md index d9c3c76a..4c188995 100644 --- a/docs/8.0/ayanova/docs/ops-config-folder-user-files.md +++ b/docs/8.0/ayanova/docs/ops-config-folder-user-files.md @@ -15,15 +15,24 @@ AyaNova expects the user files folder path to be provided by a config.json prope `AYANOVA_ATTACHMENT_FILES_PATH` -The value specified should be a string containing a fully qualified file path for the platform, for example: -`c:\ProgramData\ayanova\attachments` +The value specified should be a string containing a fully qualified file path for the platform. -Example config.json entry +Example LINUX config.json entry ```json { ...other properties... - "AYANOVA_ATTACHMENT_FILES_PATH": "c:\ProgramData\ayanova\attachments" + "AYANOVA_ATTACHMENT_FILES_PATH": "/var/lib/ayanova/attachments" +} +``` + +Example WINDOWS config.json entry +(Back slashes need to be **doubled** in config.json file or the server will fail to start) + +```json +{ + ...other properties... + "AYANOVA_ATTACHMENT_FILES_PATH": "c:\\ProgramData\\ayanova\\attachments" } ``` diff --git a/docs/8.0/ayanova/docs/ops-install-windows-iis.md b/docs/8.0/ayanova/docs/ops-install-windows-iis.md index bb79547a..fd3cc826 100644 --- a/docs/8.0/ayanova/docs/ops-install-windows-iis.md +++ b/docs/8.0/ayanova/docs/ops-install-windows-iis.md @@ -115,7 +115,11 @@ Download and run the AyaNova network installer: [https://www.ayanova.com/downloa The server **must** be configured before it will be able to start properly and find the database server. -The AyaNova installer will create a `config.json` file in it's program files folder. By default the location is `c:\Program Files\ayanova\config.json`. The config.json file is AyaNova's initial source for [configuration settings](ops-config-environment-variables.md) required for the server to start. It is necessary to edit this file (or provide an [alternative source of configuration](ops-config-environment-variables.md) and specify the password to connect to the PostgreSQL server. For example, if editing the default config.json file: +The AyaNova installer will create a `config.json` file in it's program files folder. By default the location is `c:\Program Files\ayanova\config.json`. + +The config.json file is AyaNova's initial source for [configuration settings](ops-config-environment-variables.md) required for the server to start. It is necessary to edit this file (or provide an [alternative source of configuration](ops-config-environment-variables.md) and specify the password to connect to the PostgreSQL server. + +For example, if editing the default config.json file: ```json { @@ -127,6 +131,7 @@ The AyaNova installer will create a `config.json` file in it's program files fol "AYANOVA_LOG_LEVEL": "Info" } ``` +(Back slashes need to be **doubled** in config.json file or the server will fail to start) The [AYANOVA_DB_CONNECTION](ops-config-db.md) property must be edited and where it has "YOUR_PASSWORD_HERE" substitute the actual PostgreSQL password to be used that was previously set. If the database server is located on a different computer then the `Server=` connection string property must be set to the address of that computer. diff --git a/docs/8.0/ayanova/docs/ops-install-windows-lan.md b/docs/8.0/ayanova/docs/ops-install-windows-lan.md index b6980c93..758dac85 100644 --- a/docs/8.0/ayanova/docs/ops-install-windows-lan.md +++ b/docs/8.0/ayanova/docs/ops-install-windows-lan.md @@ -51,7 +51,11 @@ Once you have ensured the two requirements above are installed and available; do The server **must** be configured before it will be able to start properly and find the database server. -The AyaNova installer will create a `config.json` file in it's program files folder. By default the location is `c:\Program Files\ayanova\config.json`. The config.json file is AyaNova's initial source for [configuration settings](ops-config-environment-variables.md) required for the server to start. It is necessary to edit this file (or provide an [alternative source of configuration](ops-config-environment-variables.md) and specify the password to connect to the PostgreSQL server. For example, if editing the default config.json file: +The AyaNova installer will create a `config.json` file in it's program files folder. By default the location is `c:\Program Files\ayanova\config.json`. + +The config.json file is AyaNova's initial source for [configuration settings](ops-config-environment-variables.md) required for the server to start. It is necessary to edit this file (or provide an [alternative source of configuration](ops-config-environment-variables.md) and specify the password to connect to the PostgreSQL server. + +For example, if editing the default config.json file: ```json { @@ -64,6 +68,8 @@ The AyaNova installer will create a `config.json` file in it's program files fol } ``` +(Back slashes need to be **doubled** in config.json file or the server will fail to start) + The [AYANOVA_DB_CONNECTION](ops-config-db.md) property must be edited and where it has "YOUR_PASSWORD_HERE" substitute the actual PostgreSQL password to be used that was previously set. If the database server is located on a different computer then the `Server=` connection string property must be set to the address of that computer. The [AYANOVA_USE_URLS](ops-config-use-urls.md) property specifies which TCP / IP Port that AyaNova server should listen on for connections from web browsers. The default value is port 7575 which should be free in most cases, however if you need to use an alternate port due to conflict it must be set here. We recommend using the default 7575 to avoid current or future confusion or conflict with other servers that may be installed or present elsewhere on the network.