VirtServer stores its settings in the virt-server.yml settings file.
Location
The location where VirtServer searches for the settings file depends on the operating system and on the permissions VirtServer or its installer has:
-
Windows
<user folder>/.readyapi/virt-server/virt-server.yml
-
Linux and macOS
If you installed or if you run VirtServer with root access (
sudo <path>/virtserver.sh
):/etc/virt-server.yml
Without root access:
<user folder>/.readyapi/virt-server/virt-server.yml
-
VirtServer 2.0.1 and earlier
<VirtServer>/bin/virt-server.yml
Note: VirtServer loads the settings file from the locations mentioned above by default. You can create your own settings file and specify it in the VirtServer command line. This will not work if you run VirtServer as a service (daemon), though.
Settings
Some settings in this .yml file are for internal use by VirtServer. We recommend that you be careful when changing the file. If something goes wrong after you changed the settings, undo your changes, or re-install VirtServer.
virt-server.yml |
Comments |
# H2 Database configurations |
|
# TimeZone |
|
# Logging settings. |
|
applicationConnectors: |
VirtServer connection settings. |
# For security reasons, we only allow the communication over https |
|
port: 9090 |
The port number. |
keyStorePath: .virtserverkeystore |
The file name of the Java keystore that contains the VirtServer certificate. |
keyStorePassword: '!serverSecret!' |
The password for accessing the keystore. |
validateCerts: false |
|
adminConnectors: |
For internal use by VirtServer. |
# Logging settings for virtual services. |
Logging settings for individual virtual APIs. |
# Enables har logging for virtual services. |
Logs are saved as individual files |
enableHarLog: false |
Enable logging. |
usePrettyPrint: false |
Use pretty print for log files. |
# VirtServer configuration |
|
# The context path. We need this instead of applicationContextPath |
|
contextPath: /api/${API_VERSION} |
Note: contextPath is used internally. Do not change. |
# The maximum number of the activity logs to keep |
The maximum number of records in the activity log for VirtServer. |
# The maximum number of the transaction logs to keep. |
The maximum number of records in the transaction log for a virtual API. |
# SSL configuration for virtual services |
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 |
Security settings of VirtServer. Uncomment, if needed. Note: In case these settings are absent, add them manually. |
#sessionTimeLimitEnabled: false |
Enable a timeout for user sessions in the VirtServer web interface, connections from ReadyAPI Virtualization, and the command line sessions. |
#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. |
#lockoutTimeout: 10 |
Specifies in minutes how long a user will be locked out when the user enters a wrong password for five times. |
#oldVersionsCompatibility: true |
Set the option to false to prohibit connections to VirtServer by using ServiceV 2.8 or older. |
#ldapConfiguration: |
Settings of connection between VirtServer and LDAP. |
#ldapProviderUrl: 'ldap://<server-host>:389' |
Specifies the address of the LDAP server. |
Override settings
If you have ever changed VirtServer settings via the web interface, there will be an additional settings file, virt-server-override.yml, and the settings will be stored there. They will override the settings configured in virt-server.yml.
To change those settings via settings files, you should:
- Change them in virt-server-override.yml.
– or –
- Delete them from virt-server-override.yml and change them in virt-server.yml.
Add a parameter for parsing legacy JDBC connection strings
As of Java 17.0.3 and from adopting 17.0.4 in ReadyAPI 3.41.0, the '_' characters are no longer allowed in JDBC connection strings.
If your existing tests have the '_' in their JDBC connection string, please add and use this JVM option:
-Dcom.sun.jndi.ldapURLParsing="legacy".