Apiary System Requirements and Installation

The Apiary is delivered as an executable web application in .RUN format.

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 GB 13 GB
CPU 2 cores 3 cores
Disk speed 50 IOPS 100 IOPS
Disk size 65 GB 90 GB

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.

Apiary installation

  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 (optional):

    chmod +x ./install_hw_fh_en-US_<version>.run
    
  4. To start installation, run the 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):

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

Platform backups

To back up the Platform, copy and zip the folder /opt/hw-fh to any directory.

To restore data from backup, unzip the folder /opt/hw-fh and copy it to the server.

Installation of updates

To update Platform:

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

    scp install_hw_fh_en-US_<version>.run </server/path>
    
  3. Run the command:

    sudo ./install_hw_fh_en-US_<version>.run
    

During the installation of the updates, Platform will be automatically stopped, saved to a backup and only then the latest updates will be installed.

Notes: 1. Platform backups are saved to the /opt/hw-fh_backup folder; 1. The Platform stores only the three latest backups.

After the installation of updates Platform will start automatically. All Platform settings (like passwords, connection settings, etc.) will remain the same.

Note: after installation of updates, connected projects (Hive and Apiary) should automatically restore connection, however it may take some time. If connection did not restore, see section Apiary troubleshooting.

Default passwords

The default passwords of the root user is generated during the installation and saved to the file /opt/hw-fh/config/local.ini. You can view the default password of the administrator using the command:

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

See also