3DS Server Admin Configuration Properties

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
server.port=
### Logging
logging.config=classpath:log4j2-prod.xml
#
# 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 sender of the email messages generated for user management purposes
#
auth.email.from=
#
# The fully qualified base URL of the installed 3DS Server Admin application instance, the value will be 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=
#
# Fully qualified URL of the 3DS Server Admin application instance.
#
threedss.frontend.configs.backend-api=
#
# List of fully qualified URL of the 3DS Server instance. The list is used for the Admin application to display
# statistical information about each instance and notify the instance whenever a 3DS Server Configuration is updated
# in the database. The URL need to contain the prodocol, hostname, port, and if needed, the context path.
#
# This property is a comma-separated value.
#
# Example: http://3ds.server.instance.one,https://3ds2.server.instance:5000,https://3ds2.server.instance/3ds-server-instance/
#
threedss.instance.endpoints=
#
### 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
### 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 * * *