Files

John Cardinal 18cf8800ee

2021-12-14 17:16:59 +00:00

9.0 KiB

Raw Blame History

AYANOVA INSTALLATION - WINDOWS LOCAL NETWORK

Please read through all the instructions below before proceeding with installation to be sure everything is available and ready.

Windows Local network installation is suitabale for use within a private office network. This type of installation is not suitable for outside internet access, for outside access use the IIS hosted AyaNova server install guide instead.

This installer includes the AyaNova server application only and requires a PostgreSQL server be installed or accessible and the .net Core framework to be installed separately first.

Once the AyaNova server is up and running users on a local area network can access it with their web browsers pointed to the address of the AyaNova server.

No installation is required at the user end to access the AyaNova web app with a supported browser.

AyaNova web app system requirements

Any modern browser (not Internet Explorer) with Javascript enabled on any device with a minimum display width of 360 pixels.

AyaNova server system requirements

OS : Windows 64 bit operating system
Internet connection : required to install license and to automatically download the Chromium report rendering engine
Disk space: minimum 400mb of free disk space
RAM : 512 MB (minimum), 1 GB (recommended)
PostgreSQL Server: installation guide https://www.postgresqltutorial.com/install-postgresql/
ASP.NET Core Runtime Hosting bundle v6.0.0 or newer : Download https://dotnet.microsoft.com/permalink/dotnetcore-current-windows-runtime-bundle-installer

Folders

Program files : By default (and recommended) AyaNova server program files will be installed to C:\Program Files\ayanova folder
Data files: All data aside from attachment files is stored in the PostgreSQL database. By default AyaNova will store attachment files, logs and backup files in the %ProgramData% folder under ayanova which on most computers will be located at C:\ProgramData\ayanova. Each folder location can be changed via configuration.

Installation procedure

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/

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 after installing the AyaNova server.

ASP.NET Core Runtime

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.

AyaNova server installation

Once you have ensured the two requirements above are installed and available; download and run the AyaNova network installer: https://www.ayanova.com/Downloads/v8/ayanova-windows-x64-lan-setup.exe. Follow the prompts and complete the installation.

Server configuration

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 required for the server to start. It is necessary to edit this file (or provide an alternative source of configuration and specify the password to connect to the PostgreSQL server. 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_DATA_PATH": "%ProgramData%\\ayanova",
  "AYANOVA_LOG_LEVEL": "Info"
}

The AYANOVA_DB_CONNECTION 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 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.

Optional but recommended: Add a 32 character AYANOVA_JWT_SECRET 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.

{
  ...existing properties...
  "AYANOVA_LOG_LEVEL": "Info",
  "AYANOVA_JWT_SECRET": "1111111MyRandom32CharacterSecret"
}

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 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.

Use the AyaNova App shortcut to open the server and get started with AyaNova.

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

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.

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.

For Server Operations role review the Server operations configuration and maintenance guide.

For the Business administration role review the Getting started guide for Administrators.

9.0 KiB Raw Blame History