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. Install Docker engine and Docker compose.

Installing Apiary

  1. Download the installation files from hexway.io;
  2. Copy the installation file install_hw_fh_en-US_0.18.1.run to the server using any SSH file transfer client;
cp install_hw_fh_en-US_0.18.1.run </server/path>
  1. Execute the following command to grant all the necessary permissions to the installation file:
chmod +x ./install_hw_fh_en-US_0.18.1.run
  1. To start installation run command:
sudo ./install_hw_fh_en-US_0.18.1.run
  1. 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>'
  1. Edit file /opt/hw-fh/config/user.ini (root privileges required). Add lines to the [main] section:
rmq.client.port = 5672
rmq.client.host = my-apiary.example.com

Use DNS name or IP address of the machine you install Apiary to.

  1. Run (root privileges required):
/opt/hw-fh/bin/reconfig

to apply the configuration changes.

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

See also