Install API Portal software

This section describes the steps to install the API Portal software.

Install API Portal software

Caution   If you plan to apply API Portal 7.6.2 Service pack 2 or later after the installation, you must follow the steps in Install API Portal without dependencies to manually install its dependencies.
  1. Download the installation package for your OS from 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 database server.
  8. When asked to create an encryption key directory, type Y (yes) if you want to encrypt the Public API user password and specify a directory to store the encryption key. If you type N (no), you can use a script to encrypt the password later. For more details, see Encrypt the Public API user password (optional).
  9. Note   The directory is created along with a file. The last segment of the directory is the file name. For example: /sample/directory/for/encryption/key creates an empty file named "key" in the desired directory.
  10. When prompted on installing additional dependencies, confirm their installation.
  11. To configure the SE Linux, enter the following commands:
  12. 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.

  1. Log in to the Joomla! Administrator 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.
Note   To resolve a known issue (caused by EasyBlog) with broken menu paths when creating new custom menus for your API Portal in JAI, you must rebuild the menu paths. In JAI, select Menus > Main Menu and click Rebuild. You only need to rebuild the menu paths once after installation or upgrade.

Related Links