case 4531

docs/8.0/ayanova/docs/changelog.md

@@ -20,6 +20,8 @@ Released 2023-XX-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
 
 - App: Work orders, Quotes and PM's added a new feature to the Customer Contact field to enable the user to select from any existing [Contact](customers.md#contacts-tab) entered for that Customer.
 
+- Docs: in several places added a [warning](ops-form-backup.md#failed-backup) about using special characters such as '@' or '$' in the PostgreSQL database name or password as it may interfere with the automatic backup process and cause it to fail.
+
 ### AyaNova 8.0.43
 
 Released 2023-05-10

docs/8.0/ayanova/docs/ops-config-db.md

@@ -41,6 +41,10 @@ Linux:
 
 If no default database is specified AyaNova will use the default value: "AyaNova".
 
+## Special characters could cause backup to fail
+
+Be careful about using special characters for your Postgres connection string, particularly the password and database name, we've encountered issues with the automatic internal backup failing due to a @ or $ symbol in the password. On some platforms when AyaNova attempts to run the backup utility it may fail if that operating system does not support certain special characters found in the password as they may interfere with the "shell" command called to perform the backup.
+
 ## Optional connection string parameters
 
 There are optional connection string parameters available for use with PostgreSQL to control many aspects of the PostgreSQL connection including timeouts, the type of security protocols used etc.

docs/8.0/ayanova/docs/ops-form-backup.md

@@ -72,6 +72,8 @@ Other indications of a failed backup are unsually small backup files or errors i
 
 The only **certain** way to know if a backup is good is to test restore it from time to time and we recommend doing so on a regularly scheduled basis to be certain the backup is good if you need it.
 
+**Warning**: Be careful about using special characters for your Postgres connection string, particularly the password and database name, we've encountered issues with the automatic internal backup failing due to a @ or $ symbol in the password. On some platforms when AyaNova attempts to run the backup utility it may fail if that operating system does not support certain special characters found in the password as they may interfere with the "shell" command called to perform the backup.
+
 ## Best practices for disaster recovery
 
 You should consider potential disaster scenarios appropriate to your region or the region where your AyaNova server is located. Ideally you want your backups to be stored in a location far enough away from your server to not be affected by the scope of a disaster that happens in your region but close enough at hand that you can access the backup in a timely manner to get back up and running again.

docs/8.0/ayanova/docs/ops-install-linux-desktop.md

@@ -73,6 +73,8 @@ ALTER USER postgres PASSWORD 'YOUR_PASSWORD_HERE';
 
 If successful psql will display "ALTER ROLE" in response and you can close the psql console by typing `\q` to quit.
 
+**Warning**: Be careful about using special characters for your Postgres connection string, particularly the password and database name, we've encountered issues with the automatic internal backup failing due to a @ or $ symbol in the password. On some platforms when AyaNova attempts to run the backup utility it may fail if that operating system does not support certain special characters found in the password as they may interfere with the "shell" command called to perform the backup.
+
 ### 4\. Create directorys for AyaNova
 
 AyaNova requires two directorys to be created, one to hold the AyaNova binary and other AyaNova server and web application files and one to hold the AyaNova data. AyaNova will need to write to both these locations so be sure you choose locations with appropriate permissions.

docs/8.0/ayanova/docs/ops-install-linux-server.md

@@ -106,6 +106,8 @@ ALTER USER postgres PASSWORD 'YOUR_PASSWORD_HERE';
 
 If successful psql will display "ALTER ROLE" in response and you can close the psql console by typing `\q` to quit.
 
+**Warning**: Be careful about using special characters for your Postgres connection string, particularly the password and database name, we've encountered issues with the automatic internal backup failing due to a @ or $ symbol in the password. On some platforms when AyaNova attempts to run the backup utility it may fail if that operating system does not support certain special characters found in the password as they may interfere with the "shell" command called to perform the backup.
+
 ### 5\. Install Chromium browser support libraries
 
 AyaNova uses a "headless" Chromium browser to render report templates. Server versions of Linux do not have the required support libraries for Chromium to render reports so they must be installed in advance.

docs/8.0/ayanova/docs/ops-install-windows-iis.md

@@ -101,6 +101,8 @@ If you need to install PostgreSQL follow this installation guide [https://www.po
 
 If you are installing PostgreSQL you will be prompted to provide a password to access it. Be sure to make a note of this password as AyaNova will need it to be specified later in the `AYANOVA_DB_CONNECTION` [configuration setting](ops-config-environment-variables.md) after installing the AyaNova server.
 
+**Warning**: Be careful about using special characters for your Postgres connection string, particularly the password and database name, we've encountered issues with the automatic internal backup failing due to a @ or $ symbol in the password. On some platforms when AyaNova attempts to run the backup utility it may fail if that operating system does not support certain special characters found in the password as they may interfere with the "shell" command called to perform the backup.
+
 ### 3\. ASP.NET Core Runtime
 
 IMPORTANT: IIS **MUST** be installed **before** the ASP.NET Core runtime. AyaNova will not work if IIS is installed after the ASP.NET Core runtime.

docs/8.0/ayanova/docs/ops-install-windows-lan.md

@@ -43,6 +43,8 @@ If you need to install PostgreSQL follow this installation guide [https://www.po
 
 If you are installing PostgreSQL you will be prompted to provide a password to access it. Be sure to make a note of this password as AyaNova will need it to be specified later in the `AYANOVA_DB_CONNECTION` [configuration setting](ops-config-environment-variables.md) after installing the AyaNova server.
 
+**Warning**: Be careful about using special characters for your Postgres connection string, particularly the password and database name, we've encountered issues with the automatic internal backup failing due to a @ or $ symbol in the password. On some platforms when AyaNova attempts to run the backup utility it may fail if that operating system does not support certain special characters found in the password as they may interfere with the "shell" command called to perform the backup.
+
 ### 2\. Install ASP.NET Core Runtime
 
 AyaNova is built upon the ASP.NET Core runtime version 6.x and it should be present **before** AyaNova is installed.
@@ -85,7 +87,6 @@ As more and more users install the new version, SmartScreen learns that the file
 
 SmartScreen does not support allowing software developers to request adding to a 'whitelist' when a new version of their software is published.
 
-
 Keep the checkmark on _Start AyaNova server when Windows starts_ and click on _next_.
 
 ![SCREENSHOT OF setup window checkmarked server start with windows](img/ops-install-windows-lan-startup.png)