anyLogistix Professional Server was tested on Ubuntu 18.04 LTS, 20.04 LTS, and 22.04 LTS.

Before installing anyLogistix Professional Server:

• Check the system requirements. The maximum amount of RAM anyLogistix can occupy is configurable.
• Check that your primary server (to which you install anyLogistix Professional Server) has a static IP address. If you want your instance to have a dynamic IP address, you should configure a DNS server for domain name resolution.
• Install the Team License Server. It is an application that manages team licenses for all AnyLogic products (AnyLogic, anyLogistix, and AnyLogic Cloud) used within the company. When it is up and running you will be able to use Team license, which is required to complete the installation (perpetual and subscription types of licenses are available).
  All user licenses for the anyLogistix Professional Server are handled by the Team License Server only.
• Ansible is required. If it is missing from your system, the installer will not start.
  Ansible is used in anyLogistix server installer to eliminate the inconvenient interaction with the docker-compose.yml file. Instead, it provides the ability to configure the application through the more user-friendly Ansible framework.

The installation procedure comprises a set of steps that are sequentially executed on the target equipment (this can be either the server, on which the installer is running, or some other equipment that is accessible from the host). All of this is wrapped into an ansible role, which can be executed with different tags to achieve various installer behavior.

The installer can be run in the default mode or one of the custom modes.

Ansible is run via the console. Therefore, the installer will also require a console to run. It is assumed that the user already has Ansible installed on their machine.

To install the application

1. Obtain the archive with the installer by doing either of the following:
   • Click the direct download link.
   • Download it using wget:

     sudo wget https://www.anylogistix.com/upload/builds/releases/alx3/linux64/anylogistix-pro-server-setup.tar.gz

2. Extract the archive (the archive will be extracted into the folder with the same name):

   tar -xvzf anylogistix-pro-server-setup.tar.gz

3. Navigate into that folder:

   cd anylogistix-pro-server-setup

4. Specify the server, to which anyLogistix must be installed. This can be the same server, on which you have unpacked the installer or any other server:
   • To install the application on the same server you can either edit the playbook file or create the inventory file with the advanced settings:
     • To edit the playbook file open it in the vim or any other editor: vim install_server_alx.yml
     • Change the hosts: all to hosts: localhost:

       ---
       - name: Server Install
         become: true
         hosts: localhost
         roles:
           - install_server_alx

       Now, the installer will always target localhost.

   • To create a new inventory file with the default description for localhost directly in the folder:

     cat > inventory.yml << 'EOF'
     ---
     all:
       hosts:
         localhost:
           ansible_connection: local
           ansible_python_interpreter: "{{ ansible_playbook_python }}"
     EOF

     The resulting inventory.yml file will be used in all commands when interacting with the installer. For example:

     sudo ansible-playbook install_server_alx.yml -i inventory.yml
5. If the application must be installed on a different server, create an inventory file and specify all the connection settings for the required server.
6. Run the installer:

   sudo ansible-playbook install_server_alx.yml

   Alternatively, it can be run with the e.g., silent tag:

   sudo ansible-playbook install_server_alx.yml --tags silent

7. If required, answer the questions as the installer guides you through the installation steps.

The installer has 2 modes:

• Default mode — runs without tags.
• Custom mode — runs with one of 6 tags. Each tag implies a different sequence of steps aimed at performing specific action on the application:

  It is not recommended to use more than one tag in a single ansible-playbook run.

  • Silent — does not require user attention during installation.
  • Reconfigure — changes settings in the already installed application.
  • Uninstall — removes the installed application.
  • Start — starts the application.
  • Stop — stops the application.
  • Restart — restarts the application.

The default mode presupposes setting up the installation parameters as the installer moves on from one step to another. User attention is required during installation.

Installation steps in the default mode

1. Check if the application is already installed:
   • If it is installed, update it to the latest version.
   • If it is not installed, start the installation process.
2. Check if Docker is installed on the machine.
3. The user must accept the SLA.
4. Select the workspace folder.
5. Configure database connection.
6. Configure proxy settings, if required.
7. Configure SSL certificates, if required.
8. Check the availability of ports for the database and frontend.
9. The docker-compose.yml file is generated based on user-provided values.
10. Install Docker (if it's not already installed).
11. Pull application images.
12. Launch the application.
13. Wait for the application to fully start.
14. End of the procedure.

To install the application in the silent mode use the silent tag.

In this mode all default values for configuring the docker-compose.yml file are taken from the special constants file (~/installer_server_alx/defaults/main.yml). You can configure these constants before running the installer. They will be applied when the file is created.

Installation steps with the silent tag

1. Check if the application is already installed:
   • If it is installed, update it to the latest version.
   • If it is not installed, start the installation process.
2. Check if Docker is installed.
3. Automatically accept the SLA.
4. Check the availability of ports for the database and frontend.
5. Assemble the docker-compose.yml file from the values specified in the file.
6. Install Docker (if it's not already installed).
7. Pull the application images.
8. Start the application.
9. Wait for the application to fully start.
10. End of the procedure.

To change the settings of the already installed application use the reconfigure tag.

If the application is not installed the installer will exit with a message prompting the user to install the application.

Installation steps with the reconfigure tag

1. Check if the application is already installed:
   • If it is already installed, start the reconfiguration process.
   • If it is not installed, exit with a message prompting the user to install the application.
2. Gather the current configuration settings of the already installed application from the docker-compose.yml file.
3. Change the workspace folder if necessary.
4. Configure a new database connection if necessary.
5. Configure the proxy settings if necessary.
6. Configure SSL certificates if necessary.
7. Check the availability of ports for the database and frontend.
8. Assemble the docker-compose.yml file from the specified values.
9. Start the application.
10. Wait for the application to fully start.
11. End of the procedure.

To remove the application from the server, for which the installer is run use the uninstall tag.

Additionally, you can remove:

• The database data, if the default (internal) database is used.
• The Docker, if it was installed by the installer (and not by the user).

Installation steps with the uninstall tag

1. Check if the application is already installed:
   • If installed, start the uninstallation process.
   • If it is not installed, the installer exits.
2. Request for the user to confirm that the application must be uninstalled.
3. Gather the current configuration settings of the already installed application from the docker-compose.yml file.
4. Stop the application if it is running.
5. The user confirms the removal of Docker (if it was installed by the installer).
6. The user confirms the removal of the database (if the internal database was used).
7. The application is removed.
8. End of the procedure.

To start / stop / restart the installed application use the corresponding start / stop / restart tag.

Installation steps with the start / stop / restart tags

1. Check if the application is already installed:
   • If installed, start the installer with the corresponding process.
   • If not installed, the installer exits.
2. Find the folder containing the installed application.
3. Execute the corresponding command (start / stop / restart the application).
4. Wait for the application to fully start / stop.
5. End of the procedure.

To determine if the application is already installed on the machine, we will use the alxtab file (a file used by the installer to track application installation status), which is created in case of:

• Successful installation of the application via the default mode or with the silent tag.
• Successful reconfiguration of the application via the reconfigure tag.

The file can only be deleted if the application is successfully uninstalled via the uninstall tag.

The file is expected to reside in the /etc/ directory. The installer will search for it there. If the file cannot be found in the /etc/ directory, the installer will assume that the application is not installed. The file may not be in the directory, but the application may still be installed (e.g., the application was installed manually). In this case, contact our support team to help you transition to the new installer without losing data.

How can we improve this article?

Send