. . .

Installation

The documents in this section outline all the necessary steps for the installation of ApiOmat .

All supported operating systems can be found at the requirements page. Then, before running ApiOmat , kindly set up your operating systems as outlined on our System preparations page.

General definitions and conventions

Variables

The installation manuals use some variables, which have a different meaning between operating systems. The following table will explain the specific value:

Variable

Linux

Windows

%INSTALL_PATH

/opt/aom-<SERVICENAME>

Place where the user extracted the installation package

%CONFIG_PATH

/etc/apiomat/aom-<SERVICENAME>

%INSTALL_PATH\config or %INSTALL_PATH

%LOGGING_PATH

/var/log/apiomat/aom-<SERVICENAME>

Windows Event Log

Users and Groups

On Linux installations, e ach service will run under its own user name. Most of the times, the username corresponds to aom-<SERVICENAME>. The user and its group, apiomat, is created during installation and removed after uninstallation. Common paths like /etc/apiomat and /var/log/apiomat are owned by the group, while all other (sub-)directories are owned by the service user.

On Windows installations, services started via the services tool are running as system user.

Next steps

  1. Install MongoDB

  2. Install Consul

  3. Install YAMBAS

  4. Install Dashboard

  5. Install Lurker (optional)

After installation

Finally, after completing your installation, review the next steps:

Common (all operating systems)

  • Configure Hazelcast

  • Obtain a license key and insert it into apiomat.yaml

  • Create SuperAdmin by sending a POST request to /yambas/rest/initSuperAdmin with form parameters "email" and "password" (not necessary when using the graphical installer)

    • e.G.: curl -X POST http://localhost:8080/yambas/rest/initSuperAdmin -d "email=apinaut@apiomat.com&password=secret"
  • Change Default Organization password in apidocs

  • Harden your installation

  • Remove or set up firewall rules for the installer and admin webapp from Tomcat container

  • Run the graphical installer

Please visit the FAQ section for questions and solutions.

Linux only

You can activate the backup script for the restore module by executing chmod a+x /etc/cron.daily/restoreModule on each application server