Install API Portal software

This section describes the steps to install API Portal as a software installation.

Before you start, ensure you have performed the actions in Prerequisites and Configure the database server.

Install API Portal software

  1. Download the installation package for your OS from the Axway Support at, and upload it to your host machine.
  2. Log in to the host machine as the root user.
  3. Extract the installation package:
  4. # tar xpvzf <package>.tgz

  5. Run the install script:
  6. # sh

  7. Enter the connection details for your database connection. The default port is 3306 but you can use a different one if needed. The database user is the user you created for API Portal. See Configure the database server.
  8. When propmted on installing Redis, confirm the installation if you want to use the Redis cache with API Portal.
  9. When prompted on installing additional dependencies, confirm their installation.
  10. To configure the SE Linux, enter the following commands:
  11. setsebool -P httpd_read_user_content 1

    setsebool -P httpd_can_network_connect 1

    setsebool -P httpd_can_network_connect_db 1

    setsebool -P httpd_unified 1

    chcon -R -t httpd_sys_content_t /opt/axway/apiportal/htdoc/

    semanage fcontext -a -t httpd_sys_rw_content_t '/opt/axway/apiportal/htdoc(/.*)?'

    restorecon -R -v '/opt/axway/apiportal/htdoc'

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. If prompted to select the installation method, select Installation via Directory, select the package from the 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.

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 (https://<API Portal host>) and verify that the installation succeeded, you must link API Portal to API Manager. For more details, see Connect API Portal to a single API Manager.
  • In addition, there are some configuration steps you must perform to protect your API Portal configuration. For more details, see Configure API Portal.
Note   When you create a new menu from JAI, there might be an issue with the menu path (the menu path is broken and some additional paths are added as part of the URL). To fix this issue you have to rebuild the menu paths. Navigate to JAI > Menus > Main Menu and click the Rebuild button. This should be performed only once after installation.

Related Links