This commit is contained in:
@@ -43,7 +43,7 @@ If a networking technician has a question about AyaNova itself that is not answe
|
||||
|
||||
Follow the steps below **in the order** they are presented here.
|
||||
|
||||
### Enable IIS Internet Information Server
|
||||
### 1\. Enable IIS Internet Information Server
|
||||
|
||||
If you already have IIS enabled read through and verify the following instructions to verify it is ready for AyaNova.
|
||||
|
||||
@@ -89,37 +89,81 @@ If IIS is being enabled for the first time you can accept the defaults. If IIS w
|
||||
|
||||
Select the OK button and Windows will enable IIS. Reboot is not required at this point, continue on to the PostgreSQL installation below.
|
||||
|
||||
### PostgreSQL server
|
||||
### 2\. Install PostgreSQL server
|
||||
|
||||
AyaNova requires access to a PostgreSQL database server version 12 or newer. It should be up and running **before** AyaNova is installed. If you do not have a PostgreSQL server already then it must be installed to a location visible to the AyaNova server (same computer or a local computer on the same network). PostgreSQL is open source and free to use, if you need to install PostgreSQL follow this installation guide [https://www.postgresqltutorial.com/install-postgresql/](https://www.postgresqltutorial.com/install-postgresql/)
|
||||
AyaNova requires access to a PostgreSQL database server version 12 or newer. It should be up and running **before** AyaNova is installed. If you do not have a PostgreSQL server already then it must be installed to a location visible to the AyaNova server (same computer or a local computer on the same network). PostgreSQL is open source and free to use.
|
||||
|
||||
#### Password
|
||||
If you need to install PostgreSQL follow this installation guide [https://www.postgresqltutorial.com/install-postgresql/](https://www.postgresqltutorial.com/install-postgresql/)
|
||||
|
||||
#### PostgreSQL server password
|
||||
|
||||
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.
|
||||
|
||||
### ASP.NET Core Runtime
|
||||
### 3\. ASP.NET Core Runtime
|
||||
|
||||
IIS **MUST** be installed **before** the ASP.NET Core runtime. AyaNova will not work if IIS is installed after the 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.
|
||||
|
||||
If IIS is not already enabled and running do not proceed until it is.
|
||||
|
||||
The ASP.NET Core runtime will see IIS and install appropriate components but only if IIS is present during the ASP.NET Core runtime installation.
|
||||
|
||||
AyaNova is built upon the ASP.NET Core runtime version 6.0 or newer and it should be present **before** AyaNova is installed. Download the runtime here [https://dotnet.microsoft.com/permalink/dotnetcore-current-windows-runtime-bundle-installer](https://dotnet.microsoft.com/permalink/dotnetcore-current-windows-runtime-bundle-installer).
|
||||
AyaNova is built upon the ASP.NET Core runtime version 6.0 or newer and it should be present **before** AyaNova is installed.
|
||||
|
||||
### AyaNova server installation
|
||||
Download the runtime here [https://dotnet.microsoft.com/permalink/dotnetcore-current-windows-runtime-bundle-installer](https://dotnet.microsoft.com/permalink/dotnetcore-current-windows-runtime-bundle-installer).
|
||||
|
||||
Download and run the AyaNova network installer: [https://www.ayanova.com/download/ayanova-windows-x64-lan-setup.exe](https://www.ayanova.com/download/ayanova-windows-x64-lan-setup.exe). Follow the prompts to complete installation but **DO NOT** select to start AyaNova with Windows, IIS will be responsible for starting and stopping AyaNova. If you do select start with windows re-run the installer and uncheck it.
|
||||
Confirm your ASP.NET Core runtime is installed and running by opening a DOS command window and typing
|
||||
|
||||
#### Server configuration
|
||||
```dos
|
||||
dotnet --list-runtimes
|
||||
```
|
||||
|
||||
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`.
|
||||
(your version may be newer)
|
||||
|
||||
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.
|
||||
### 4\. AyaNova server installation
|
||||
|
||||
For example, if editing the default config.json file:
|
||||
Once you have ensured the two requirements above are installed and available, download and run the AyaNova network installer: [https://www.ayanova.com/download/ayanova-windows-x64-lan-setup.exe](https://www.ayanova.com/download/ayanova-windows-x64-lan-setup.exe).
|
||||
|
||||
**IMPORTANT**: You MUST UNCHECK the option 'Start AyaNova server when Windows starts'
|
||||
|
||||
|
||||
|
||||
This is because IIS will be responsible for starting and stopping AyaNova. If you do select start with windows re-run the installer and uncheck it and finish the installation again.
|
||||
|
||||
Click next to continue to the next step:
|
||||
|
||||
You will be prompted to go to the asp.net core download page:
|
||||
|
||||
|
||||
|
||||
If you have already downloaded and installed ASP.NET Core Runtime, select No. Otherwise select Yes, and complete that installation before proceeding.
|
||||
|
||||
You will next be prompted to go the PostgreSQL installer page:
|
||||
|
||||
|
||||
|
||||
If you have already downloaded and installed PostgresSQL database server, select No. Otherwise select Yes, and complete that installation before proceeding.
|
||||
|
||||
Finish the installation.
|
||||
|
||||
|
||||
|
||||
Do **not** run any component yet, further configuration is needed.
|
||||
|
||||
### 5\. AyaNova Server configuration
|
||||
|
||||
The AyaNova server **must** be configured before it will be able to start properly and find the Postgres database server.
|
||||
|
||||
Configuration is done by editing the `config.json` file that has been installed to the `c:\Program Files\ayanova\` folder.
|
||||
|
||||
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:
|
||||
|
||||
|
||||
|
||||
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
|
||||
{
|
||||
@@ -132,17 +176,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.
|
||||
|
||||
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.
|
||||
OPTIONAL EDIT:
|
||||
|
||||
Do _not_ use the value shown here, make sure you change it to any other random 32 characters for security purposes.
|
||||
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
|
||||
{
|
||||
@@ -152,35 +206,59 @@ Do _not_ use the value shown here, make sure you change it to any other random 3
|
||||
}
|
||||
```
|
||||
|
||||
#### 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
|
||||
|
||||
AyaNova must be confirmed to run properly _before_ the final configuration in IIS to host AyaNova.
|
||||
### 6\. Boot and test the server
|
||||
|
||||
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 AyaNova by running AyaNova.exe in the program files folder where AyaNova was installed and 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.
|
||||
AyaNova must be confirmed to run properly BEFORE the final configuration in IIS to host AyaNova. Do so by following this boot and test.
|
||||
|
||||
Note that the AyaNova App shortcut is only relevant to this initial configuration testing, once AyaNova is confirmed to be working via IIS you will no longer access it directly but through IIS instead so the AyaNova App shortcut and address it uses will no longer be required and should not be used execept for diagnostic purposes only.
|
||||
The AyaNova installer will have created two shortcuts in the Start Menu under "AyaNova Server"
|
||||
|
||||
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.
|
||||
|
||||
|
||||
If there is an issue it will be reported in this console window.
|
||||
The AyaNova installer also creates two shortcuts on the Windows desktop titled "AyaNova server" and "AyaNova App".
|
||||
|
||||
|
||||
|
||||
|
||||
Use the AyaNova App shortcut to open the server and get started with AyaNova.
|
||||
#### 6\.1 Double click the AyaNova Server shortcut
|
||||
|
||||
#### If the server closes immediately upon running with an error
|
||||
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
##### If the server closes immediately upon running with an error
|
||||
|
||||
In some cases where a critical configuration value is completely missing, the server console may display the error but close too quickly to read it. In this case you can view the message by starting AyaNova.exe manually from a command line prompt. For example if AyaNova is installed to the default location open a command prompt (press WIN-x, select "command prompt" from the menu) and type `"c:\Program Files\ayanova\AyaNova.exe"` (note the quotation marks) to run AyaNova and see the error and make the necessary changes.
|
||||
|
||||
#### 6\.2 Double-click the AyaNova App shortcut
|
||||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Note that the AyaNova Server and the AyaNova App shortcut are ONLY relevant to this INITIAL configuration boot and test. Once AyaNova is confirmed to be working via IIS you will no longer access either of these desktop shortcuts. Do KEEP for diagnostic purposes only, you may want to relabel as "Diagnosic AyaNova Server" and "Diagnostic AyaNova App".
|
||||
|
||||
Only after you have confirmed that AyaNova server is working and you can login to the AyaNova web app should you proceed to the next step of enabling IIS to work with AyaNova.
|
||||
|
||||
### IIS AyaNova site configuration
|
||||
### 7\. IIS AyaNova site configuration
|
||||
|
||||
Now that AyaNova server has been confirmed to boot properly IIS needs to be set up to host it.
|
||||
Now that AyaNova server has been confirmed to boot properly IIS needs to be set up to host the AyaNova server.
|
||||
|
||||
Stop AyaNova server if it is still running from the previous step by following the instructions in the server console window. From this point on IIS will be controlling the starting and stopping of the AyaNova server.
|
||||
#### 7\.1 Stop AyaNova server if still running
|
||||
|
||||
#### Open IIS manager
|
||||
If your AyaNova server is still running from the previous "Boot and test the AyaNova Server", stop the AyaNova Server by pressing the ctrl-c key combination as stated in the launcher window. The window will close when you press ctrl-c in the launcher window.
|
||||
|
||||
|
||||
|
||||
From this point on IIS will be controlling the starting and stopping of the AyaNova server.
|
||||
|
||||
#### 7\.2 Open IIS manager
|
||||
|
||||
From a server version of Windows...
|
||||
|
||||
@@ -194,7 +272,7 @@ Access IIS manager from the Windows Start menu in the Windows Administrative Too
|
||||
|
||||
|
||||
|
||||
#### Create the AyaNova IIS site
|
||||
#### 7\.3 Create the AyaNova IIS site
|
||||
|
||||
In the Connections panel open the server's node, right click on Sites to add a new site.
|
||||
|
||||
@@ -212,7 +290,7 @@ The Port setting here has been set to 8080 which is intended to not conflict wit
|
||||
|
||||
Click on OK to save the settings and procede to the next step.
|
||||
|
||||
#### Edit Application Pool
|
||||
#### 7\.4 Edit Application Pool
|
||||
|
||||
Three settings must be changed in the Application Pool for AyaNova to work properly.
|
||||
|
||||
@@ -258,17 +336,17 @@ Typically 3am is a good time as the backup in our scenario starts at 11:59pm and
|
||||
|
||||
Save the recycle time once entered and click on Ok to save and continue to the next step.
|
||||
|
||||
#### Open AyaNova app through IIS
|
||||
### 8\. Open AyaNova app through IIS
|
||||
|
||||
Right click on the AyaNova site created earlier in IIS Manager and select "Manage website" and then "Browse". The AyaNova web app should open to the login (or license agreement) page.
|
||||
|
||||
If you receive an error message from IIS "HTTP Error 500.19 - Internal Server Error The requested page cannot be accessed because the related configuration data for the page is invalid." This generally means you did not follow the steps in the correct order and ASP.NET Core was installed **before** IIS was enabled which means IIS doesn't have the proper handlers to run an ASP.NET Core application. In order to fix this run the ASP.NET Core hosting bundle setup again that was installed previously (repair installation) to ensure IIS is setup with the correct handlers.
|
||||
|
||||
### Starting and stopping AyaNova server
|
||||
### 9\. Starting and stopping AyaNova server
|
||||
|
||||
IIS will automatically manage starting and stopping AyaNova as required.
|
||||
Going forward, IIS will automatically manage starting and stopping AyaNova as required.
|
||||
|
||||
### Next steps
|
||||
### 10\. Next steps
|
||||
|
||||
Server installation under IIS for internal access is complete. Users will require the URL to use in their browser to access the AyaNova APP that was opened in the last step to test AyaNova substituting the server's IP address for the "localhost" part of the URL.
|
||||
|
||||
@@ -278,11 +356,11 @@ For connection from the internet your network adminstrator will need to setup II
|
||||
|
||||
Let's Encrypt provides free SSL certificates and lists [several Windows clients](https://letsencrypt.org/docs/client-options/#clients-windows-/-iis) for use with Let's Encrypt on Windows.
|
||||
|
||||
### Report rendering first time delay
|
||||
#### Report rendering first time delay
|
||||
|
||||
The very first time a report is rendered in AyaNova there will be a delay while the Chromium browser report rendering components are installed.
|
||||
|
||||
## Getting started and using AyaNova
|
||||
#### Getting started and using AyaNova
|
||||
|
||||
The next step is to [login](ay-start-login.md), request or install a [license](adm-license.md) and if are trying out AyaNova for the first time follow the [evaluation trial guide](ay-evaluate.md).
|
||||
|
||||
|
||||
@@ -65,7 +65,7 @@ Once you have ensured the two requirements above are installed and available; do
|
||||
|
||||
Keep the checkmark on _Start AyaNova server when Windows starts_ and click on _next_.
|
||||
|
||||
|
||||
|
||||
|
||||
You will be prompted to go to the asp.net core download page:
|
||||
|
||||
@@ -146,38 +146,54 @@ After editing, saving and exiting out of NotePad, open the config.json file AGAI
|
||||
|
||||
The AyaNova installer will have created two shortcuts in the Start Menu under "AyaNova Server"
|
||||
|
||||
|
||||
|
||||
|
||||
The AyaNova installer also creates two shortcuts on the Windows desktop titled "AyaNova server" and "AyaNova App".
|
||||
The AyaNova installer also creates two shortcuts on the Windows desktop titled "AyaNova server" and "AyaNova App".
|
||||
|
||||
|
||||
|
||||
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\.1 Double click the AyaNova Server shortcut
|
||||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
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.
|
||||
|
||||
Use the AyaNova App shortcut to open the server and get started with AyaNova.
|
||||
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.
|
||||
|
||||
#### If the server closes immediately upon running with an error
|
||||
|
||||
|
||||
##### If the server closes immediately upon running with an error
|
||||
|
||||
In some cases where a critical configuration value is completely missing, the server console may display the error but close too quickly to read it. In this case you can view the message by starting AyaNova.exe manually from a command line prompt. For example if AyaNova is installed to the default location open a command prompt (press WIN-x, select "command prompt" from the menu) and type `"c:\Program Files\ayanova\AyaNova.exe"` (note the quotation marks) to run AyaNova and see the error and make the necessary changes.
|
||||
|
||||
### Starting and stopping AyaNova server
|
||||
As you will remember from the installation above, you kept the checkmarked 'Start AyaNova server when Windows starts'. When your lan server is rebooted, the AyaNova Server shortcut will run on startup.
|
||||
|
||||
|
||||
|
||||
#### 5\.2 Double-click the AyaNova App shortcut
|
||||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
#### Starting and stopping AyaNova server
|
||||
|
||||
To shut down the AyaNova server press the ctrl-c key combination in the ayanova-launcher window.
|
||||
To start the AyaNova server use the installed desktop or start menu icon to run the ayanova-launcher.
|
||||
|
||||
If you chose the "Start with Windows" option during installation AyaNova will start automatically on Windows login.
|
||||
|
||||
### Report rendering first time delay
|
||||
#### Report rendering first time delay
|
||||
|
||||
The very first time a report is rendered in AyaNova there will be a delay while the Chromium browser report rendering components are installed.
|
||||
|
||||
## Getting started and using AyaNova
|
||||
## 6\. Next steps
|
||||
|
||||
Server installation is complete. Users will require the URL to use in their browser to access the AyaNova APP, see the AYANOVA_USE_URLS in the configuration section above.
|
||||
Server installation is complete.
|
||||
|
||||
Users will require the URL to use in their browser to access the AyaNova APP, see the AYANOVA_USE_URLS in the configuration section above.
|
||||
|
||||
The next step is to [login](ay-start-login.md), request or install a [license](adm-license.md) and if are trying out AyaNova for the first time follow the [evaluation trial guide](ay-evaluate.md).
|
||||
|
||||
|
||||
Reference in New Issue
Block a user