An application.properties file in the $THREEDS_HOME/3dss-admin-ui/conf directory is used to set configuration options for the 3DS Server Admin.
The available configuration options and their default values are listed below.
Note: If you don't configure a value for one of the properties in your application.properties, the default value as shown below will be used.
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 | server.port=8080### Logginglogging.config=classpath:log4j2-prod.xml## The resource location of the ThreeDS Server license (e.g. file:/etc/threeDSServerLicense/3dss.lic)## Use a "file:" prefix for resources located on the file system.# Use a "http:" prefix for resources loaded from an URL.# Use a "classpath:" prefix for resources located on the classpath.## If ${license.resource-location} is not specified (i.e. empty) it defaults to file:${threedss.config.home}/3dss.lic# (${threedss.config.home} is the value of the property "threedss.config.home")## If not specified and the property "threedss.config.home" is not set this# defaults to file:\${user.home}/.threeDSServer/3dss.lic# (\${user.home} is the user's home directory)#license.resource-location=## SMTP server host. For instance, `smtp.example.com`.#spring.mail.host=#### Authentication## Initial password for the 'superadmin' account. Expires on first login.# The initial password should conform to the password policy, it must contain at least 8 characters including at least one lowercase letter, one capital letter, one number and one special symbol (e.g. ? ! $ % & / = * + ~ , . ; : > < - _).# After the initial migration the this configuration property value can be removed.#auth.flyway.placeholders.initialSuperadminPassword=## The email of the 'superadmin' account#auth.flyway.placeholders.initialSuperadminEmail=## The address of the sender of the email messages generated for user management purposes#auth.email.from.address=## The name of the sender of the email messages generated for user management purposes#auth.email.from.personal=## The fully qualified base URL of the installed 3DS Server Admin application instance. This property is required to be# configured for a proper redirect to the Admin application after successful login. The value will be also used in sent# email messages generated for user management purposes.#auth.baseAppUrl=## Set a cookie that will be set on login. This can be used by a Web Application Firewall that supports control via# cookie values to inform that the session cookie should be regenerated after login.## auth.login.cookie.name=# auth.login.cookie.value=## Set a cookie that will be set on logout. This can be used by a Web Application Firewall that supports control via# cookie values to inform that the session cookie should be regenerated after logout.## auth.logout.cookie.name=# auth.logout.cookie.value=### Timeout configuration for 3DS Server Authentication Response defined in seconds. This value will be used only if# timeout configuration is not defined at root level for the Admin UI.#threedss.instance.timeouts.ares.seconds=300## Timeout configuration for 3DS Server Preparation Response defined in seconds. This value will be used only if# timeout configuration is not defined at root level for the Admin UI.#threedss.instance.timeouts.pres.seconds=300## Timeout configuration for 3DS Server Method defined in seconds. This value will be used only if# timeout configuration is not defined at root level for the Admin UI.#threedss.instance.timeouts.threedsmethod.seconds=10#### Production database connection properties## The datasource URL location. The JDBC connection string may differ depending on the database type, but we recommend# the specified formats defined below. Supported database types are PostgreSQL, MySQL, Oracle and Microsoft SQL Server.## Recommended JDBC connection strings:# PostgreSQL: jdbc:postgresql://<host>:<port>/<database-name># MySQL: jdbc:mysql://<host>:<port>/<database-name># Oracle: jdbc:oracle:<oracle-driver>:<host>:<port>:<SID># Microsoft SQL Server: jdbc:sqlserver://<host>:<port>;database=<database-name>spring.datasource.url=## The datasource user used by the application. It is recommended that this user has read-write privileges to the database# the application is using.#spring.datasource.username=## The password of the datasource user used by the application.#spring.datasource.password=## --- DEPRECATED ---# This field will be deprecated and it will be removed in future versions. Spring Boot will automatically detect the# driver class from the datasource URL. For MySQL this field is still required since it automatically detects an older# JDBC driver.## The appropriate Driver used for database connection. Supported database types are PostgreSQL, MySQL, Oracle and# Microsoft SQL Server. The value should be defined depending on the underlying database.## Default database is PostgreSQL. Accepted values are:## org.postgresql.Driver - indicating PostgreSQL database will be used# com.mysql.cj.jdbc.Driver - indicating MySQL database will be used# oracle.jdbc.OracleDriver - indicating Oracle database will be used# com.microsoft.sqlserver.jdbc.SQLServerDriver - indicating Microsoft SQL Server database will be used##spring.datasource.driver-class-name=## The SQL dialect of the underlying database. Supported database types are PostgreSQL, MySQL and Microsoft SQL Server.# The value should be defined depending on the underlying database.## Default database is PostgreSQL. Accepted values are depending on the desired dialect, but it is recommended to use# one of the following:## org.hibernate.dialect.PostgreSQL95Dialect - indicating PostgreSQL 9.5 Dialect will be used# org.hibernate.dialect.MySQL57Dialect - indicating MySQL 5.7 Dialect will be used# org.hibernate.dialect.Oracle12cDialect - indicating Oracle 12 c Dialect will be used# org.hibernate.dialect.SQLServer2012Dialect - indicating Microsoft SQL Server 2012 Dialect will be used#spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.PostgreSQL95Dialect## The batch size used by hibernate for inserting/deleting database-entries in batches instead of one query for# every entry.#spring.jpa.properties.hibernate.jdbc.batch_size=50## Enables batching of insert queries.#spring.jpa.properties.hibernate.jdbc.order_inserts=true## Enables batching of delete queries.#spring.jpa.properties.hibernate.jdbc.order_deletes=true#### Flyway properties## Flyway user to run the database install and update scripts. For security reasons it is recommended to have Flyway# user different from the one used by the application.#threedss.db.flyway.user=## Flyway user password#threedss.db.flyway.password=## The name of Flyway's schema history table.#threedss.db.flyway.table=threedss_schema_history## The name of database schema used by Flyway during the migration.# The schema name is case-sensitive.#threedss.db.flyway.schema=### Database Tablespaces properties## It is recommended the underlying database to have different tablespaces (locations in the file system) for# data, indexes, large objects (lob), logs and session data.# In order the 3DS Server to utilise the different tablespaces, they should be created before# its startup. The names of the created tablespaces should be configured in ${threedss.db.tablespaces.data},# ${threedss.db.tablespaces.index} and ${threedss.db.tablespaces.lob} respectively.## The tablespace configuration is relevant only for PostgreSQL, Oracle and Microsoft SQL Server database.# In Microsoft SQL Server this is related to filegroups. This feature is not used for MySQL since MySQL stores each# table in a separate location on the filesystem.## The name of the data tablespace.threedss.db.tablespaces.data=## The name of the indexes' tablespace.#threedss.db.tablespaces.index=## The name of the lob table space.#threedss.db.tablespaces.lob=## The name of the logs tablespace.threedss.db.tablespaces.logs=## The name of the session data tablespace.threedss.db.tablespaces.session=## The name of the default tablespace. This property should be configured and used if any of the# ${threedss.db.tablespaces.data}, ${threedss.db.tablespaces.index}, ${threedss.db.tablespaces.lob},# ${threedss.db.tablespaces.logs} or ${threedss.db.tablespaces.session} are not present.# If not configured differently, then the 'pg_default' value will be utilised.#threedss.db.tablespaces.defaults=pg_default## Property indicating whether scheduled moving of transaction logs to history table is enabled.# In case of multiple 3DS Server Admin instances running, a recommendation would be one Admin instance to do the# scheduled moving, or multiple Admin instances but in different timings (all configured with different# CRON expression - ${threedss.transaction-logs.scheduled-moving.cron}).#threedss.transaction-logs.scheduled-moving.enabled=false## CRON expression indicating the time when transaction logs will be moved to history transaction logs table in case# when ${threedss.transaction-logs.scheduled-moving.enabled} is set to true. CRON expression must consist of 6 fields.# The default value (0 0 3 * * *) indicates each day at 3am.#threedss.transaction-logs.scheduled-moving.cron=0 0 3 * * *##In case of larger set of transaction log entries, the scheduled moving of the entries to the history transaction logs# table can be performed in batches. The reason is not to load all the transaction logs (present in db) in-memory. This# property indicates the number of transaction log entries being moved in a single batch.## The scheduler will perform as many batches as needed in order to move all transaction log entries to the history# transaction logs table. 0 value means transaction logs moving will not be performed in batches (all entries will be# moved at once). Default value is 2000.#threedss.transaction-logs.scheduled-moving.batch-size=2000## Indicates how long should one transaction log stay in transaction logs table before it is moved to history# transaction logs table. The default value is 90 days.#threedss.transaction-logs.scheduled-moving.days-before-moving=90## In the process of generating the excel file, the transactions need to be loaded from database to in-memory.# Loading the transactions in batches reduces the risk of running out of memory in attempt to generate excel file# with large number of transactions. This property indicates the number of transactions in one batch.# Default value is 10000. When using Elasticsearch this value should not be exceeded.#threedss.transaction-logs.excel-file-generating.batch-size=10000## Configuration indicating which source should be used for transaction log searching. This configuration is depending on# how the 3DS Server is configured. If the selected source is not configured in the 3DS Server as well, the transaction search# page will not display any data.## Note: Only one source can be configured. Example for searching from Elasticsearch storage: threedss.transaction-logs.search.source=elasticsearch## Possible values are:# db - transaction search will use the Database logging storage to retrieve the searched transactions# elasticsearch - transaction search will use the Elasticsearch logging storage to retrieve the searched transactions#threedss.transaction-logs.search.source=db## Comma separated list of Elasticsearch endpoint(s)# Example values: spring.elasticsearch.rest.uris=http://elasticsearch:9200## spring.elasticsearch.rest.uris=#### Enables signing elasticsearch requests with the AWS request signing interceptor if set to true##nca.acquiring.aws.iam-role-elasticsearch-auth.enabled=false## Property indicating whether testing mode is enabled. This property can be used to bypass directory server reference# number validation while evaluating the 3DS Server product.## If ${threedsserver.testing-mode.enabled} property is not set, it defaults to false - indicating testing mode is# disabled.#threedsserver.testing-mode.enabled=false## The admin application has default encryption key used to encrypt/decrypt sensitive information like passwords for# certificate stores. If you want to use your own secret key specify the key alias, keystore location, keystore type# and keystore password.## Alias for active key which will be used for encrypting. You can change your active secret key alias,# but the old key must stay present in the keystore in case it is needed for decryption or until you re-encrypt# all encrypted database entries. Active key must be AES 256 secret key.#threedss.encryption.active-key-alias=## Keystore location.#threedss.encryption.keystore-location=## Keystore password.#threedss.encryption.keystore-password=## Keystore type. Allowed keystore types: PKCS12 and JCEKS.#threedss.encryption.keystore-type=## Property which indicates the type of the 3DS Server Admin UI user authentication. Two possible values are allowed:## - internal - meaning the user authentication is handled by the 3DS Server Admin itself, storing the user credentials data in# its own database.# - external - meaning the user authentication is handled by an external OIDC provider. In multi-tenant setup,# different OIDC providers can be configured per tenant (organization).## If property not set, the default value is internal, i.e. authentication will be handled by the 3DS Server Admin itself.##threedss.admin-security.iam=internal## Property which indicates the method for resolving the organization identifier when external mode of authentication# is used. Two possible values are allowed:## - header - meaning the organization identifier is resolved from the value of the "x-nca3dss-orgsubdomain"# attribute in the HTTP request header.# - subdomain - meaning the organization identifier is resolved from the subdomain of the server address the HTTP# request originated from.## If property not set, the default value is subdomain.## threedss.external-iam.admin-security.oidc-resolution-method=subdomain## Property for configuring the subdomain at which the OIDC provider for default organization is mapped.# E.g if set to "default", the users from Default organization will use the domain# default.<3DSS-Admin-host>:<3DSS-Admin-port> for authentication and access to the 3DS Server Admin Application.## This property is required when "threedss.admin-security.iam" is set to "external"##threedss.external-iam.default-organization-oidc-provider.organization-subdomain=## Property for configuring client id for the OIDC provider used for Default organization.## This property is required when "threedss.admin-security.iam" is set to "external"##threedss.external-iam.default-organization-oidc-provider.client_id=## Property for configuring client secret for the OIDC provider used for Default organization.## This property is required when "threedss.admin-security.iam" is set to "external"##threedss.external-iam.default-organization-oidc-provider.client_secret=## This property indicates the name of the claim inside the ID token that contains the user roles.# If it is not specified (i.e. empty) it defaults to "roles".##threedss.external-iam.default-organization-oidc-provider.roles_claim_name=roles## Property for configuring issuer URL for the OIDC provider used for Default organization.## This property is required when "threedss.admin-security.iam" is set to "external"##threedss.external-iam.default-organization-oidc-provider.issuer_url=## Property for configuring logout URL for the OIDC provider used for Default organization.# This property should be configured only if the OIDC provider does not support the OpenID Connect RP-Initiated Logout# specification (https://openid.net/specs/openid-connect-rpinitiated-1_0.html), i.e. the well known endpoint of the OIDC provider# does not return an end_session_endpoint.##threedss.external-iam.default-organization-oidc-provider.logout_url=## Enables the 3DS Server Admin application to start an Eureka Service Registry.# The default value is true. If there is an external registry and Eureka is the desired option, then this value# should be set to false.#threedss.discovery-server.enable=true## Property which enables the Eureka Discovery Client implementation of spring cloud DiscoveryClient.# Default value is true.#eureka.client.enabled=true## Comma separated URL's to discovery servers that will be used by service discovery to fetch the 3DS Server endpoints.#eureka.client.service-url.defaultZone=## Indicates whether or not this instance should register its information with eureka server for discovery by others.# The Admin server and client should not be discoverable in the application#eureka.client.register-with-eureka=false## Indicates whether or not this instance should be able to fetch the registry from the discovery server.#eureka.client.fetch-registry=true## Disables Eureka Server self-preservation mode. Self preservation is a mechanism that stops evicting the instances when# the heartbeats are below the expected threshold.#eureka.server.enable-self-preservation=false## Disables the Eureka dashboard. Eureka dashboard is a small web application that can be used to monitor the Eureka# configuration, registry and registered clients.#eureka.dashboard.enabled=false## Property which enables the ECS Discovery Client implementation of spring cloud DiscoveryClient.# Default value is false.#nca.acquiring.aws.ecs-discovery.enabled=false## Property which has the value of the AWS cluster in which the tasks will be searched.# Must be specified if ecs.client.enabled has the value of true.#nca.acquiring.aws.ecs-discovery.cluster=## The names of the 3ds Server applications, which will be used by the Discovery Server.# Eureka will use these as the names of the Applications when searching for instances.# ECS will use these as the names of Task containers when searching for instances.#threedss.server.application.name=3ds-server## Property controlling whether IAM database authentication is enabled. This feature is only available# for MySQL and PostgreSQL databases running on AWS. See more information here:## When the IAM database authentication is enabled, the ${spring.datasource.password} and ${threedss.db.flyway.password}# properties should not be configured.## The default value is false, i.e. by default, the standard way of authentication using username/password is performed.# nca.acquiring.aws.iam-role-db-auth.enabled=false## An AWS KMS symmetric key to be used to decrypt an application property value. Such property value can be defined# by means of ENC(cypherText) operator. The argument is an KMS encrypted and then Base64 encoded value that can be# generated using AWS CLI: https://awscli.amazonaws.com/v2/documentation/api/latest/reference/kms/encrypt.html# Example of ENC usage:# spring.datasource.password = ENC(AQICAHhX8AfIOKvwU4uJC5u+Iekn7vfjf9c1YuW+....)# The encryption key is referenced here either with its ID or its alias and should be of the same format as the key-id# accepted in AWS CLI encrypt command. Example:## nca.acquiring.aws.property-kms-decryption.key-id=alias/prod-3ds-server-config-properties-encryption-key |