diff --git a/docs/8.0/ayanova/docs/img/ops-install-windows-run-notepad-as-administrator.png b/docs/8.0/ayanova/docs/img/ops-install-windows-run-notepad-as-administrator.png new file mode 100644 index 00000000..0a985565 Binary files /dev/null and b/docs/8.0/ayanova/docs/img/ops-install-windows-run-notepad-as-administrator.png differ 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 260f56c5..e711f308 100644 --- a/docs/8.0/ayanova/docs/ops-install-windows-lan.md +++ b/docs/8.0/ayanova/docs/ops-install-windows-lan.md @@ -83,15 +83,21 @@ Finish the installation. ![SCREENSHOT OF lan install setup finished](img/ops-install-windows-lan-finish.png) -#### Server configuration +Do **not** run any component yet, further configuration is needed. -The server **must** be configured before it will be able to start properly and find the database server. +### 4\. AyaNova Server configuration -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 server **must** be configured before it will be able to start properly and find the Postgres database 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. +Configuration is done by editing the `config.json` file that has been installed to the `c:\Program Files\ayanova\` folder. -For example, if editing the default config.json file: +Run NotePad as Administrator to be able to edit and save in the program files folder by right clicking on the Notepad icon in the start menu, select more and Run as administrator: + +![run notepad as administrator](img/ops-install-windows-run-notepad-as-administrator.png) + +From in Notepad, open the `config.json` file located in the location the AyaNova server had been installed to - default location is `c:\Program Files\ayanova\` + +The default installed `config.json` file will initially have the following: ```json { @@ -104,17 +110,27 @@ For example, if editing the default config.json file: } ``` -(Back slashes need to be **doubled** in config.json file or the server will fail to start) +Note that any 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. +Do **not** edit properties unless specifically indicated. If you encounter an issue, reconfirm your edits. + +DO **NOT** EDIT: 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 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, 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. + +EDIT NEEDED: + +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. + +EDIT ONLY IF NEEDED: + 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 EDIT: -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. +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. ```json { @@ -124,9 +140,17 @@ Optional but recommended: Add a 32 character [AYANOVA_JWT_SECRET](ops-config-jwt } ``` -#### Boot and test the server +After editing, saving and exiting out of NotePad, open the config.json file AGAIN to confirm that the changes were saved correctly and that the file is still specifically labeled with the name and extension config.json -The AyaNova installer creates two shortcuts in the Start Menu under "AyaNova Server" and also on the Windows desktop titled "AyaNova server" and "AyaNova App". The AyaNova Server shortcut will start a local copy of PostgreSQL, then AyaNova by running AyaNova.exe in the program files folder where AyaNova was installed. The AyaNova App shortcut will start a batch file which in turn will open the default browser to the AyaNova server's landing page at the default address. +### 5\. Boot and test the server + +The AyaNova installer will have created two shortcuts in the Start Menu under "AyaNova Server" + + +![SCREENSHOT OF lan desktop shortcuts](img/ops-install-windows-lan-desktopshortcuts.png) + + + and also on the Windows desktop titled "AyaNova server" and "AyaNova App". The AyaNova Server shortcut will start a local copy of PostgreSQL, then AyaNova by running AyaNova.exe in the program files folder where AyaNova was installed. The AyaNova App shortcut will start a batch file which in turn will open the default browser to the AyaNova server's landing page at the default address. Start the server by using the "AyaNova server" shortcut on the Windows desktop. You should see a console window open and some text that indicates the server version and that it is booting. Any problems found that prevent boot up will be displayed here. If all is well then the console window will display "BOOT: COMPLETED - SERVER OPEN" as well as some other configuration data.