This commit is contained in:
2022-02-15 23:57:48 +00:00
parent 9c07e7e314
commit ca6a3de19a
5 changed files with 16 additions and 10 deletions

View File

@@ -3,6 +3,7 @@
"AYANOVA_DB_CONNECTION":"Server=localhost;Username=postgres;Password=YOUR_PASSWORD_HERE;Database=AyaNova;",
"AYANOVA_DEFAULT_TRANSLATION":"en",
"AYANOVA_DATA_PATH":"%ProgramData%\\ayanova",
"AYANOVA_BACKUP_PG_DUMP_PATH": "C:\\Program Files\\PostgreSQL\\14\\bin",
"AYANOVA_LOG_LEVEL": "Info"
}

View File

@@ -1,10 +1,10 @@
# Backup utility "pg_dump" path setting
This setting controls where AyaNova will find the PostgreSQL pg_dump utility used forautomated backups.
This setting controls where AyaNova will find the PostgreSQL pg_dump utility used for [automated backups](ops-form-backup.md).
## Default
Default is empty.
Default varies with installer platform but empty is valid if pg_dump utility is in the PATH.
If no override is specified AyaNova will assume the utility is on the environment PATH.
@@ -31,7 +31,7 @@ Example WINDOWS config.json entry
```json
{
...other properties...
"AYANOVA_BACKUP_PG_DUMP_PATH": "c:\\Program files\\postgresql\\14.1\\bin"
"AYANOVA_BACKUP_PG_DUMP_PATH": "C:\\Program Files\\PostgreSQL\\14\\bin"
}
```
@@ -43,7 +43,7 @@ Example environment variable
Windows
`set "AYANOVA_BACKUP_PG_DUMP_PATH=c:\Program files\postgresql\14.1\bin"` (not real)
`set "AYANOVA_BACKUP_PG_DUMP_PATH=C:\Program Files\PostgreSQL\14\bin"` (not real)
Linux / MAC

View File

@@ -48,7 +48,7 @@ The most important step to detecting failed backups is to ensure several users a
Aside from the notification, the backup form itself shows useful information to detect the state of the backup:
A backup file is almost always generated; even in the case of a total failure to backup a zero byte file will be generated. AyaNova can not always detect if a backup failed but if it's zero bytes that is a certain indication and that backup will display as red in it's row in the backup files table.
A backup file is almost always generated; even in the case of a total failure to backup a zero byte file will be generated. AyaNova can not always detect if a backup failed but if it's zero bytes that is a certain indication and that backup will display as red in it's row in the backup files table as you can see in the image above.
Other indications of a failed backup are unsually small backup files or errors in the [server log](ops-log.md).

View File

@@ -115,9 +115,9 @@ 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 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.
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:
@@ -126,17 +126,20 @@ For example, if editing the default config.json file:
"AYANOVA_USE_URLS": "http://*:7575",
"AYANOVA_DB_CONNECTION": "Server=localhost;Username=postgres;Password=YOUR_PASSWORD_HERE;Database=AyaNova;",
"AYANOVA_DEFAULT_TRANSLATION": "en",
"AYANOVA_BACKUP_PG_DUMP_PATH": "postgres\\bin\\",
"AYANOVA_BACKUP_PG_DUMP_PATH": "C:\\Program Files\\PostgreSQL\\14\\bin",
"AYANOVA_DATA_PATH": "%ProgramData%\\ayanova",
"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.
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.
The [AYANOVA_BACKUP_PG_DUMP_PATH](ops-config-backup-pgdump-path.md) property specifies the path to the PostgreSQL database backup utility `pg_dump` if AyaNova server will be doing the [automatic daily backups](ops-form-backup.md). If this utility is already in the path then you can remove this configuration setting entirely, otherwise it should be set to the location for your installed version of PostgreSQL's bin folder or wherever `pg_dump` is located. If you already have a backup solution in place for your PostgreSQL databases then there is no need to use this setting.
Strongly recommended: Add a 32 character [AYANOVA_JWT_SECRET](ops-config-jwt-secret.md) property to the configuration if you want to ensure that logged in User's session can survive a restart of the AyaNova server. If this is not set AyaNova will invalidate all login tokens any time the server restarts by generating a new random JWT secret on boot and under IIS AyaNova _will_ restart every day so this is really a mandatory setting if you want to preserve user logins over a 24 hour period.
Do _not_ use the value shown here, make sure you change it to any other random 32 characters for security purposes.

View File

@@ -51,7 +51,7 @@ 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 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.
@@ -62,7 +62,7 @@ For example, if editing the default config.json file:
"AYANOVA_USE_URLS": "http://*:7575",
"AYANOVA_DB_CONNECTION": "Server=localhost;Username=postgres;Password=YOUR_PASSWORD_HERE;Database=AyaNova;",
"AYANOVA_DEFAULT_TRANSLATION": "en",
"AYANOVA_BACKUP_PG_DUMP_PATH": "postgres\\bin\\",
"AYANOVA_BACKUP_PG_DUMP_PATH": "C:\\Program Files\\PostgreSQL\\14\\bin",
"AYANOVA_DATA_PATH": "%ProgramData%\\ayanova",
"AYANOVA_LOG_LEVEL": "Info"
}
@@ -74,6 +74,8 @@ The [AYANOVA_DB_CONNECTION](ops-config-db.md) property must be edited and where
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.
The [AYANOVA_BACKUP_PG_DUMP_PATH](ops-config-backup-pgdump-path.md) property specifies the path to the PostgreSQL database backup utility `pg_dump` if AyaNova server will be doing the [automatic daily backups](ops-form-backup.md). If this utility is already in the path then you can remove this configuration setting entirely, otherwise it should be set to the location for your installed version of PostgreSQL's bin folder or wherever `pg_dump` is located. If you already have a backup solution in place for your PostgreSQL databases then there is no need to use this setting.
The USE URLS setting affects the address users will use to connect to the AyaNova server in their web browser. For example, to access the AyaNova server from the same computer the server is running on with the default port 7575 you would use this link in your browser [http://localhost:7575](http://localhost:7575), however from _another_ computer on the network you would access the server via it's IP address, so, for example if the AyaNova Server computer's IP Address on your network was 192.168.1.10 users on another computer might connect via this address [http://192.168.1.10:7575](http://192.168.1.10:7575).
Optional but recommended: Add a 32 character [AYANOVA_JWT_SECRET](ops-config-jwt-secret.md) property to the configuration if you want to ensure that logged in User's session can survive a restart of the AyaNova server. If this is not set AyaNova will invalidate all login tokens any time the server restarts by generating a new random JWT secret on boot.