Apiary System Requirements and Installation

The Apiary is delivered as an executable web application in .RUN format. The Platform supports such Linux platforms as Ubuntu and Debian.

Connection to web application is carried out via any latest browser.

Apiary hardware requirements

The following are the estimated system requirements:

Description Minimal Requirements Recommended Requirements
RAM 8 GiB 13 GiB
CPU 2 cores 3 cores
Disk speed 50 IOPS 100 IOPS
Disk size 65 GiB 90 GiB

Preparing for installation

Before installation, prepare a virtual machine or server with one of the supported operating systems:

  • CentOS 8
  • RHEL 8
  • Ubuntu 18.04
  • Ubuntu 20.04

Install Docker engine and Docker compose.

Install cifs-utils to mount remote directories using cifs (smb) protocol:

sudo yum install cifs-utils

Installing Apiary

  1. Download the installation files from hexway.io;
  2. Copy the installation file install_hw_fh_en-US_<version>.run to the server using any SSH file transfer client;

    scp install_hw_fh_en-US_<version>.run </server/path>
  3. Execute the following command to grant all the necessary permissions to the installation file:

    chmod +x ./install_hw_fh_en-US_<version>.run
  4. To start installation run command:

    sudo ./install_hw_fh_en-US_<version>.run
  5. After installation, you will get the following message:

    hexway Apiary ready to use.
    UI accessible on http://<ip-server> or https://<ip-server>
    Login as '<username>' password: '<password>'
  6. Edit file /opt/hw-fh/config/user.ini (root privileges required). Add lines to the [main] section:

    rmq.client.port = 5672 // rabbitmq port
    rmq.client.host = <my-apiary.example.com> // DNS name or IP address of the machine you install Apiary to.
  7. To apply the configuration changes run the following command (root privileges required):

  8. Open Platform in the browser by the address https://<your-server-ip-or-dns>/.

Default passwords

The password of the administrator is generated during the installation. You can view the default password of the administrator using the command:

sudo /opt/hw-fh/bin/show-info

Default passwords are saved to the file /opt/hw-fh/config/local.ini.

See also