Installing Exago on Linux

The following article walks through the installation process for Linux systems. Before beginning installation, refer to the Technical Specifications article for a list of supported distributions and a list of minimum requirements.

Important

The Linux Installer was updated in v2019.2.1 of the application. This document covers several versions of the installer. Use the Viewing content for dropdown to see only the content relevant to a specific application version. Any previous headless install scripts will start prompting for missing formation and will require editing to account for the new parameters.

This article is divided into three sections: Apache, NGINX and Common Install Information. Only follow the instructions in the section that corresponds with the web server in your environment, and review Common Install Information for all installations.

NGINX

Installation with Apache

Apache must be installed prior to installing Exago.

The Exago Linux Installer can be used to install the Exago Web Application, Web Service API, and Scheduler Service. It can also install mono and mod-mono. Use the following steps to install Exago on Linux with Apache.

Note

Apache or NGINX must be installed prior to installing Exago. If changing from one or the other, verify the dependencies (mod-mono or mono-fastcgi-server4) are installed.

1. Navigate to the Downloads page, select a build, and then use the Linux Download option.
2. Decompress the download:

   tar zxvf ExagoInstaller_vX.X.X.X.tgz

3. Change to the newly created Installer directory:

   cd Installer

4. Run installExago.sh as root:

   sudo ./installExago.sh

5. The installer can be run in guided or silent mode. The Linux distribution and Apache version will be detected automatically.

Silent Installation with Parameters

Usage:

[-d <install path>] [-m <TRUE|FALSE>] [-i <WEBAPP|WEBAPI|SCHEDULER>] [-y] [-h]

Examples:

1. Install the Exago Web Application and Web Service API into /opt/Exago

   ./installExago.sh -d /opt/Exago -m TRUE -i WEBAPP -i WEBAPI

2. Full installation using all default values without prompting before starting the install

   ./installExago.sh -D -y

3. Install the Scheduler Service only into /opt/ExagoRemote using defaults for everything else

   ./installExago.sh -d /opt/ExagoRemote -i SCHEDULER -D

Start and Test Install

Restart Apache.

Point your browser to the Admin Console to verify that your installation was successful and to create a default configuration file. By default this is http://<YourServer>/Exago/Admin.aspx

Continue to Folder Configuration below to continue with the installation.

Folder Configuration

Configure storage locations for the configuration, report storage (either Storage Management for v2020.1.0+ or a Report Path pre-v2020.1.0) and temporary file storage.

Config

The Config sub-folder of the Exago installation has read and write permissions set by default.

Report Storage

Temporary File Storage

The recommended path for the Temp folder is /opt/Exago/Temp.

1. Set the Temp folder’s read and write permissions to 775.

   sudo chmod 775 /opt/Exago/Temp

2. Set the default ownership to <apache user>:root
3. In the Admin Console, specify the location of the temp Folder in General > Main Settings > Temp Path
4. Set the MonitoringService folder’s read and write permissions for the Apache user, (of if not using the default Apache user the user ID specified with -u) to 775, and set the default ownership to <apache user>:root.

Note

If using a custom Application Theme, the ApplicationThemes folder will also need the same permissions.

Installation is now completed. If the Scheduler Service or Monitoring Service is required, continue to the Scheduler and Monitoring Services section at the end of this article.

If all components are installed, the Installer directory may be deleted.

If you need more assistance, contact Exago Support.

Installation with NGINX

NGINX must be installed prior to installing Exago. NGINX proxies incoming and outgoing requests to a running instance of Exago using a fastcgi module that is installed during the installation process. mono-fastcgi-server4 is a prerequisite for Exago to run on NGINX.

The Exago Linux Installer can be used to install the Exago Web Application, Web Service API, and Scheduler Service. It can also install mono and mono-fastcgi-server4. Use the following steps to install Exago on Linux with NGINX.

Note

Apache or NGINX must be installed prior to installing Exago. If changing from one or the other, verify the dependencies (mod-mono or mono-fastcgi-server4) are installed.

1. Navigate to the Downloads page, select a build, and then use the Linux Download option.
2. Decompress the download:

   tar zxvf ExagoInstaller_vX.X.X.X.tgz

3. Change to the newly created Installer directory:

   cd Installer

4. Run installExago.sh as root:

   sudo ./installExago.sh

5. The installer can be run in guided or silent mode. The Linux distribution will be detected automatically.

Silent Installation with Parameters

Usage:

[-d <install path>] [-m <TRUE|FALSE>] [-i <WEBAPP|WEBAPI|SCHEDULER>] [-y] [-h]

Examples:

1. Install the Exago Web Application and Web Service API into /opt/Exago

   ./installExago.sh -d /opt/Exago -m TRUE -i WEBAPP -i WEBAPI

2. Full installation using all default values without prompting before starting the install

   ./installExago.sh -D -y

3. Install the Scheduler Service only into /opt/ExagoRemote using defaults for everything else

   ./installExago.sh -d /opt/ExagoRemote -i SCHEDULER -D

Start and Test Install

Configure NGINX

The required configuration is created in a separate site file located in the NGINX configuration directory.

For Ubuntu systems this is typically /etc/nginx/sites-available/exago. For other systems this may be /etc/nginx/conf.d/exago. The exact location of the file will depend on your system and NGINX installation. Consult with the operating system and NGINX official product documentation for more information.

The site file is not enabled by default.

Example

#Exago conf file for fastcgi-mono-server4 server { 	listen 80; 	listen [::]:80; 	server_name _; 	root /var/www;    location /Exago/ {   	include /etc/nginx/fastcgi_params;   	root /opt/Exago;   	access_log /var/log/nginx/exago.log;   	fastcgi_param SERVER_NAME $host;   	fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;   	fastcgi_param PATH_INFO "";   	fastcgi_pass 127.0.0.1:9000;   }    location /ExagoWebApi/ {           include /etc/nginx/fastcgi_params;           root /opt/Exago/WebServiceApi;           access_log /var/log/nginx/exago_ws.log;           fastcgi_param SERVER_NAME $host;           fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;           fastcgi_param PATH_INFO "";           fastcgi_pass 127.0.0.1:9001;   } }

For example on Ubuntu, to enable the site file, link it to /etc/nginx/sites-enabled:

sudo ln /etc/nginx/sites-available/exago /etc/nginx/sites-enabled/exago

Or include the configuration in another running site configuration file. This step will depend on your specific environment. Consult your operating system and NGINX official documentation.

Caution

Make sure that the default port does not conflict with another running site. If it does, you will see a warning when reloading Nginx: nginx: [warn] conflicting server name "Exago" on 0.0.0.0:80

Then reload NGINX to refresh the configuration:

sudo nginx -s reload

Note

This article references <WebApp>/, <WebSvc>/ as a placeholder for the application’s install location and the Web Service API’s install location, respectively. The default install locations are /opt/Exago/ and /opt/Exago/WebServiceApi; however, these directories may be changed during installation.

Start Listeners

<WebApp>/bin/startExago.sh

<WebSvc>/bin/startWebService.sh

Content Storage Configuration

The Config sub-folder of the Exago installation has read and write permissions set by default.

Default UMASK for files written by Exago is 027.

The recommended path for the Temp folder is /opt/Exago/Temp.

1. Set the Temp folder’s read and write permissions to 775:

   sudo chmod 775 /opt/Exago/Temp

2. In the Admin Console, specify the location of the temp Folder in General > Main Settings > Temp Path

Note

If using a custom Application Theme, the ApplicationThemes folder will also need the same permissions.

Installation of Exago is now completed. If the Scheduler Service or Monitoring Service is required, continue to the Scheduler and Monitoring Services section at the end of this article.

If all components are installed, the Installer directory may be deleted.

If you need more assistance, contact Exago Support.

Common Install Information

Scheduler and Monitoring Services

Scheduler Service

A script named exago-scheduler.sh by default is used to manage the Scheduler Service. The name is customizable with the installer’s -r parameter.

Installed as a systemd Service

When utilizing a systemd service, the Scheduler Service should start automatically when the system boots, and can be managed with the service command in the following ways:

• service exago-scheduler start
• service exago-scheduler stop
• service exago-scheduler status

When a second scheduler is installed on the same server, the default service name will increment: exago-scheduler2, exago-scheduler3, and so on.

Not Installed as a systemd Service

When the Scheduler Service is not installed as a systemd service (without the -R parameter), it is not possible to know if another service with the same name exists on the same server. When a service with the same name is installed, only one can be used at a time. This is due to the fact that lock files used by the service are based on the service’s name, and will prevent the second process from starting. In this scenario, the -r flag should be used and additional schedulers be given different names.

To start the Scheduler Service, execute the exago-scheduler.sh script as the owner of the installation directory (either root pre-v2019.2.21 or the user name specified with the -u parameter, exago by default in v2019.2.21+). For example:

su exago
/opt/Exago/Scheduler/exago-scheduler.sh start
exit

su root
/opt/Exago/Scheduler/exago-scheduler.sh start
exit

See Scheduler Configuration and Setting Up Monitoring to configure the respective services correctly. If necessary, configure the Scheduler and Monitoring services to run at startup.

Start Monitoring Service

Note

This article references <WebApp>/ as a placeholder for the application’s install location. The default install location is /opt/Exago/; however, this directory may be changed during installation.

If the Web Application was installed, the Monitoring Service is also installed, but is disabled by default. This script created during installation needs to be started manually or configured to run at startup:

<WebApp>/MonitoringService/startService.sh

Dependencies

The Exago installer handles the installation and configuration of all of its own dependencies. Installing and configuring dependencies ahead of time is not required, and in some cases could lead to unexpected issues with the Exago deployment. This list is provided as a reference only. In most cases, Exago utilizes the most up to date versions available through the operating system’s package manager (i.e. apt, yum, zypper).

The Exago installer will display error messages if certain dependencies are not, cannot be or are not correctly installed.

Note

Not all of the packages listed below are installed for every operating system and situation.

• Installer requirements — for downloading files, adding repositories and installing GPG keys
  • curl
  • unzip
  • wget
  • yum-utils — only required on distributions that utilize the yum package manager
• Base .NET runtime — requirements for all Exago components
  • mono-4.0-service
  • mono-complete
• Datetime function support
  • mono-vbnc — used on Ubuntu and Debian only
  • mono-basic — used on Red Hat Enterprise Linux, CentOS, Fedora and SUSE Linux Enterprise Server
• Export support
  • Any font package such as liberation fonts or croscore fonts (chromium installed fonts will also work)
• Apache web server support
  • apache2-mod_mono (libapache2-mod-mono)
  • mono-apache-server
• Puppeteer — support for headless chart rendering in exported files
  • alsa-lib
  • atk
  • chromium
  • cups-libs
  • gconf2
  • gtk3
  • libasound2
  • libatk-bridge2.0-0
  • libgtk-3-0
  • libnss3
  • libx11-xcb1
  • libxcomposite
  • libxcursor
  • libxdamage
  • libxi
  • libxscrnsaver
  • libxrandr
  • libxtst6
  • libxss1
  • nss
  • pango
  • xorg-x11-fonts-75dpi
  • xorg-x11-fonts-100dpi
  • xorg-x11-fonts-cyrillic
  • xorg-x11-fonts-Type1
  • xorg-x11-fonts-misc
  • xorg-x11-utils
• NGINX web server support
  • mono-xsp4
  • xsp
  • mono-fastcgi-server4