diff --git a/devdocs/specs/core-reporting.txt b/devdocs/specs/core-reporting.txt index 4d9fa3bb..dfa38f6e 100644 --- a/devdocs/specs/core-reporting.txt +++ b/devdocs/specs/core-reporting.txt @@ -315,7 +315,7 @@ HTML -> PDF SLOWEST SPEED https://github.com/Kozea/WeasyPrint based on python, does it's own rendering doesn't rely on a web browser engine like the rest free, recommended by wkhtmltopdf author as an alternative - May be slow, slower than the other options likely, has some installation steps that are a bit convoluted but ironically only for windows as it's included in package managers + May be slow, slower than the other options likely, has some Installation procedure that are a bit convoluted but ironically only for windows as it's included in package managers Very good support for modern css3 PAGE properties apparently WRAPPER https://github.com/balbarak/WeasyPrint-netcore/blob/master/src/Balbarak.WeasyPrint/WeasyPrintClient.cs diff --git a/docs/8.0/ayanova/docs/img/ops-install-windows-internet-iis-role-services.png b/docs/8.0/ayanova/docs/img/ops-install-windows-internet-iis-role-services.png new file mode 100644 index 00000000..f3f1ef14 Binary files /dev/null and b/docs/8.0/ayanova/docs/img/ops-install-windows-internet-iis-role-services.png differ diff --git a/docs/8.0/ayanova/docs/img/ops-install-windows-internet-iis-role.png b/docs/8.0/ayanova/docs/img/ops-install-windows-internet-iis-role.png new file mode 100644 index 00000000..39dd0355 Binary files /dev/null and b/docs/8.0/ayanova/docs/img/ops-install-windows-internet-iis-role.png differ diff --git a/docs/8.0/ayanova/docs/img/ops-install-windows-internet-iis-win10-features-turn-on-iis.png b/docs/8.0/ayanova/docs/img/ops-install-windows-internet-iis-win10-features-turn-on-iis.png new file mode 100644 index 00000000..bae2d322 Binary files /dev/null and b/docs/8.0/ayanova/docs/img/ops-install-windows-internet-iis-win10-features-turn-on-iis.png differ diff --git a/docs/8.0/ayanova/docs/img/ops-install-windows-internet-iis-win10-features-turn-on.png b/docs/8.0/ayanova/docs/img/ops-install-windows-internet-iis-win10-features-turn-on.png new file mode 100644 index 00000000..45685df7 Binary files /dev/null and b/docs/8.0/ayanova/docs/img/ops-install-windows-internet-iis-win10-features-turn-on.png differ diff --git a/docs/8.0/ayanova/docs/img/ops-install-windows-internet-iis-win10-prgrams-features.png b/docs/8.0/ayanova/docs/img/ops-install-windows-internet-iis-win10-prgrams-features.png new file mode 100644 index 00000000..0bdcbdae Binary files /dev/null and b/docs/8.0/ayanova/docs/img/ops-install-windows-internet-iis-win10-prgrams-features.png differ diff --git a/docs/8.0/ayanova/docs/img/ops-install-windows-internet-iis-win10-settings-apps.png b/docs/8.0/ayanova/docs/img/ops-install-windows-internet-iis-win10-settings-apps.png new file mode 100644 index 00000000..ce593b1f Binary files /dev/null and b/docs/8.0/ayanova/docs/img/ops-install-windows-internet-iis-win10-settings-apps.png differ diff --git a/docs/8.0/ayanova/docs/img/ops-install-windows-internet-mgraddrole.png b/docs/8.0/ayanova/docs/img/ops-install-windows-internet-mgraddrole.png new file mode 100644 index 00000000..ee494b88 Binary files /dev/null and b/docs/8.0/ayanova/docs/img/ops-install-windows-internet-mgraddrole.png differ diff --git a/docs/8.0/ayanova/docs/ops-install-windows-internet.md b/docs/8.0/ayanova/docs/ops-install-windows-internet.md index 056853fc..925d80f0 100644 --- a/docs/8.0/ayanova/docs/ops-install-windows-internet.md +++ b/docs/8.0/ayanova/docs/ops-install-windows-internet.md @@ -1,7 +1,147 @@ # AYANOVA INSTALLATION - INTERNET ACCESS VIA IIS INSTALL GUIDE -todo copy lan guide and include IIS setup and config, get screenshots for that as it can be confusing -Also, remove the IIS version installer, only need the lan one, it's the same and remove from teh build batch file. +This installer includes the AyaNova server application only and requires an IIS server, a PostgreSQL server be installed or accessible and the .net Core framework to be installed separately first. Once the AyaNova server is hosted on IIS users from the internet as well as on a local area network can access the AyaNova web app with their browsers. + +This type of installation is suitable for both outside internet access and inside the local network. + +Once the AyaNova server is installed and hosted within IIS, nothing needs to be installed for the end users who will access the AyaNova app on a computer or device with a modern web browser with Javascript enabled. + +## AyaNova web app system requirements + +Any modern browser (not Internet Explorer) with Javascript enabled and a minimum device screen width of 360 pixels. + +## AyaNova server system requirements + +- OS : Windows 64 bit operating system with IIS +- IIS: Internet information server +- Internet connection : required to install license and to automatically download the Chromium report rendering engine on installation +- 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/](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](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: 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](ops-config-environment-variables.md). + +## Installation procedure + +Follow the steps below **in the order** they are presented here. + +### Enable IIS Internet Information Server + +If you already have IIS enabled read through and verify the following instructions to **confirm** it is ready for AyaNova. + +The steps to enable IIS vary by type of operating system: + +#### Windows Server operating systems + +(The following images are taken from a Windows Server 2019 operating system but the procedure is the same for any modern version of Windows server) + +Enable the IIS server Role and selected Role settings: + +Use the Add Roles and Features wizard from the Manage menu or the link in Server Manager, check the box for Web Server (IIS): +![Server manager](img/ops-install-windows-internet-mgraddrole.png) + +![Select IIS Role](img/ops-install-windows-internet-iis-role.png) + +If IIS is being enabled for the first time you can accept all remaining defaults to conclusion. + +If IIS was already enabled, double check the default settings for Role Services for IIS are enabled: +![IIS Role Services](img/ops-install-windows-internet-iis-role-services.png) + +Reboot is not required at this point, continue on to the PostgreSQL installation below. + + +#### Windows Desktop operating systems +Enable the IIS Role and selected Role settings: + +Open the Apps & Features settings page from the Apps shortcut in Settings: +![Apps](img/ops-install-windows-internet-iis-win10-settings-apps.png) + +In Apps & Features select the "Programs and Features" link under "Related settings" in the upper right corner of the Apps & Features page: +![Apps](img/ops-install-windows-internet-iis-win10-prgrams-features.png) + +In "Programs and Features" dialog box select "Turn Windows features on or off" link: +![Apps](img/ops-install-windows-internet-iis-win10-features-turn-on.png) + + + +### 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/) + +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 + +IIS **MUST** be installed **before** the ASP.NET Core runtime. AyaNova will not work if IIS is installed after the ASP.NET Core runtime. + +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 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 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. + +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. + +#### 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](ops-intro.md) configuration and maintenance guide. + +For the Business administration role, now that the server is up and running AyaNova business settings can be configured, review the [Getting started](adm-getting-started.md) guide for Administrators. + +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. 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 7afd28fc..2502fb80 100644 --- a/docs/8.0/ayanova/docs/ops-install-windows-lan.md +++ b/docs/8.0/ayanova/docs/ops-install-windows-lan.md @@ -6,6 +6,10 @@ This type of installation is _not_ suitable for outside internet access, local n 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 web app system requirements + +Any modern browser (not Internet Explorer) with Javascript enabled and a minimum device screen width of 360 pixels. + ## AyaNova server system requirements - OS : Windows 64 bit operating system @@ -20,7 +24,7 @@ Only the AyaNova server needs to be installed, nothing is required at the users - Program files : By default (and recommended) AyaNova server program files will be installed to `C:\Program Files\ayanova` folder - Data files: 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](ops-config-environment-variables.md). -## Installation steps +## Installation procedure ### PostgreSQL server diff --git a/docs/8.0/ayanova/docs/ops-install-windows-single.md b/docs/8.0/ayanova/docs/ops-install-windows-single.md index 94aa8eb4..7be168fd 100644 --- a/docs/8.0/ayanova/docs/ops-install-windows-single.md +++ b/docs/8.0/ayanova/docs/ops-install-windows-single.md @@ -16,6 +16,7 @@ For simplicity of use, the "single" installation is intended for users who will - Internet connection : required to install license and to automatically download the Chromium report rendering engine on installation - Disk space: minimum 400mb of free disk space - RAM : 512 MB (minimum), 1 GB (recommended) +- Modern web browser (not Internet Explorer) with Javascript enabled ## Existing Postgres sql server @@ -30,7 +31,7 @@ The single user installer will use TCP/IP ports 6432 for the Postgres server and - Program files : By default (and recommended) AyaNova server program files will be installed to `C:\Program Files\ayanova` folder - Data files: AyaNova will store all data in the %ProgramData% folder under `ayanova` which on most computers will be located at `C:\ProgramData\ayanova`. This includes all logs, backups and User attachment files. -## Installation steps +## Installation procedure - Download and run the standalone installer from our web site: [https://www.ayanova.com/Downloads/v8/ayanova-single-setup.exe](https://www.ayanova.com/Downloads/v8/ayanova-single-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. diff --git a/docs/8.0/ayanova/docs/ops-install-windows.md b/docs/8.0/ayanova/docs/ops-install-windows.md index 8bd2c752..c5c160c9 100644 --- a/docs/8.0/ayanova/docs/ops-install-windows.md +++ b/docs/8.0/ayanova/docs/ops-install-windows.md @@ -10,7 +10,7 @@ This type of install is appropriate for using AyaNova locally on a single person ## Shared multiple user installation -When more than one user will be accessing AyaNova it can be set up in two different ways. +When more than one user will be accessing AyaNova it can be set up in two different ways on a Windows server. ### AyaNova server direct