Skip to main content

Designer Docker Images

Several Designer tools are available as Docker images that can be retrieved from Docker Hub. These containerized versions provide the same functionality as the tools integrated within the Designer environment, allowing for flexible deployment and automation scenarios.

For all tools, the project to be analyzed must be mounted as a volume in the container to provide access to your source code and project files.

When pulling these images, you must specify the exact core version from which the images should be obtained. This ensures compatibility and consistent behavior with your specific Designer version.

Important Version Notice​

Warning: These Docker images do NOT provide latest tags or version grouping (such as 2025.x or 2024.x). You must always specify the exact, complete version number when pulling images.

This means for any image:

  • adito/<imageName>:latest - Not available
  • adito/<imageName>:2025.x - Not available
  • adito/<imageName>:2025 - Not available
  • adito/<imageName>:2025.2.0 - Correct format, general release version that should be used for all systems
  • adito/<imageName>:2025.2.0_TEST1 - Correct format, Test version for internal usage
  • adito/<imageName>:2025.2.0_RC1 - Correct format, release candidate for internal usage

This ensures reproducible builds and deployments, prevents unexpected behavior from automatic updates, maintains compatibility between different tool components, and allows precise control over the toolchain version. Always check the available tags on Docker Hub and specify the complete version number that matches your Designer core version.

Scan Services (aditotasks)​

Starting from core version 2024.1.0, the adito/aditotasks image is available, which analyzes the Scan Services within a project. This tool performs comprehensive code analysis and quality checks.

Basic Usage​

You need to mount the project directory as a volume in the container under the /repo/package directory. This ensures that the tool has access to the source code and project files.

You do not need to set any environment variables for this container.

docker run -v <myProject>:/repo/package adito/aditotasks:<version>

Practical Example​

For a project located at /home/user/projects/xrm that should be analyzed using Scan Services from version 2025.2.0, the command would look like this:

docker run -v /home/user/projects/xrm:/repo/package adito/aditotasks:2025.2.0

Exit Codes​

The Scan Services tool returns various exit codes to indicate the analysis status:

  • 0: No warnings or errors found — analysis completed successfully
  • 201: (may also include warnings) — immediate attention required
  • 202: Only warnings present, no errors — review recommended
  • 150: A Java exception occurred during analysis — technical issue
  • 140: Project path not specified — command line error
  • 141: Specified project path does not exist — path validation error

Transpile​

The adito/aditotranspile image enables project transpilation, converting your source code into the target format required for deployment.

This tool is needed for modularized projects, to convert the source code into a format that can be deployed to a target environment.

Prerequisites​

Before using the transpile tool, you must ensure that npm install has been executed for the project to install all necessary dependencies. This step is crucial for the transpilation process to locate and include required node modules.

Basic Usage​

Mount the project directory as a volume in the container under the /repo/package directory to provide the tool with access to your source code and project files. Ensure the volume has write permissions, as the transpilation process requires write access to create output files in the dist directory.

No environment variables need to be configured for this container.

docker run -v <myProject>:/repo/package adito/aditotranspile:<version>

Practical Example​

For a project located at /home/user/projects/xrm that should be transpiled with version 2025.2.0, the command would look like this:

cd /home/user/projects/xrm
npm install
docker run -v /home/user/projects/xrm:/repo/package adito/aditotranspile:2025.2.0

You can see the transpiled output in the /home/user/projects/xrm/dist directory afterward.

Exit Codes​

The Transpile tool returns various exit codes to indicate the outcome of the transpilation process:

  • 0: Transpilation completed successfully — your project was converted without issues
  • 140: Project path missing — you must specify which project directory to transpile
  • 141: Project path invalid — the specified path either does not exist
  • 142: Invalid project directory — the specified source path does not contain a valid project
  • 150: Internal system error — a technical error occurred during the transpilation process

Deploy​

The adito/aditodeploy image facilitates project deployment to target environments.

Required Parameters​

The deployment process requires two essential components:

  1. --projecthome: The project to be deployed. For modularized projects, this should contain the dist directory.
  2. --serverconfig: Configuration file containing the database connection you want to deploy to.

Basic Usage​

Mount the project directory as a volume in the container under the /repo/package directory to provide the tool with access to your source code and project files.

No environment variables need to be configured for this container.

For this container, you need to call the ADITOdeploy script with the required parameters directly.

docker run -v <myProject>:/repo/package adito/aditodeploy:<version> /opt/ADITO/bin/ADITOdeploy \
  --projecthome /repo/package \
  --serverconfig /repo/package/data/config/serverconfig.xml

Practical Example​

Deploy a non-modularized project​

For a non-modularized project located at /home/user/projects/xrm that you want to deploy using version 2025.2.0, with the server configuration file at /home/user/projects/xrm/data/config/serverconfig_default.xml, use the following command:

docker run -v /home/user/projects/xrm:/repo/package adito/aditodeploy:2025.2.0 /opt/ADITO/bin/ADITOdeploy \
  --projecthome /repo/package \
  --serverconfig /repo/package/data/config/serverconfig_default.xml

Deploy a modularized project​

Modularized projects must be transpiled before deployment, as the Deploy tool does not perform transpilation automatically.

For modularized projects, specify the dist directory as the project home to ensure the transpiled output is deployed correctly.

For a modularized project located at /home/user/projects/xrm that you want to deploy using version 2025.2.0, with the server configuration file at /home/user/projects/xrm/data/config/serverconfig_default.xml, use the following command:

docker run -v /home/user/projects/xrm:/repo/package adito/aditodeploy:2025.2.0 /opt/ADITO/bin/ADITOdeploy \
  --projecthome /repo/package/dist \
  --serverconfig /repo/package/data/config/serverconfig_default.xml

Deploy to a local Docker database​

When deploying your project to a local database running in a Docker container, you need to ensure both containers can communicate with each other. This requires two important configuration changes:

  • Network Connection: Both the Deploy container and database container must be on the same Docker network using the --network parameter.
  • Database Configuration: In your serverconfig.xml file, use the database container's name as the host and the internal container port (not the exposed port visible in docker ps).

Example: If you have a MariaDB container like this:

$ docker ps --format "table {{.Image}}\t{{.Ports}}\t{{.Networks}}\t{{.Names}}"
IMAGE        PORTS                                         NETWORKS     NAMES
mariadb      0.0.0.0:3309->3306/tcp, [::]:3309->3306/tcp   db_default   db-mariadb-1

The container name is db-mariadb-1, the internal port is 3306 (not the exposed port 3309), and it's running on the db_default network.

Update your serverconfig.xml file to use the container name and internal port:

<node name="db alias">
    <map>
        <entry key="database" value="adito_system"/>
        <entry key="databasetype" value="12"/>
        <entry key="host" value="db-mariadb-1"/>
        <entry key="port" value="3306"/>
        <entry key="user" value="root"/>
        <entry key="password" value="mySecretPassword"/>
    </map>
</node>

Run the deploy-image with the same network:

docker run -it --network db_default --rm -v $(pwd):/repo/package adito/aditodeploy:2025.2.0 /opt/ADITO/bin/ADITOdeploy  \
  --projecthome /repo/package   \
  --serverconfig /repo/package/data/config/serverconfig_default.xml

Exit Codes​

The Deploy tool returns various exit codes to indicate the outcome of the deployment process:

  • 0: Deployment completed successfully — all operations finished without issues
  • 140: Project path not specified — you must provide the project directory path as a parameter
  • 141: Server configuration not specified — you must provide a server configuration file as a parameter
  • 142: Partial deployment failure — some data models could not be deployed successfully
  • 150: Internal system error — a Java exception occurred during the deployment process