Install API Portal as virtual appliance installation

This section describes how to perform a new API Portal virtual appliance installation. The installation process has the following steps:

  1. Prerequisites
  2. Install API Portal and the virtual appliance
  3. Install Joomla! components
  4. Verify the installation
  5. Post-installation steps
Note   API Portal 7.5.4 does not include an OVA image for installing a virtual appliance. If you are a new user starting from v7.5.4, you must install API Portal 7.5.3 OVA image, and then upgrade API Portal to v7.5.4. The installation instructions for the v7.5.3 OVA image are the same as described in this topic. For details on upgrading API Portal, see Upgrade existing API Portal installation.

Prerequisites

This section describes the minimum requirements for the machine running the virtual machines in your production and development environments.

Notes

  • The VMware image is created on VMware ESX and runs on VMware ESX Server 3.0 or higher.
  • The OS is a SUSE Linux Enterprise Server 11.3 (x86_64).

Production environment

The following are the minimum recommended requirements for your production environment:

Hardware requirements

  • CPU: 3 Ghz, P4 equivalent
  • RAM: 8 GB
  • HHD free space: 60 GB

VM characteristics

  • vCPU: 2
  • RAM: 4GB
  • HDD: 50GB

Development environment

The following are the minimum recommended requirements for your development environment:

Hardware requirements

  • CPU: 3 Ghz, P4 equivalent
  • RAM: 4 GB
  • HHD free space: 40 GB

VM characteristics

  • vCPU: 2
  • RAM: 2GB
  • HDD: 30GB

Install API Portal and the virtual appliance

Install the Axway virtual appliance as described in Install your Axway virtual appliance and product in the API Gateway Appliance Installation and Administration Guide. This also installs your API Portal, and when you start the appliance, API Portal automatically starts.

Install Joomla! components

You must also install the EasyBlog and EasyDiscuss components, if you plan to use them.

  1. Log in to the Joomla! Admin Interface (JAI) (https://<API Portal host>/administrator) using the default Joomla! administrator credentials.
  2. Note    
    • Contact your Axway Account Manager to retrieve the default administrator credentials. It is mandatory that you change these credentials when you first log in.
    • If after the installation you experience difficulties with the Joomla! administrator password, you can try to reset the password. For more details, see How do you recover or reset your admin password?
  3. Click Components > EasyBlog, and follow the instructions in the EasyBlog installer.
  4. Select Installation via Directory, select com_easyblog_5.0.44_component_pro.zip from the Select Package drop-down list, and follow the instructions in the installer to the finish.
  5. Note   Do not install any of the modules and plugins unless you plan to use them. To prevent installing any modules, click Modules and deselect Select All, then repeat the same for Plugins.
  6. Click Components > EasyDiscuss, and repeat the component installation as described for EasyBlog. In Select Package, select com_easydiscuss_4.0.13_component_pro.zip from the drop-down list.
  7. Note   Do not install any of the modules and plugins unless you plan to use them. To prevent installing any modules, click Modules and deselect Select All, then repeat the same for Plugins.

Verify the installation

After the installation, configure your virtual appliance as needed. At minimum, it is recommended to change the default passwords and certificates. For more details, see Get started with the API Gateway Appliance in the API Gateway Appliance Installation and Administration Guide.

In addition, you must log in to JAI and verify that the API Portal configuration tools work.

Post-installation steps

  • Before you start configuring your API Portal, check if there are any updates available for your installation and install them. For more details, see Update API Portal.
  • Before you can use your API Portal, you must link API Portal to API Manager. For more details, see Link API Portal to API Manager.
  • Before you can use a secure connection to access API Portal using the URL rather than the IP address, you must ensure that the fully qualified domain name (FQDN) of the appliance matches the API Portal hostname the Apache certificate uses. For more details, see Update the API Portal hostname for secure connections.
  • It is recommended to secure the connection between API Portal and the remote MySQL database. For more details, see Configure the database server for secure connection.
  • In addition, there are some configuration steps you must perform to protect your API Portal configuration. For more details, see Configure API Portal.

Related Links