VirtServer Settings File

# H2 Database 
configurations
database:
# the name of your 
JDBC driver......

VirtServer stores virtual service data in a database. It uses the settings to work with this database.

 # Logging settings. logging:

# The default level of all loggers. Can be OFF, ERROR, WARN, INFO, DEBUG, TRACE, or ALL.
level: INFO

loggers:
"com.smartbear": INFO
"com.hubspot.dropwizard.guice.AutoConfig": WARN
appenders:
  - type: console
  timeZone: Europe/Stockholm

Various logging settings: default logging level, individual logger classes and their logging level, and so on.

# Logging settings for virts.
virtLogging:

Logging settings for individual virtual APIs.

# Enables har logging for virts. 
Logs are saved in user_home/.readyapi/logs/virts dir

Logs are saved as individual files in the specified folder.

enableHarLog: false

Enable logging.

usePrettyPrint: false

Use pretty print for log files.

# TimeZone
server: 
requestLog:  
timeZone: Europe/Stockholm

Specifies the time zone for the log.

applicationConnectors:
# For security reason we only 
allow communication over https

VirtServer connection settings.

type: https

The protocol (https only).

port: 9090

The port number.

keyStorePath: 
.virtserverkeystore
Example: 
apprwisb01.corp.bayadv.jks

The file name of the Java keystore that contains the VirtServer certificate.

keyStorePassword: 
'!serverSecret!
'Example: 'Veda2014!Pass'

The password for accessing the keystore.

keyManagerPassword
Example: 'sQRXPTF7CKBw'

If both keyStorePassword and keyManagerPassword are the same, use keyStorePassword. keyManagerPassword does not need to be added. If both fields are used and have different values, please add both fields and values to the configuration.

validateCerts: false

excludedCipherSuits  
- TLS_AES_128_GCM_SHA256

List of cipher suits which won't be used for client-server communication process.

supportedCipherSuits   
- TLS_AES_256_GCM_SHA384

List of cipher suits which will be used for client-server communication process.

adminConnectors:

type: https
port: 9091
keyStorePath: 
.virtserverkeystorekeyStorePassword: 
'!serverSecret!'
validateCerts: false
excludedCipherSuits   
- TLS_AES_128_GCM_SHA256
supportedCipherSuits  
- TLS_AES_256_GCM_SHA384

For internal use by VirtServer. Do not change these settings.

# VirtServer configuration
virtServer:

VirtServer properties and HTTPS settings.

# The context path.
contextPath: /api/${API_VERSION}

We need this instead of applicationContextPath so we can process variables (such as version) in the String

# Maximum number of activity log to keep
maxActivityLog: 20 

The maximum number of records in the  activity log.

This log stores information on deploying and downloading virtual services, starting and stopping them, and so on.

# Maximum number of transaction logs to keep. 
Storing many transaction logs may consume a lot of memory. 
Keep this as low as possible.maxTransactionLog: 20

The maximum number of records in the transaction log for a virtual API.

This log stores information on individual requests. Storing too many records may consume lots of memory. Set reasonable values.

# Strip quotes from boolean and number values 
in JSON payloads.
stripQuotesFromBooleansAndNumbers: true

If set to true, any boolean or number JSON payload values in Conditional Match responses will be stripped of quotes.

Quotes in those values can get introduced due to the response template having quotes around property expansion.

# SSL configuration for virts
# virtSSL:

SSL certificate settings for virtual services.

Uncomment, if needed.

# virtKeystorePath: /path/.keystore

The keystore file name.

# virtKeystorePassword: 
keystoreSecret 

The keystore password.

# virtKeyPassword: keySecret

A security key password.

# virtTrustStorePath: /path/.keystore

The CA certificate file that is used to establish trust.

# virtTrustStorePassword: trustStoreSecret 

The password of the trust certificate.

# Security settings
# securityConfig:

Security settings of VirtServer.

Uncomment, if needed.

# sessionTimeLimitEnabled: 
false

Enable a timeout for user sessions in the VirtServer web interface, connections from ReadyAPI Virtualization, and the command line sessions.

The next two parameters specify the time after which a user will be logged out.

# idleTimeout: 60 

Time (in minutes) after which an idle user will be logged out of the VirtServer web interface.

# sessionTimeoutLimit: 480

Time (in minutes) after which a user will be logged out of the VirtServer web interface regardless of their activity.

# passwordComplexityMode: 
false

Enable the password complexity mode.If this option is enabled, the password must be at least 6 characters long and must contain at least one number and at least one capital letter.

# lockoutTimeout: 0  

Specifies in minutes how long a user will be locked out when the user enters a wrong password for five times.

To disable the option, set it to 0 or comment it out.

# 
oldVersionsCompatibility: 
true

Set the option to false to prohibit connections to VirtServer by using ServiceV 2.8 or older.

Default value: true.

# LDAP settings
# ldapConfiguration:

Settings of connection between VirtServer and LDAP.

To learn more about LDAP, see this topic.

# ldapProviderUrl: 
'ldap://<your host>:389'

Specifies the address of the LDAP server.

# OIDC settings
# oidcConfiguration:

Settings of connection between VirtServer and OIDC.

To learn more about OIDC, see this topic.

Client id.
oidcClientId: '0oad4h2tg5mnJIJ2C5d7'

This should be provided by your OIDC admin from the Virtsever app config.

 # Provider url.

This should be provided by your OIDC admin based on your okta org.

# oidcProviderUrl: 'https://<your okta org 
url>/oauth2/default'oidcProviderUrl: 
'https://dev-06865876.okta.com/oauth2/default' 

# Token revocation url.

This should be the same as in your OIDC provider.

# oidcTokenRevocationUrl: 'https://<your okta 
org url>/oauth2/default/v1/revoke'oidcTokenRevocationUrl: 
'https://dev-06865876.okta.com/oauth2/default/v1/revoke'   

To be provided by the OIDC admin based on the Audience URI / Entity ID configured for the authorization server.

# Group name field
oidcGroupNameField: 'groups_access'

# Admin group filter(comma separated)
oidcAdminGroupFilter: [VirtServer Admin,admin1,admin2]

# Optional admin group filter (comma separated)
# oidcAdminGroupFilter: [admin1,admin2]

# User group filter(comma separated)
oidcUserGroupFilter: [VirtServer User,user1,user2]

proxyConfiguration:

# Proxy mode: Auto, Manual, or None 
(None or empty means proxy is disabled
)mode: Auto | Manual | None

# Settings for Manual proxy mode
type: HTTP | SOCKS
host: <proxy-host>
port: <proxy-port>
excludes: <comma-separated values> # 
Domains to exclude from proxy

# Credentials (for both Auto and 
Manual modes if required)
username: <proxy-username>
password: <proxy-password> 

This configures proxy settings in VirtServer, allowing VirtServer to run on a different proxy than ReadyAPI.