Pre-installation Preparations

The setup of Izenda requires a download of the latest version of the stand-alone front-end and the back-end and a proper web server setup. Izenda can be installed on a local machine on a Windows machine for testing purposes and is a best practice for ensuring permissions and performance can be validated locally prior to moving toward more embedded and integrated examples, but it is not recommended for live deployments.

• Izenda installation packages, download them from the Upgrade tab in the Customer Portal.

  • An Izenda Front-end Package (Default name “App”)
    

    

  • An Izenda Back-end Package (Default name “API”)
    

    

• Server

  • Windows Server with Internet Information Services (IIS) Web Server.

Runtime Installation

Izenda depends on .Net Core 3.1 runtime environment to run application. This step is only required if you are installing Izenda 4.0.0 and above.

Web Server Setup

To ensure that Izenda works properly, your Web Server requires additional components that may not be present on your server by default. If you are installing Izenda 4.0.0 and above, this step is not required.

Izenda Installation As Two Separate Sites

The most common testing scenario places the front-end and the back-end on two separate sites. Virtual Directories and Virtual Applications deployments are possible with additional configuration and are outlined in another section below.

1. Extract the Izenda Front-end and Back-end packages to 2 separate folders, preferably at C:\inetpub\wwwroot\Izenda\App and C:\inetpub\wwwroot\Izenda\API.

2. Izenda can be installed in multiple configurations: new website, new application to an existing website, or new virtual application under an existing website:

   • New website

     1. Right-click the local connection and select Add Website…

     2. Name the website IzendaApp and accept the Application pool with the same name.

     3. Click the ellipsis (…) button to select the location of the extracted Izenda Front-end package (C:\inetpub\wwwroot\Izenda\App).

     4. Skip the Connect as… and Test Settings… buttons for now, since permissions have not been set for Izenda package folders.

     5. Keep the port as 80 by default or change to any available port.

     6. Optionally enter the website address into host name box, but you will have to bind that address with the correct ip in “C:\WINDOWS\System32\drivers\etc\hosts” file.

        e.g. with website address www.acme.com and the ip 127.0.0.1, the following line needs to be added in hosts file: 127.0.0.1    www.acme.com

     7. Click OK to create the website.

     
     

3. Add new website for Back-end package:

   • Follow above steps and add another site for Izenda back-end with different port.

4. Set folder permissions

   1. Right-click the newly-created website, application or virtual application and select Edit Permissions to open the folder properties.

   2. In Security tab, click Edit to open Permissions dialog box.

   3. Click Add then enter IUSR then click OK (for IIS 7 and above).

      For older IIS versions, use NTAUTHORITY\\NETWORKSERVICE.

   4. Back in Permissions dialog box, tick the Modify check-box for IUSR.

   5. Click OK to close all dialogs.

      
      

   6. Set similar permissions for the other package.

5. Update the Back-end API url in Front-end package:

   Edit the file App\izenda_config.js, replace the default value “WebApiUrl” with the correct ip and port: "WebApiUrl":"http://127.0.0.1:8888/api/",

This concludes the steps necessary to install Izenda using two separate websites. Please refer to the following guides below: - Troubleshooting & Verifying the Installation - Common Izenda Stand-alone Installation Issues - Editing the Configuration Files

Deploying Izenda as a Virtual Directory or Application

Installing Izenda as a virtual directorys will mirror the steps taken required to deploy Izenda using two separate websites but additional modifications are necessary for the front end and back end to interact correctly together.

Troubleshooting & Verifying the Installation

• To ensure that your API site is running correctly, navigate to http://YOUR_API_URL/api/404 (e.g. http://localhost:8080/api/404)

  If your API is installed correctly, you should see the graphic below:

  

• Navigate to the API folder, you should see a ‘logs’ folder with with at least one log file. If you do not see the folder and/or files, verify that the application pool and/or web site user have write permissions to the API folder.

Common Izenda Standalone Installation Issues

Pre-install preparations

1. Runtime Installation - Izenda 4.0.0 and above

   Izenda depends on .Net Core 3.1 runtime environment to run application.

   1. Create instance of Ubuntu 18.04

   2. Login using ssh as default user

   3. Download and install .NET core 3.2 sdk run time env. Download here

      wget https://packages.microsoft.com/config/ubuntu/18.04/packages-microsoft-prod.deb -O packages-microsoft-prod.debsudo dpkg -i packages-microsoft-prod.debsudo apt-get update;sudo apt-get install -y apt-transport-https && sudo apt-get update && sudo apt-get install -y aspnetcore-runtime-3.1

   4. Use dotnet--info to check the installation of .NET Core. You suppose to recieve the following result if .NET Core 3.1 was successfully installed.

      

2. Runtime Installation - Prior to Izenda 4.0.0

   Prior to Izenda 4.0.0, Izenda uses .Net Core 2.2 runtime.

   1. Create instance of Ubuntu 18.04

   2. Login using ssh as default user

   3. Download and install .NET core 2.2 sdk and run time env. Download here

      • If you recieve any error, please follow the below steps

        wget -q https://packages.microsoft.com/config/ubuntu/18.04/packages-microsoft-prod.debsudo dpkg -i packages-microsoft-prod.debsudo add-apt-repository universesudo apt-get install apt-transport-httpssudo apt-get updatesudo apt-get install aspnetcore-runtime-2.2sudo dpkg --purge packages-microsoft-prod && sudo dpkg -i packages-microsoft-prod.debsudo apt-get updatesudo apt-get install aspnetcore-runtime-2.2

      • If the issues were not resolved, please follow the below steps to re-install

        sudo apt-get install -y gpgwget -qO- https://packages.microsoft.com/keys/microsoft.asc | gpg --dearmor > microsoft.asc.gpgsudo mv microsoft.asc.gpg /etc/apt/trusted.gpg.d/wget -q https://packages.microsoft.com/config/ubuntu/18.04/prod.listsudo mv prod.list /etc/apt/sources.list.d/microsoft-prod.listsudo chown root:root /etc/apt/trusted.gpg.d/microsoft.asc.gpgsudo chown root:root /etc/apt/sources.list.d/microsoft-prod.listsudo apt-get install -y apt-transport-httpssudo apt-get updatesudo apt-get install aspnetcore-runtime-2.2

   4. Use dotnet--info to check the installation of .NET Core. You suppose to recieve the following result if .NET Core 2.2 was successfully installed

      

3. Install Appache2 as reverse proxy

   1. Update Ubuntu packages to the latest stable version: sudoapt-getupdate

   2. Install vim: sudoapt-getinstallvim-y

   3. Install the Apache web server on Ubuntu: sudoapt-getinstallapache2-y

   4. Enable the Apache required modules

      sudo a2enmod rewritesudo a2enmod proxysudo a2enmod proxy_httpsudo a2enmod headerssudo a2enmod ssl –- if you want to configure as SSLsudo service apache2 restart

   5. Verify Apache installation by running localhost.

      

4. Download Izenda Font-end and Back-end packages

   • Download the latest Izenda packages from from the Upgrade tab in the Customer Portal.

     sudo wget  -P /home/ubuntu/ {/area/to/}StandaloneUI.zipsudo wget  -P /home/ubuntu/ {/area/to/}API_AspNetCore.zip

   • Unzip the Izenda Font-end and Back-end packages

     sudo apt-get install zip unzip // Download the zip toolsudo unzip 'StandaloneUI.zip' -d /var/www/izenda-ui // Unzip the Izenda Front-end packagesudo unzip 'API_AspNetCore.zip' -d /var/www/izenda-api // Unzip the Izenda Back-end package

5. Configure Apache reverse proxy

   1. Enter domain name in to apache2.conf file

      sudo vim /etc/apache2/apache2.confServerName localhost

Install Izenda as two separate sites

1. Create izenda-ui.conf under /etc/apache2/sites-available: sudovim/etc/apache2/sites-available/izenda-ui.conf

   Listen 8080
   									<VirtualHost *:8080>
   									ServerAdmin webmaster@localhost
   									DocumentRoot /var/www/izenda-ui/StandaloneUI
   									ErrorLog /var/log/apache2/izenda-ui-error.log
   									CustomLog /var/log/apache2/Izenda-ui-access.log common
   									<Directory "/var/www/izenda-ui/StandaloneUI">
   									RewriteEngine on
   									# Don't rewrite files or directories
   									RewriteCond %{REQUEST_FILENAME} -f [OR]
   									RewriteCond %{REQUEST_FILENAME} -d
   									RewriteRule ^ - [L]
   									# Rewrite everything else to index.html to allow html5 state links
   									RewriteRule ^ index.html [L]
   									</Directory>
   									</VirtualHost>
   								

2. Create izenda-api.conf under //etc/apache2//sites-available: sudovim/etc/apache2/sites-available/izenda-api.conf

   Listen 8081
   									<VirtualHost *:8081>
   									ProxyPreserveHost On
   									ProxyRequests Off
   									ProxyPass / http://127.0.0.1:5000/
   									ProxyPassReverse / http://127.0.0.1:5000/
   									ServerName localhost
   									ErrorLog /var/log/apache2/izenda-api-error.log
   									CustomLog /var/log/apache2/Izenda-api-access.log common
   									</VirtualHost>
   								

3. Active the Front-end and Back-end sites.

   sudo a2ensite izenda-api.confsudo a2ensite izenda-ui.conf

4. Verify the configuration: sudoapachectlconfigtest. If the configuration is correct, the result will be SyntaxOk. If not, there is an issue in the configuration.

5. Update WebURL in Izenda_Config.js file with the proper prt (8081). WebApiUrl:"http://localhost:8087/api/

6. Provide write permission to current user

   sudo gpasswd -a "$USER" www-datasudo chown -R "$USER":www-data /var/wwwfind /var/www -type f -exec chmod 0660 {} \;sudo find /var/www -type d -exec chmod 2770 {} \;

7. Restart the website: sudoserviceapache2restart

8. Start your dotnet application: sudodotnetIzenda.BI.API.AspNetCore.dll. If the installation is success, you can browse you website via localhost with the 8080 port

Create monitor service

1. Install Supervisor, a monitor service app: sudoapt-getinstallsupervisor

2. Create supervisor config file: sudovim/etc/supervisor/conf.d/izenda-api.conf

3. Add the following content to the above file

   [program:dotnettest]command=/usr/bin/dotnet /var/www/izenda-api/API_AspNetCore/Izenda.BI.API.AspNetCore.dll  --urls "http://*:5000"directory=/var/www/izenda-api/API_AspNetCoreautostart=trueautorestart=truestderr_logfile=/var/log/izenda-api.err.logstdout_logfile=/var/log/izenda-api.out.logenvironment=ASPNETCORE_ENVIRONMENT=Productionuser=www-datastopsignal=INT

4. Command to start/stop the service

   • Start Supervisor: sudoservicesupervisorstart
   • Stop Supervisor: sudoservicesupervisorstop

5. Verifying the service running progress sudotail-f/var/log/izenda-api.out.log

Configuring Exporting

1. Configuring Exporting - Izenda 4.0.0 and above

   • To convert HTML to PDF in Linux using the Blink rendering engine, the following packages should be installed in the Linux machine where the conversion takes place:

     $ sudo apt-get update
     													        $ sudo apt-get install -yq --no-install-recommends libasound2
     													        $ sudo apt-get install -yq --no-install-recommends libatk1.0-0 libc6 libcairo2 libcups2 libdbus-1-3
     													        $ sudo apt-get install -yq --no-install-recommends libexpat1 libfontconfig1 libgcc1 libgconf-2-4 libgdk-pixbuf2.0-0 libglib2.0-0 libgtk-3-0 libnspr4
     													        $ sudo apt-get install -yq --no-install-recommends libpango-1.0-0 libpangocairo-1.0-0 libstdc++6 libx11-6 libx11-xcb1 libxcb1
     													        $ sudo apt-get install -yq --no-install-recommends libxcursor1 libxdamage1 libxext6 libxfixes3 libxi6 libxrandr2 libxrender1 libxss1 libxtst6
     													        $ sudo apt-get install -yq --no-install-recommends libnss3
     												

   • Give permission to run the Blink rendering engine

     sudo chmod 755 /var/www/izenda-api/API_AspNetCore/Export/BlinkBinariesLinux/chromesudo chmod 755 /var/www/izenda-api/API_AspNetCore/Export/BlinkBinariesLinux/chrome-wrappersudo chmod 755 /var/www/izenda-api/API_AspNetCore/Export/BlinkBinariesLinux/chrome_sandbox

2. Configuring Exporting - Prior to Izenda 4.0.0

   • To convert HTML to PDF in Linux using the WebKit rendering engine, the following packages should be installed in the Linux machine where the conversion takes place:

     $ sudo apt-get update
     													$ sudo apt-get install xvfb
     													$ sudo apt-get install libssl-dev
     													$ sudo apt-get install libx11-dev libx11-xcb-dev libxcb-icccm4-dev libxcb-image0-dev libxcb-keysyms1-dev libxcb-randr0-dev libxcb-render-util0-dev libxcb-render0-dev libxcb-shm0-dev libxcb-util0-dev libxcb-xfixes0-dev libxcb-xkb-dev libxcb1-dev libxfixes-dev libxrandr-dev libxrender-dev
     												

   • Give permission to run the Syncfusion WebKit

     sudo chmod 755 /var/www/izenda-api/API_AspNetCore/Export/QtBinariesLinux/Syncfusion.WebKitWrapper

Next: Install Izenda System Database and Apply License