Links

All agent 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.

Core variables

OCI Container
Executable JAR
Variables:
  • MODERNE_AGENT_APIGATEWAYRSOCKETURIThe URI used to connect to the Moderne API, provided by Moderne.
  • MODERNE_AGENT_CRYPTO_SYMMETRICKEYA 256-bit AES encryption key, hex encoded. Used to encrypt your artifacts.
  • MODERNE_AGENT_NICKNAMEA name used to identify your agent in the SaaS agent dashboard UI.
  • MODERNE_AGENT_TOKENThe Moderne SaaS agent connection token, provided by Moderne.
  • MODERNE_AGENT_DOWNLOADPARALLELISM(Optional) How many threads are used to download LSTs. Defaults to 2 threads.
  • MODERNE_AGENT_ARTIFACTINDEXINTERVALSECONDS(Optional) How frequently LSTs will be indexed. Defaults to 120 seconds.
  • MODERNE_AGENT_DEFAULTCOMMITOPTIONS_{index}(Optional) Use to restrict which commit options are available on a tenant level (if the organizations service doesn't return any). Acceptable values: Direct, Branch, Fork, PullRequest, ForkAndPullRequest. By default all options are available.
Example:
docker run \
-e MODERNE_AGENT_APIGATEWAYRSOCKETURI=https://api.tenant.moderne.io/rsocket \
-e MODERNE_AGENT_CRYPTO_SYMMETRICKEY=yourSymmetricKey \
-e MODERNE_AGENT_NICKNAME=prod-1 \
-e MODERNE_AGENT_TOKEN=yourToken \
-e MODERNE_AGENT_DEFAULTCOMMITOPTIONS_0=PullRequest \
-e MODERNE_AGENT_DEFAULTCOMMITOPTIONS_1=ForkAndPullRequest \
# ... Additional variables
Arguments:
  • --moderne.agent.apiGatewayRsocketUriThe URI used to connect to the Moderne API, provided by Moderne.
  • --moderne.agent.crypto.symmetricKeyA 256-bit AES encryption key, hex encoded. Used to encrypt your artifacts.
  • --moderne.agent.nicknameA name used to identify your agent in the SaaS agent dashboard UI.
  • --moderne.agent.tokenThe Moderne SaaS agent connection token, provided by Moderne.
  • --moderne.agent.downloadParallelism(Optional) How many threads are used to download LSTs. Defaults to 2 threads.
  • --moderne.agent.artifactIndexIntervalSeconds(Optional) How frequently LSTs will be indexed. Defaults to 120 seconds.
  • --moderne.agent.defaultCommitOptions[{index}](Optional) Use to restrict which commit options are available on a tenant level (if the organizations service doesn't return any). Acceptable values: Direct, Branch, Fork, PullRequest, ForkAndPullRequest. By default all options are available.
Example:
java -jar moderne-agent-{version}.jar \
--moderne.agent.apiGatewayRsocketUri=https://api.tenant.moderne.io/rsocket \
--moderne.agent.crypto.symmetricKey=yourSymmetricKey
--moderne.agent.nickname=prod-1 \
--moderne.agent.token=yourToken \
--moderne.agent.defaultCommitOptions[0]=PullRequest \
--moderne.agent.defaultCommitOptions[1]=ForkAndPullRequest \
# ... Additional arguments

Bitbucket Cloud variables

OCI Container
Executable JAR
Variables:
  • MODERNE_AGENT_BITBUCKET_CLOUD_OAUTH_KEYThe key specified in your Bitbucket OAuth consumer.
  • MODERNE_AGENT_BITBUCKET_CLOUD_OAUTH_SECRETThe secret specified in your Bitbucket OAuth consumer.
Example:
docker run \
# ... Existing variables
-e MODERNE_AGENT_BITBUCKET_CLOUD_OAUTH_KEY=yourOAuthKey \
-e MODERNE_AGENT_BITBUCKET_CLOUD_OAUTH_SECRET=yourSecretKey \
# ... Additional variables
Arguments:
  • --moderne.agent.bitbucket.cloud.oauthKeyThe key specified in your Bitbucket OAuth consumer.
  • --moderne.agent.bitbucket.cloud.oauthSecretThe secret specified in your Bitbucket OAuth consumer.
Example:
java -jar moderne-agent-{version}.jar \
# ... Existing arguments
--moderne.agent.bitbucket.cloud.oauthKey=yourOAuthKey \
--moderne.agent.bitbucket.cloud.oauthSecret=yourSecretKey \
# ... Additional arguments

Bitbucket Data Center variables

You can configure multiple Bitbucket instances by including multiple entries, each with a different {index}.
OCI Container
Executable JAR
Variables:
  • MODERNE_AGENT_BITBUCKET_{index}_PRIVATEKEYThe private key you configured for this Bitbucket instance.
  • MODERNE_AGENT_BITBUCKET_{index}_URLThe fully-qualified URL of the running Bitbucket instance. For example: https://bitbucket.myorg.com
  • MODERNE_AGENT_BITBUCKET_{index}_ALTERNATEURLS_{index}(Optional) The list of alternative fully-qualified URL of the running Bitbucket instance. For example: https://bitbucket.myorg.com
  • MODERNE_AGENT_BITBUCKET_{index}_SKIPSSL(Optional) Specifies whether or not to skip SSL validation for HTTP connections to this Bitbucket instance. This must be set to true if you use a self-signed SSL/TLS certificate. Defaults to false.
  • MODERNE_AGENT_BITBUCKET_{index}_SSH_PRIVATEKEY(Optional) The SSH private key used to establish a SSH connection with Bitbucket.
  • MODERNE_AGENT_BITBUCKET_{index}_SSH_PASSPHRASE(Required if the SSH private key is specified and encrypted with a passphrase) The passphrase used to encrypt the SSH private key.
  • MODERNE_AGENT_BITBUCKET_{index}_SSH_SSHFILENAME(Required if the SSH private key is specified) The file name of the private key, which the agent will store locally.
  • MODERNE_AGENT_BITBUCKET_{index}_SSH_USER(Required if the SSH private key is specified) The username used for SSH communication with Bitbucket.
  • MODERNE_AGENT_BITBUCKET_{index}_SSH_PORT(Optional) The port used to communicate via SSH with Bitbucket. Defaults to 7999.
Example:
docker run \
# ... Existing variables
-e MODERNE_AGENT_BITBUCKET_0_PRIVATEKEY=yourPrivateKey \
-e MODERNE_AGENT_BITBUCKET_0_URL=https://bitbucket.myorg.com \
# ... Additional variables
Arguments:
  • --moderne.agent.bitbucket[{index}].privateKeyThe private key you configured for this Bitbucket instance.
  • --moderne.agent.bitbucket[{index}].urlThe fully-qualified URL of the running Bitbucket instance. For example: https://bitbucket.myorg.com
  • --moderne.agent.bitbucket[{index}].alternateUrls[{index}](Optional) The list of alternative fully-qualified URL of the running Bitbucket instance. For example: https://bitbucket.myorg.com
  • --moderne.agent.bitbucket[{index}].skipSsl(Optional) Specifies whether or not to skip SSL validation for HTTP connections to this Bitbucket instance. This must be set to true if you use a self-signed SSL/TLS certificate. Defaults to false.
  • --moderne.agent.bitbucket[{index}].ssh.privateKey(Optional) The SSH private key used to establish a SSH connection with Bitbucket.
  • --moderne.agent.bitbucket[{index}].ssh.passphrase(Required if the SSH private key is specified and encrypted with a passphrase) The passphrase used to encrypt the SSH private key.
  • --moderne.agent.bitbucket[{index}].ssh.sshFileName(Required if the SSH private key is specified) The file name of the private key, which the agent will store locally.
  • --moderne.agent.bitbucket[{index}].ssh.user(Required if the SSH private key is specified) The username used for SSH communication with Bitbucket.
  • --moderne.agent.bitbucket[{index}].ssh.port(Optional) The port used to communicate via SSH with Bitbucket. Defaults to 7999.
Example:
java -jar moderne-agent-{version}.jar \
# ... Existing arguments
--moderne.agent.bitbucket[0].privateKey=yourPrivateKey \
--moderne.agent.bitbucket[0].url=https://bitbucket.myorg.com \
# ... Additional arguments

GitHub variables

You can configure multiple GitHub OAuth apps by including multiple entries, each with a different {index}.
OCI Container
Executable JAR
Variables:
  • MODERNE_AGENT_GITHUB_{index}_OAUTH_CLIENTIDThe client id configured in GitHub.
  • MODERNE_AGENT_GITHUB_{index}_OAUTH_CLIENTSECRETThe client secret configured in GitHub.
  • MODERNE_AGENT_GITHUB_{index}_URLThe fully-qualified hostname of the running GitHub instance.
  • MODERNE_AGENT_GITHUB_{index}_SKIPSSL(Optional) Specifies whether or not to skip SSL validation for HTTP connections to this GitHub instance. This must be set to true if you use a self-signed SSL/TLS certificate. Defaults to false.
  • MODERNE_AGENT_GITHUB_{index}_ALLOWABLE_ORGANIZATIONS_{index}(Optional) Specifies what organizations you can fork recipe results to. By default, there are no restrictions on which organizations can be committed to. If you want multiple organizations, increase the last index and add one per line.
  • MODERNE_AGENT_GITHUB_{index}_OAUTH_INCLUDEPRIVATEREPOS(Optional) By default, the OAuth app will only have access to public repositories within your organization(s). To provide the OAuth app access to private repositories, you can set this to true.
  • MODERNE_AGENT_GITHUB_{index}_SSH_PRIVATEKEY(Optional) The SSH private key used to establish a SSH connection with GitHub.
  • MODERNE_AGENT_GITHUB_{index}_SSH_PASSPHRASE(Required if the SSH private key is specified and encrypted with a passphrase) The passphrase used to encrypt the SSH private key.
  • MODERNE_AGENT_GITHUB_{index}_SSH_SSHFILENAME(Required if the SSH private key is specified) The file name of the private key, which the agent will store locally.
  • MODERNE_AGENT_GITHUB_{index}_SSH_USER(Required if the SSH private key is specified) The username used for SSH communication with GitHub.
  • MODERNE_AGENT_GITHUB_{index}_SSH_PORT(Optional) The port used to communicate via SSH with GitHub. Defaults to 7999.
Example:
docker run \
# ... Existing variables
-e MODERNE_AGENT_GITHUB_0_OAUTH_CLIENTID=yourClientId \
-e MODERNE_AGENT_GITHUB_0_OAUTH_CLIENTSECRET=yourClientSecret \
-e MODERNE_AGENT_GITHUB_0_URL=https://myorg.github.com \
-e MODERNE_AGENT_GITHUB_0_ALLOWABLE_ORGANIZATIONS_0=moderne \
-e MODERNE_AGENT_GITHUB_0_ALLOWABLE_ORGANIZATIONS_1=openrewrite \
-e MODERNE_AGENT_GITHUB_0_OAUTH_INCLUDEPRIVATEREPOS=true \
# ... Additional variables
Arguments:
  • --moderne.agent.github[{index}].oauth.clientIdThe client id configured in GitHub.
  • --moderne.agent.github[{index}].oauth.clientSecretThe client secret configured in GitHub.
  • --moderne.agent.github[{index}].urlThe fully-qualified hostname of the running GitHub instance.
  • --moderne.agent.github[{index}].skipSsl(Optional) Specifies whether or not to skip SSL validation for HTTP connections to this GitHub instance. This must be set to true if you use a self-signed SSL/TLS certificate. Defaults to false.
  • --moderne.agent.github[{index}].allowableOrganizations[{index}](Optional) Specifies what organizations you can fork recipe results to. By default, there are no restrictions on which organizations can be committed to. If you want multiple organizations, increase the last index and add one per line.
  • --moderne.agent.github[{index}].oauth.includePrivateRepos(Optional) By default, the OAuth app will only have access to public repositories within your organization(s). To provide the OAuth app access to private repositories, you can set this to true.
  • --moderne.agent.github[{index}].ssh.privateKey(Optional) The SSH private key used to establish a SSH connection with GitHub.
  • --moderne.agent.github[{index}].ssh.passphrase(Required if the SSH private key is specified and encrypted with a passphrase) The passphrase used to encrypt the SSH private key.
  • --moderne.agent.github[{index}].ssh.sshFileName(Required if the SSH private key is specified) The file name of the private key, which the agent will store locally.
  • --moderne.agent.github[{index}].ssh.user(Required if the SSH private key is specified) The username used for SSH communication with GitHub.
  • --moderne.agent.github[{index}].ssh.port(Optional) The port used to communicate via SSH with GitHub. Defaults to 7999.
Example:
java -jar moderne-agent-{version}.jar \
# ... Existing arguments
--moderne.agent.github[0].oauth.clientId=yourClientId \
--moderne.agent.github[0].oauth.clientSecret=yourClientSecret \
--moderne.agent.github[0].url=https://myorg.github.com \
--moderne.agent.github[0].allowableOrganizations[0]=moderne \
--moderne.agent.github[0].allowableOrganizations[1]=openrewrite \
--moderne.agent.github[0].oauth.includePrivateRepos=true \
# ... Additional arguments

GitLab variables

You can configure multiple GitLab OAuth apps by including multiple entries, each with a different {index}.
OCI Container
Executable JAR
Variables:
  • MODERNE_AGENT_GITLAB_{index}_OAUTH_CLIENTIDThe application id configured in GitLab.
  • MODERNE_AGENT_GITLAB_{index}_OAUTH_CLIENTSECRETThe secret configured in GitLab.`
  • MODERNE_AGENT_GITLAB_{index}_URLThe fully-qualified hostname of your GitLab instance.`
  • MODERNE_AGENT_GITLAB_{index}_SKIPSSL(Optional) Specifies whether or not to skip SSL validation for HTTP connections to this GitLab instance. This must be set to true if you use a self-signed SSL/TLS certificate. Defaults to false.
  • MODERNE_AGENT_GITLAB_{index}_SSH_PRIVATEKEY(Optional) The SSH private key used to establish a SSH connection with GitLab.
  • MODERNE_AGENT_GITLAB_{index}_SSH_PASSPHRASE(Required if the SSH private key is specified and encrypted with a passphrase) The passphrase used to encrypt the SSH private key.
  • MODERNE_AGENT_GITLAB_{index}_SSH_SSHFILENAME(Required if the SSH private key is specified) The file name of the private key, which the agent will store locally.
  • MODERNE_AGENT_GITLAB_{index}_SSH_USER(Required if the SSH private key is specified) The username used for SSH communication with GitLab.
  • MODERNE_AGENT_GITLAB_{index}_SSH_PORT(Optional) The port used to communicate via SSH with GitLab. Defaults to 7999.
Example:
docker run \
# ... Existing variables
-e MODERNE_AGENT_GITLAB_0_OAUTH_CLIENTID=yourClientId \
-e MODERNE_AGENT_GITLAB_0_OAUTH_CLIENTSECRET=yourClientSecret \
-e MODERNE_AGENT_GITLAB_0_URL=https://your-gitlab.com \
# ... Additional variables
Arguments:
  • --moderne.agent.gitlab[{index}].oauth.clientIdThe application id configured in GitLab.
  • --moderne.agent.gitlab[{index}].oauth.clientSecretThe secret configured in GitLab.`
  • --moderne.agent.gitlab[{index}].urlThe fully-qualified hostname of your GitLab instance.`
  • --moderne.agent.gitlab[{index}].skipSsl(Optional) Specifies whether or not to skip SSL validation for HTTP connections to this GitLab instance. This must be set to true if you use a self-signed SSL/TLS certificate. Defaults to false.
  • --moderne.agent.gitlab[{index}].oauth.includePrivateRepos(Optional) By default, the OAuth app will only have access to public repositories within your organization(s). To provide the OAuth app access to private repositories, you can set this to true.
  • --moderne.agent.gitlab[{index}].ssh.privateKey(Optional) The SSH private key used to establish a SSH connection with GitLab.
  • --moderne.agent.gitlab[{index}].ssh.passphrase(Required if the SSH private key is specified and encrypted with a passphrase) The passphrase used to encrypt the SSH private key.
  • --moderne.agent.gitlab[{index}].ssh.sshFileName(Required if the SSH private key is specified) The file name of the private key, which the agent will store locally.
  • --moderne.agent.gitlab[{index}].ssh.user(Required if the SSH private key is specified) The username used for SSH communication with GitLab.
  • --moderne.agent.gitlab[{index}].ssh.port(Optional) The port used to communicate via SSH with GitLab. Defaults to 7999.
Example:
java -jar moderne-agent-{version}.jar \
# ... Existing arguments
--moderne.agent.gitlab[0].oauth.clientId=yourClientId \
--moderne.agent.gitlab[0].oauth.clientSecret=yourClientSecret \
--moderne.agent.gitlab[0].url=https://your-gitlab.com \
# ... Additional arguments

Organizations service variables

OCI Container
Executable JAR
Variables:
  • MODERNE_AGENT_ORGANIZATION_URLThe URL of your GraphQL service that provides organization information.
  • MODERNE_AGENT_ORGANIZATION_UPDATE_INTERVAL_SECONDS(Optional) Specifies how often to request your organization information. Defaults to 600 (10 minutes).
  • MODERNE_AGENT_ORGANIZATION_SKIPSSL(Optional) Specifies whether or not to skip SSL validation for HTTP connections to this Organization service instance. 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_AGENT_ORGANIZATION_URL=http://localhost:8091 \
-e MODERNE_AGENT_ORGANIZATION_UPDATE_INTERVAL_SECONDS=600 \
# ... Additional variables
Arguments:
  • --moderne.agent.organization.urlThe URL of your GraphQL service that provides organization information.
  • --moderne.agent.organization.updateIntervalSeconds(Optional) Specifies how often to request your organization information. Defaults to 600 (10 minutes).
  • --moderne.agent.organization.skipSsl(Optional) Specifies whether or not to skip SSL validation for HTTP connections to this Organization service instance. This must be set to true if you use a self-signed SSL/TLS certificate. Defaults to false.
Example:
java -jar moderne-agent-{version}.jar \
# ... Existing arguments
--moderne.agent.organization.url=http://localhost:8091 \
--moderne.agent.organization.updateIntervalSeconds=600 \
# ... Additional arguments

Maven repository variables

You can configure multiple Maven repositories by including multiple entries, each with a different {index}.
OCI Container
Executable JAR
Variables:
  • MODERNE_AGENT_MAVEN_{index}_URLThe URL of your Maven repository.
  • MODERNE_AGENT_MAVEN_{index}_LOCALREPOSITORYThe path on disk where LST artifacts and Maven index files will be downloaded to. This is on the disk where the agent 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 agent, they must have different MODERNE_AGENT_MAVEN_{index}_LOCALREPOSITORY configured.
  • MODERNE_AGENT_MAVEN_{index}_USERNAME(Optional) The username used to resolve artifacts. Defaults to null.
  • MODERNE_AGENT_MAVEN_{index}_PASSWORD(Optional) The password used to resolve artifacts. Defaults to null.
  • MODERNE_AGENT_MAVEN_{index}_RELEASES(Optional) Specifies whether or not this repository should be searched for releases. Defaults to true.
  • MODERNE_AGENT_MAVEN_{index}_SNAPSHOTS(Optional) Specifies whether or not this repository should be searched for snapshots. Defaults to true.
  • MODERNE_AGENT_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_AGENT_MAVEN_{index}_RECIPESOURCE(Optional) Specifies whether or not this repository should be searched for recipe jars. Defaults to true.
  • MODERNE_AGENT_MAVEN_{index}_SKIPSSL(Optional) Whether or not to skip SSL/TLS verification for calls from the agent to this Maven repository. 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_AGENT_MAVEN_0_URL=https://myartifactory.example.com/artifactory/libs-releases-local \
-e MODERNE_AGENT_MAVEN_0_LOCALREPOSITORY=~/.moderne-maven \
-e MODERNE_AGENT_MAVEN_0_USERNAME=admin \
-e MODERNE_AGENT_MAVEN_0_PASSWORD=password \
# ... Additional variables
Arguments:
  • --moderne.agent.maven[{index}].urlThe URL of your Maven repository.
  • --moderne.agent.maven[{index}].localRepositoryThe path on disk where LST artifacts and Maven index files will be downloaded to. This is on the disk where the agent 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 agent, they must have different MODERNE_AGENT_MAVEN_{index}_LOCALREPOSITORY configured.
  • --moderne.agent.maven[{index}].username(Optional) The username used to resolve artifacts. Defaults to null.
  • --moderne.agent.maven[{index}].password(Optional) The password used to resolve artifacts. Defaults to null.
  • --moderne.agent.maven[{index}].releases(Optional) Specifies whether or not this repository should be searched for releases. Defaults to true.
  • --moderne.agent.maven[{index}].snapshots(Optional) Specifies whether or not this repository should be searched for snapshots. Defaults to true.
  • --moderne.agent.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.agent.maven[{index}].recipeSource(Optional) Specifies whether or not this repository should be searched for recipe jars. Defaults to true.
  • --moderne.agent.maven[{index}].skipSsl(Optional) Whether or not to skip SSL/TLS verification for calls from the agent to this Maven repository. This must be set to true if you use a self-signed SSL/TLS certificate. Defaults to false.
Example:
java -jar moderne-agent-{version}.jar \
# ... Existing arguments
--moderne.agent.maven[0].url=https://myartifactory.example.com/artifactory/libs-releases-local \
--moderne-agent.maven[0].localRepository=~/.moderne-maven \
--moderne.agent.maven[0].username=admin \
--moderne.agent.maven[0].password=password \
# ... Additional arguments

Artifactory repository variables

You can configure multiple Artifactory servers by including multiple entries, each with a different {index}. Within a given Artifactory server configuration, you can configure multiple LST query filters by including multiple entries, each with a different {index}.
OCI Container
Executable JAR
Variables:
  • MODERNE_AGENT_ARTIFACTORY_{index}_URLThe URL of your Artifactory instance.
  • MODERNE_AGENT_ARTIFACTORY_{index}_USERNAMEThe username used to connect to your Artifactory instance. This user must have permission to run AQL queries.
  • MODERNE_AGENT_ARTIFACTORY_{index}_PASSWORDThe password used to connect to your Artifactory instance.
  • MODERNE_AGENT_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_AGENT_ARTIFACTORY_{index}_SKIPSSL(Optional) Specifies whether or not to skip SSL verification for HTTP connections from the agent to this Artifactory instance. 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_AGENT_ARTIFACTORY_0_URL=https://myartifactory.example.com/artifactory/ \
-e MODERNE_AGENT_ARTIFACTORY_0_USERNAME=admin \
-e MODERNE_AGENT_ARTIFACTORY_0_PASSWORD=password \
-e MODERNE_AGENT_ARTIFACTORY_0_ASTQUERYFILTERS_0='"name":{"$match":"*-ast.jar"}' \
-e MODERNE_AGENT_ARTIFACTORY_0_ASTQUERYFILTERS_1='"repo":{"$eq":"example-maven"}' \
# ... Additional variables
Arguments:
  • --moderne.agent.artifactory[{index}].urlThe URL of your Artifactory instance.
  • --moderne.agent.artifactory[{index}].usernameThe username used to connect to your Artifactory instance. This user must have permission to run AQL queries.
  • --moderne.agent.artifactory[{index}].passwordThe password used to connect to your Artifactory instance.
  • --moderne.agent.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.agent.artifactory[{index}].skipSsl(Optional) Specifies whether or not to skip SSL verification for HTTP connections from the agent to this Artifactory instance. This must be set to true if you use a self-signed SSL/TLS certificate. Defaults to false.
Example:
java -jar moderne-agent-{version}.jar \
# ... Existing arguments
--moderne.agent.artifactory[0].url=https://myartifactory.example.com/artifactory/ \
--moderne.agent.artifactory[0].username=admin \
--moderne.agent.artifactory[0].password=password \
--moderne.agent.artifactory[0].astQueryFilters[0]='{"name":{"$match":"*-ast.jar"}}' \
--moderne.agent.artifactory[0].astQueryFilters[1]='{"repo":{"$eq":"example-maven"}}' \
# ... Additional arguments

Recipe variables

The platform provides several fallback repositories for recipe loading when an agent has not been configured with any recipe sources. This fallback behavior can be disabled using recipe configuration.
OCI Container
Executable JAR
Variables:
  • MODERNE_AGENT_RECIPE_USEONLYCONFIGURED – Only use the recipe sources configured in the agent.
  • MODERNE_AGENT_RECIPE_POMCACHE_TYPE(Optional) Used to specify what type of cache the POM should use. Acceptable values: IN_MEMORY or REDIS.
  • MODERNE_AGENT_RECIPE_POMCACHE_ENTRYTTLMINUTES(Optional) How long entries should live in the POM cache.
  • MODERNE_AGENT_RECIPE_POMCACHE_REDIS_HOST(Required if the POM cache type is set to REDIS, Optional otherwise) The URL of the Redis instance.
  • MODERNE_AGENT_RECIPE_POMCACHE_REDIS_PORT(Required if the POM cache type is set to REDIS, Optional otherwise) The port number of the Redis instance.
  • MODERNE_AGENT_RECIPE_POMCACHE_REDIS_USERNAME(Optional) The username needed to authenticate to the Redis instance.
  • MODERNE_AGENT_RECIPE_POMCACHE_REDIS_PASSWORD(Optional) The password needed to authenticate with the Redis instance.
  • MODERNE_AGENT_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_AGENT_RECIPE_POMCACHE_REDIS_DATABASE(Optional) The Redis DB index.
Example:
docker run \
# ... Existing variables
-e MODERNE_AGENT_RECIPE_USEONLYCONFIGURED=true \
# ... Additional variables
Arguments:
  • --moderne.agent.recipe.useOnlyConfigured – Only use the recipe sources configured in the agent.
  • --moderne.agent.recipe.pomCache.type(Optional) Used to specify what type of cache the POM should use. Acceptable values: IN_MEMORY or REDIS.
  • --moderne.agent.recipe.pomCache.entryTtlMinutes(Optional) How long entries should live in the POM cache.
  • --moderne.agent.recipe.pomCache.redis.host(Required if the POM cache type is set to REDIS, Optional otherwise) The URL of the Redis instance.
  • --moderne.agent.recipe.pomCache.redis.port(Required if the POM cache type is set to REDIS, Optional otherwise) The port number of the Redis instance.
  • --moderne.agent.recipe.pomCache.redis.username(Optional) The username needed to authenticate to the Redis instance.
  • --moderne.agent.recipe.pomCache.redis.password(Optional) The password needed to authenticate with the Redis instance.
  • --moderne.agent.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.agent.recipe.pomCache.redis.database(Optional) The Redis DB index.
Example:
java -jar moderne-agent-{version}.jar \
# ... Existing arguments
--moderne.agent.recipe.useOnlyConfigured=true \
# ... Additional arguments

PyPI variables

You can configure multiple PyPI package indexes by including multiple entries, each with a different {index}.
OCI Container
Executable JAR
Variables:
  • MODERNE_AGENT_VISUALIZATIONS_USEONLYCONFIGURED – Only use the visualization sources configured in the agent. Default is false.
  • MODERNE_AGENT_PYPI_{index}_URLThe URL of your PyPI package index.
  • MODERNE_AGENT_PYPI_{index}_USERNAME(Optional) The username used to access the index. Defaults to null.
  • MODERNE_AGENT_PYPI_{index}_PASSWORD(Optional) The password used to access the index. Defaults to null.
  • MODERNE_AGENT_PYPI_{index}_SKIPSSL(Optional) Whether or not to skip SSL/TLS verification for calls from the agent to this PyPI package index. 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_AGENT_VISUALIZATIONS_USEONLYCONFIGURED=true \
-e MODERNE_AGENT_PYPI_0_URL=https://pypi.example.com/simple \
-e MODERNE_AGENT_PYPI_0_USERNAME=admin \
-e MODERNE_AGENT_PYPI_0_PASSWORD=password \
# ... Additional variables
Arguments:
  • --moderne.agent.visualizations.useOnlyConfigured - (Optional) Only use the visualization sources configured in the agent. Default is false.
  • --moderne.agent.pypi[{index}].urlThe URL of your PyPI package index.
  • --moderne.agent.pypi[{index}].username(Optional) The username used to access the index. Defaults to null.
  • --moderne.agent.pypi[{index}].password(Optional) The password used to access the index. Defaults to null.
  • --moderne.agent.pypi[{index}].skipSsl(Optional) Whether or not to skip SSL/TLS verification for calls from the agent to this PyPI package index. This must be set to true if you use a self-signed SSL/TLS certificate. Defaults to false.
Example:
java -jar moderne-agent-{version}.jar \
# ... Existing arguments
--moderne.agent.visualizations.useOnlyConfigured=true \
--moderne.agent.pypi[0].url=https://pypi.example.com/simple \
--moderne.agent.pypi[0].username=admin \
--moderne.agent.pypi[0].password=password \
# ... Additional arguments