Skip to main content
Version: 7.1

Installation

ASM is a Java web application that is installed via a Docker container package.

Note: The instructions below refer to a fresh installation of ASM. In case you already have a version of ASM installed in your system, please refer to chapter Upgrade to the section that corresponds to your current ASM version.

Installing the application​

  1. Extract the ASM distribution .zip file to the folder from where you want to run ASM.

  2. Navigate to the docker/ folder of the extracted distribution.

  3. Open the file credentials.txt in a text editor.

  4. Update the placeholder values for Access key ID and Secret access key with the values provided by Axiomatics. (These are the same values that were used in setting up AWS CLI.)

  5. Save and close credentials.txt.

  6. Copy a valid ASM license file to the docker/ folder. (This file is provided separately by Axiomatics.)

  7. Run docker-compose -f docker-compose.yml -f docker-compose.dashboard.yml up --build on the same folder. This starts the installation process.

    Important: The docker-compose installation process uses the overriding functionality of Docker Compose for multiple compose files. The Compose files arguments order should be kept as is in the installation command.

    Note: This step of the installation requires an Internet connection as some components will be downloaded from a secure Axiomatics repository during the process.

Installing ASM without the Dashboard functionality​

The start-up command for ASM given above also starts an instance of InfluxDB, which is required for the Dashboard functionality. If needed, this functionality can be disabled and ASM started and run without including an InfluxDB instance.

Replace the command in step 7 with the command docker-compose up --build. This starts ASM without InfluxDB and with the Dashboard functionality disabled.

Stopping ASM​

Note: The command for stopping ASM is different depending on whether ASM is running with the Dashboard functionality enabled or not.

ASM is running with the Dashboard functionality enabled​

In the console, navigate to the docker/ folder and issue the command docker-compose -f docker-compose.yml -f docker-compose.dashboard.yml stop.

ASM is running with the Dashboard functionality disabled​

In the console, navigate to the docker/ folder and issue the command docker-compose stop.

Restarting ASM​

Note: The command for restarting ASM is different depending on whether ASM is should run with the Dashboard functionality enabled or not.

Restarting ASM with the Dashboard functionality enabled​

In the console, from the docker/ folder, issue the command docker-compose -f docker-compose.yml -f docker-compose.dashboard.yml up.

Restarting ASM with the Dashboard functionality disabled​

In the console, from the docker/ folder, issue the command docker-compose up.

Data persistence using volumes​

ASM implements volumes for externalizing the data state, that is, ensuring the persistence of data generated by and used by Docker containers.

No further configuration is necessary. If more information is needed, please refer to the section Use volumes of the Docker documentation for more information.

Note: Volumes do not create a folder on the host machine, but are managed by Docker commands. See the section Backup, restore, or migrate data volumes of the Docker documentation for more information about all the possible user actions like deletion, backups, restore, migration, etc.

Logging in to ASM​

After the installation has finished, open a web browser window and go to https://localhost/asm.

This will access the login page for ASM.

  • Default username: asm-admin

  • Default password: password

You will immediately be prompted to change the password, and when that is done you are logged in to ASM for the first time.

Next steps​

Adding users​

During the installation, a Keycloak service is also installed, to serve as an authentication module for the users of ASM.

Only a default administrative user is created automatically at this time. All other users must be created and assigned a role in Keycloak, before they can log in to ASM. (See Access Control for more information about roles).

To add more users, the system administrator must use Keycloak to create that user and map the user to a role. For more information, see Appendix: Managing users in Keycloak and Users.

Additional configuration​

Once the installation of ASM has been verified as successful, there are additional configurations you may want to consider for your implementation of ASM.