Software installation prerequisites

Before you start installing API Portal as a software installation, you must meet the following requirements.

Hardware requirements

The minimum hardware requirements are:

  • 2 Ghz Dual Core Intel Core or AMD Opteron or faster
  • 8 GB RAM
  • 40 GB free disk space
Note   Installing API Portal dependencies requires an Internet connection. Offline installation is not currently supported.

Software requirements

API Portal has the following requirements for software components.

Operating system

You must have Red Hat Enterprise Linux (RHEL) 7 or CentOS 7 installed.

Database

You must have one of the following installed:

  • MySQL 5.6 or later
  • Note   API Portal does not officially support MySQL 8 as Joomla! does not support it. However, API Portal has been tested to work with MySQL 8 using a workaround. You must apply the workaround described at Joomla! and MySQL 8 before you install API Portal.
  • MariaDB 5.5.50 or later
  • Amazon RDS for MySQL

For details how to install a database using yum, see the following:

If your database is on a remote host, you must configure a MySQL client or a MariaDB client.

For more details, see following product documentation:

PHP

API Portal requires PHP 5.4 or later, but Joomla! recommends PHP 5.6 or PHP 7.0.

Note   Joomla! shows a warning message for earlier PHP versions. You can safely ignore this warning message if you do not want to update your PHP version.

In addition you must have the following PHP modules installed:

  • mod_php
  • php-common
  • php-mysqlnd
  • php-cli
  • php-gd
  • php-mcrypt
  • php-intl
  • php-mbstring
  • php-pdo
  • php-xml
  • php-json

Install without php-mcrypt

The dependency on the php-mcrypt extension has been removed in the latest service pack (SP2 and later) for API Portal. To install API Portal without installing php-mcrypt, modify the apiportal_install.sh file:

  1. Change to the directory where you extracted the API Portal installation package.
  2. Open apiportal_install.sh for editing.
  3. Locate the following line:
  4. yum --nogpgcheck -y  localinstall rhel-apache-conf-7.6.2-1.x86_64.rpm
  5. Change the line to:
  6. rpm -ivh --nodeps rhel-apache-conf-7.6.2-1.x86_64.rpm
  7. Run the updated installation script to install API Portal.
  8. After the installer completes, install the latest API Portal service pack.

Other software

API Portal requires the following to be installed:

  • API Gateway 7.6.2
  • API Manager 7.6.2
  • Apache 2.4 or later
  • OpenSSL

The monitoring feature of API Portal, which enables your API consumers to monitor application and API usage, also requires the following software:

  • API Gateway Analytics 7.6.2 (and an appropriate metrics database)

Examples of dependencies in a minimal OS installation

The following are examples of the dependencies API Portal installs on a minimal RHEL 7.

If you are installing API Portal on an air-gapped server, or your environment only allows installing components from a curated local repository, you can use these lists to ensure that you have all the required packages downloaded and installed on the server, or approved and made available on the curated repository.

Dependencies with Apache

  • rhel-apache-conf
  • libXpm
  • libtool-ltdl
  • mod_ssl
  • t1lib

Dependencies with MySQL

  • mysql-community-libs
  • mysql-community-libs-compat
  • mysql-community-server
  • mysql-community-client
  • mysql-community-common
  • perl
  • perl-Carp
  • perl-Encode
  • perl-Exporter
  • perl-File-Path
  • perl-File-Temp
  • perl-Filter
  • perl-Getopt-Long
  • perl-HTTP-Tiny
  • perl-PathTools
  • perl-Pod-Escapes
  • perl-Pod-Perldoc
  • perl-Pod-Simple
  • perl-Pod-Usage
  • perl-Scalar-List-Utils
  • perl-Socket
  • perl-Storable
  • perl-Text-ParseWords
  • perl-Time-HiRes
  • perl-Time-Local
  • perl-constant
  • perl-libs
  • perl-macros
  • perl-parent
  • perl-podlators
  • perl-threads
  • perl-threads-shared

Dependencies with PHP 5.6 or later

  • php56w
  • php56w-mbstring
  • php56w-opcache
  • apr
  • apr-util
  • httpd
  • httpd-tools
  • mailcap
  • php56w-cli
  • php56w-common
  • openssl
  • openssl-libs

Dependencies with php-mcrypt

  • php56w-mcrypt
  • libtool-ltdl
  • php56w-common

Related Links