The Apiary is delivered as an executable web application in .RUN format.
Connection to web application is carried out via any latest browser.
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 |
Before installation, prepare a virtual machine or server with one of the supported operating systems:
Some Linux distributions in minimal installation may not include the following utilities: curl
, find
, groupadd
, tar
, gzip
, useradd
, xargs
. However, these utilities are used in the Platform, and we recommend you to install them.
Install Docker engine and Docker-compose standalone on the server or virtual machine.
Note: the following utilities currently are not supported:
Docker compose
,Docker rootless
, andDocker from snap
.
To extract installation files from the supplied image for verification, perform the following steps:
Run the command (root privileges required):
bash ./install_hw_fh_en-US_<version>.run --noexec --target </your/new/directory>
where, </your/new/directory>
– the directory where the installation files will be extracted;
*.tar
files – container images;ascii-logo.txt
– logo that is displayed in the console during installation;bin.tgz
– bash scripts for extracting to /opt/hw-fh/bin
;installer
, installer.sh
, common-functions.sh
, load-images.sh
– installer (bash script);defaults.ini
– global settings of the platform (is copied to /opt/hw-fh/config
);user-template.ini
– list of all settings supported by current version (is copied to /opt/hw-fh/config
);systemd.tgz
– service systemd (is copied to /opt/hw-fh/systemd
);ssl.tgz
– self-signed SSL-certificates (are copied to /opt/hw-fh/qssl
, /opt/hw-fh/fssl
, /opt/hw-fh/dpssl
, but only during first installation);kb.tgz
- pre-installed report templates and vulnerability descriptions.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>
Execute the following command to grant all the necessary permissions to the installation file (optional):
chmod +x ./install_hw_fh_en-US_<version>.run
To start installation, run the command:
bash ./install_hw_fh_en-US_<version>.run
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>'
Open the Platform in the browser by the address specified in the message: https://<ip-server>/
.
Note: the following settings are required if you want to create connection between Hive and Apiary projects.
/opt/hw-fh/config/user.ini
(root privileges required);Add the following lines to the [main]
section:
[main]
; rabbitmq port:
rmq.client.port = 5672
; DNS name or IP address of the machine you install Apiary to:
rmq.client.host = <my-apiary.example.com>
Note: you can also configure secure connection for RabbitMQ. See section SSL certificates in Apiary
To apply settings, run the following command (root privileges required):
/opt/hw-fh/bin/reconfig
Open the Platform in the browser by the address: https://<ip-server>/
.
To update Platform:
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>
Run the command:
bash ./install_hw_fh_en-US_<version>.run
During the update process, Platform will be saved to a backup and then the latest updates will be installed.
Notes:
- Platform backups are saved to the
/opt/hw-fh_backup
folder;- The Platform stores only the three latest backups.
When installation completes, Platform will start automatically.
Note: after installation of updates, connection between Hive and Apiary projects should restore automatically, however it may take some time. If connection did not restore, see section Apiary troubleshooting.
The default passwords of the root user is generated automatically 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:
/opt/hw-fh/bin/show-info
You can change the display language for Apiary using the localization files provided. To achieve that you need to do the following:
Create a new directory on the server where the localization files will be stored, e.g.
mkdir /opt/language
Open the /opt/hw-fh/config/user.ini
file using the command (root privileges required), e.g.
nano /opt/hw-fh/config/user.ini
Add the following parameter to the file and specify the path to the folder:
f.deck.languages.dir = /opt/language
/opt/hw-fh/config/user.ini
file;To apply changes, run the command:
/opt/hw-fh/bin/reconfig
After that you will be able to change the display language for Apiary:
On the main login page:
When you go to User > Profile: