This commit is contained in:
@@ -1,12 +1,11 @@
|
||||
# AYANOVA INSTALLATION - LOCAL NETWORK DIRECT ACCESS INSTALL GUIDE
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
This type of installation is *not* suitable for outside internet access, local network only.
|
||||
This type of installation is _not_ suitable for outside internet access, local network only.
|
||||
|
||||
Only the AyaNova server needs to be installed, nothing is required at the users end except for a computer or device with a modern web browser with Javascript enabled.
|
||||
|
||||
|
||||
## AyaNova server system requirements
|
||||
|
||||
- OS : Windows 64 bit operating system
|
||||
@@ -24,32 +23,88 @@ Only the AyaNova server needs to be installed, nothing is required at the users
|
||||
## Installation steps
|
||||
|
||||
### 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, if you need to install PostgreSQL follow this installation guide [https://www.postgresqltutorial.com/install-postgresql/](https://www.postgresqltutorial.com/install-postgresql/)
|
||||
|
||||
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
|
||||
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. 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 server installation
|
||||
|
||||
Once you have ensured the two pre-requisites above are installed and available; download and run the AyaNova network installer: [https://www.ayanova.com/Downloads/v8/ayanova-lan-setup.exe](https://www.ayanova.com/Downloads/v8/ayanova-lan-setup.exe). Follow the prompts and accept the defaults. At the end of setup the ayanova-launcher application will start if selected (or you can run it from the desktop icon) and in turn it will start the Postgres server, AyaNova server and then open the default web browser to both the AyaNova server interface and the AyaNova User interface.
|
||||
Once you have ensured the two pre-requisites above are installed and available; download and run the AyaNova network installer: [https://www.ayanova.com/Downloads/v8/ayanova-lan-setup.exe](https://www.ayanova.com/Downloads/v8/ayanova-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 (default is `c:\Program Files\ayanova\config.json`) as its 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:
|
||||
|
||||
```json
|
||||
{
|
||||
"AYANOVA_USE_URLS": "http://*:7575",
|
||||
"AYANOVA_DB_CONNECTION": "Server=localhost;Username=postgres;Password=mypasswordforpostgres;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 "mypasswordforpostgres" substitute the actual PostgreSQL password to be used. 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.
|
||||
|
||||
This 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).
|
||||
|
||||
|
||||
#### 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.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
After the installation has completed the configuration must
|
||||
|
||||
### Adjust defaults
|
||||
|
||||
At the end of setup the ayanova-launcher application will start if selected (or you can run it from the desktop icon) and in turn it will start the Postgres server, AyaNova server and then open the default web browser to both the AyaNova server interface and the AyaNova User interface.
|
||||
|
||||
## 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.
|
||||
|
||||
## Getting started and using AyaNova
|
||||
|
||||
The next step is to follow the [getting started](adm-getting-started.md) guide for using and administrating AyaNova from a business point of view and also the [operations maintenance](ops-maintenance.md) guide to ensure AyaNova runs smoothly and data is safe and secure.
|
||||
|
||||
|
||||
|
||||
|
||||
if MsgBox('AyaNova requires ASP.NET Core Runtime "Hosting bundle" 6.0.0 or newer.\nOpen the download web page now?', mbConfirmation, MB_YESNO or MB_DEFBUTTON2) = IDYES then
|
||||
begin
|
||||
ShellExec('open', 'https://dotnet.microsoft.com/download', '', '', SW_SHOW, ewNoWait, ErrCode);
|
||||
end;
|
||||
if MsgBox('AyaNova requires PostgreSQL db server.\nOpen the PostgreSQL installation instructions web page now?', mbConfirmation, MB_YESNO or MB_DEFBUTTON2) = IDYES then
|
||||
begin
|
||||
ShellExec('open', 'https://www.postgresqltutorial.com/install-postgresql/', '', '', SW_SHOW, ewNoWait, ErrCode);
|
||||
end;
|
||||
if MsgBox('AyaNova requires ASP.NET Core Runtime "Hosting bundle" 6.0.0 or newer.\nOpen the download web page now?', mbConfirmation, MB_YESNO or MB_DEFBUTTON2) = IDYES then
|
||||
begin
|
||||
ShellExec('open', 'https://dotnet.microsoft.com/download', '', '', SW_SHOW, ewNoWait, ErrCode);
|
||||
end;
|
||||
if MsgBox('AyaNova requires PostgreSQL db server.\nOpen the PostgreSQL installation instructions web page now?', mbConfirmation, MB_YESNO or MB_DEFBUTTON2) = IDYES then
|
||||
begin
|
||||
ShellExec('open', 'https://www.postgresqltutorial.com/install-postgresql/', '', '', SW_SHOW, ewNoWait, ErrCode);
|
||||
end;
|
||||
|
||||
Reference in New Issue
Block a user