Moderne websiteOpenRewriteGo to app →

All DX configuration variables

This document includes all of the variables you can configure the Moderne agent to run with. Your configuration will only use some of these.

Maven repository access variables

Variables:

  • MODERNE_DX_MAVEN_{index}_URL – The URL of your Maven repository.

  • MODERNE_DX_MAVEN_{index}_LOCALREPOSITORY – The path on disk where LST artifacts and Maven index files will be downloaded to. This is on the disk where the service is being run and not on the Maven instance. Defaults to ~/.moderne-maven

    • LST artifacts are deleted from this location after they are transmitted to Moderne. Index files will remain behind to be used to detect diffs in the artifacts. If changes are discovered, only the incremental diffs will be downloaded (to limit the amount of data being transferred).

    • If multiple Maven repositories are configured on the service, they must have different MODERNE_DX_MAVEN_{index}_LOCALREPOSITORY configured.

  • MODERNE_DX_MAVEN_{index}_USERNAME – (Optional) The username used to resolve artifacts. Defaults to null.

  • MODERNE_DX_MAVEN_{index}_PASSWORD – (Optional) The password used to resolve artifacts. Defaults to null.

  • MODERNE_DX_MAVEN_{index}_RELEASES – (Optional) Specifies whether or not this repository should be searched for releases. Defaults to true.

  • MODERNE_DX_MAVEN_{index}_SNAPSHOTS – (Optional) Specifies whether or not this repository should be searched for snapshots. Defaults to true.

  • MODERNE_DX_MAVEN_{index}_ASTSOURCE – (Optional) Specifies whether or not this repository should be searched for LST artifacts. Defaults to true (Note: LSTs used to be called ASTs).

  • MODERNE_DX_MAVEN_{index}_RECIPESOURCE – (Optional) Specifies whether or not this repository should be searched for recipe jars. Defaults to true.

  • MODERNE_DX_MAVEN_{index}_SKIPSSL – (Optional) Whether or not to skip SSL/TLS verification for calls from the service to this Maven repository. This must be set to true if you use a self-signed SSL/TLS certificate. Defaults to false.

  • MODERNE_DX_MAVEN_{index}_SKIPVALIDATECONNECTIVITY– (Optional) By default, on startup dx we validate that it can connect to the configured resource, and fail to start up the dx if we cannot. Set this to true to skip this validation. Defaults to false.

Example:

docker run \
# ... Existing variables
-e MODERNE_DX_MAVEN_0_URL=https://myartifactory.example.com/artifactory/libs-releases-local \
-e MODERNE_DX_MAVEN_0_LOCALREPOSITORY=~/.moderne-maven \
-e MODERNE_DX_MAVEN_0_USERNAME=admin \
-e MODERNE_DX_MAVEN_0_PASSWORD=password \
# ... Additional variables

Artifactory LST variables

Variables:

  • MODERNE_DX_STORAGE_ENABLED - Enables persistent storage for the LST index. Defaults to false.

  • MODERNE_DX_STORAGE_PATH - The path of the LST index directory on the container or local disk. Defaults to <dx configuration directory>/storage (<dx configuration directory> refers to the location where all configuration for DX lives, including the recipe catalog, tokens, etc. It's not configurable.

  • MODERNE_DX_ARTIFACTORY_{index}_URL – The URL of your Artifactory instance.

  • MODERNE_DX_ARTIFACTORY_{index}_USERNAME – The username used to connect to your Artifactory instance. This user must have permission to run AQL queries.

  • MODERNE_DX_ARTIFACTORY_{index}_PASSWORD – The password used to connect to your Artifactory instance.

  • MODERNE_DX_ARTIFACTORY_{index}_ASTQUERYFILTERS_{index} – The AQL query fragment used to select LST artifacts to send to Moderne. If multiple are specified, they are combined together with an AND.

  • MODERNE_DX_ARTIFACTORY_{index}_SKIPSSL – (Optional) Specifies whether or not to skip SSL verification for HTTP connections from the service to this Artifactory instance. This must be set to true if you use a self-signed SSL/TLS certificate. Defaults to false.

  • MODERNE_DX_ARTIFACTORY_{index}_SKIPVALIDATECONNECTIVITY– (Optional) By default, on startup dx we validate that it can connect to the configured resource, and fail to start up the dx if we cannot. Set this to true to skip this validation. Defaults to false.

  • MODERNE_DX_ARTIFACTSYNC_SINCE – (Optional) Specifies how long in the past to sync your artifacts. Defaults to syncing all time. It is recommended to set a start date of the sync or it will try to search your entire artifactory.

Example:

docker run \
# ... Existing variables
-e MODERNE_DX_STORAGE_ENABLED=true \
-e MODERNE_DX_STORAGE_PATH=/some/storage/path \
-e MODERNE_DX_ARTIFACTORY_0_URL=https://myartifactory.example.com/artifactory/ \
-e MODERNE_DX_ARTIFACTORY_0_USERNAME=admin \
-e MODERNE_DX_ARTIFACTORY_0_PASSWORD=password \
-e MODERNE_DX_ARTIFACTORY_0_ASTQUERYFILTERS_0='"name":{"$match":"*-ast.jar"}' \
-e MODERNE_DX_ARTIFACTORY_0_ASTQUERYFILTERS_1='"repo":{"$eq":"example-maven"}' \
-e MODERNE_DX_ARTIFACTSYNC_SINCE=2024-01-01T00:00:00Z
# ... Additional variables

Artifactory recipe variables

Variables:

  • MODERNE_DX_MAVEN_{index}_URL – The URL of your Maven repository inside of Artifactory.

  • MODERNE_DX_MAVEN_{index}_ASTSOURCE – Specifies whether or not this repository should be searched for LST artifacts. Defaults to true – but you should set this to false (Note: LSTs used to be called ASTs).

  • MODERNE_DX_MAVEN_{index}_LOCALREPOSITORY – The path on disk where Maven index files will be downloaded to. This is on the disk where the service is being run and not in Artifactory. Defaults to ~/.moderne-maven

    • If multiple Maven repositories are configured on the service, they must have different MODERNE_DX_MAVEN_{index}_LOCALREPOSITORY configured.

  • MODERNE_DX_MAVEN_{index}_USERNAME – (Optional) The username used to resolve artifacts. Defaults to null.

  • MODERNE_DX_MAVEN_{index}_PASSWORD – (Optional) The password used to resolve artifacts. Defaults to null.

  • MODERNE_DX_MAVEN_{index}_RELEASES – (Optional) Specifies whether or not this repository should be searched for releases. Defaults to true.

  • MODERNE_DX_MAVEN_{index}_SNAPSHOTS – (Optional) Specifies whether or not this repository should be searched for snapshots. Defaults to true.

  • MODERNE_DX_MAVEN_{index}_RECIPESOURCE – (Optional) Specifies whether or not this repository should be searched for recipe jars. Defaults to true.

  • MODERNE_DX_MAVEN_{index}_SKIPSSL – (Optional) Whether or not to skip SSL/TLS verification for calls from the service to this Maven repository. This must be set to true if you use a self-signed SSL/TLS certificate. Defaults to false.

  • MODERNE_DX_MAVEN_{index}_SKIPVALIDATECONNECTIVITY– (Optional) By default, on startup dx we validate that it can connect to the configured resource, and fail to start up the dx if we cannot. Set this to true to skip this validation. Defaults to false.

Example:

docker run \
# ... Existing variables
-e MODERNE_DX_MAVEN_0_URL=https://myartifactory.example.com/artifactory/libs-releases-local \
-e MODERNE_DX_MAVEN_0_ASTSOURCE=false \
-e MODERNE_DX_MAVEN_0_LOCALREPOSITORY=~/.moderne-maven \
-e MODERNE_DX_MAVEN_0_USERNAME=admin \
-e MODERNE_DX_MAVEN_0_PASSWORD=password \
# ... Additional variables

Organizations service variables

Variables:

  • MODERNE_DX_ORGANIZATION_URL – The URL of your GraphQL service that provides organization information. Cannot be combined with MODERNE_DX_ORGANIZATION_REPOSCSV

  • MODERNE_DX_ORGANIZATION_REPOSCSV - The path of your repos.csv file that provides organization information. Cannot be combined with MODERNE_DX_ORGANIZATION_URL

  • MODERNE_DX_ORGANIZATION_DEFAULTCOMMITOPTIONS - (Optional) The commit options used if not specified by the organization service.`

  • MODERNE_DX_ORGANIZATION_UPDATE_INTERVAL_SECONDS – (Optional) Specifies how often to request your organization information. Only used when combined with MODERNE_DX_ORGANIZATION_URL. Defaults to 600 (10 minutes).

  • MODERNE_DX_ORGANIZATION_SKIPSSL – (Optional) Specifies whether or not to skip SSL validation for HTTP connections to this Organization service instance. Only used when combined with MODERNE_DX_ORGANIZATION_URL. This must be set to true if you use a self-signed SSL/TLS certificate. Defaults to false.

Example:

docker run \
# ... Existing variables
-e MODERNE_DX_ORGANIZATION_URL=http://localhost:8091 \
-e MODERNE_DX_ORGANIZATION_UPDATE_INTERVAL_SECONDS=600 \
-e MODERNE_DX_ORGANIZATION_DEFAULTCOMMITOPTIONS=Direct,Branch,Fork,PullRequest,ForkAndPullRequest \
# ... Additional variables

Strict recipe sources variables

Variables:

  • MODERNE_DX_RECIPE_USEONLYCONFIGURED – Only use the recipe sources configured in the service.

  • MODERNE_DX_RECIPE_POMCACHE_TYPE – (Optional) Used to specify what type of cache the POM should use. Acceptable values: IN_MEMORY or REDIS.

  • MODERNE_DX_RECIPE_POMCACHE_ENTRYTTLMINUTES – (Optional) How long entries should live in the POM cache.

  • MODERNE_DX_RECIPE_POMCACHE_REDIS_HOST – (Required if the POM cache type is set to REDIS, Optional otherwise) The URL of the Redis instance.

  • MODERNE_DX_RECIPE_POMCACHE_REDIS_PORT – (Required if the POM cache type is set to REDIS, Optional otherwise) The port number of the Redis instance.

  • MODERNE_DX_RECIPE_POMCACHE_REDIS_USERNAME – (Optional) The username needed to authenticate to the Redis instance.

  • MODERNE_DX_RECIPE_POMCACHE_REDIS_PASSWORD – (Optional) The password needed to authenticate with the Redis instance.

  • MODERNE_DX_RECIPE_POMCACHE_REDIS_SSL – (Optional) If set to true, then SSL will be enabled for the connection to the Redis instance. Defaults to false.

  • MODERNE_DX_RECIPE_POMCACHE_REDIS_DATABASE – (Optional) The Redis DB index.

Example:

docker run \
# ... Existing variables
-e MODERNE_DX_RECIPE_USEONLYCONFIGURED=true \
# ... Additional variables
PreviousConfigure Moderne DX with SSL certificateNextReferences

Last updated