VirtServer in Docker

This topic describes how to use Docker with ReadyAPI on the Hyper-V virtualization platform. To do that, use the same environment you use to run your Docker images. There are no specific requirements for this.

To learn more, see the Docker documentation:

• Docker EE

• Docker CE

To run ReadyAPI tools in Docker containers on other virtualization platforms, additional configuration may be required. Please see the corresponding documentation.

docker.io/smartbear/ready-api-virtserver:latest

Required. The image to run. To get a specific VirtServer version, specify it in the tag instead of latest. You can omit docker.io/ at the start of the path.

-e VirtServerLicenseServer=192.0.2.0:1099

Required. The IP address and port of the license server.

-e ACCEPT_TOU=true

Required. Accept the SmartBear EULA before starting VirtServer. Must be true.

-p 9090:9090 -p 8000-8010:8000-8010

Required. Exposes ports 9090 and 8000-8010 to the same ports on the host computer. You need to expose port 9090 to work with VirtServer, and any ports you run the virtual services on (in this case, 8000-8010) to connect to them.

-e VirtServerUser=User-Name

Required for the first run and optional in subsequent runs. Creates a user on VirtServer. Can be omitted in subsequent runs as long as the volume persists. If specified, updates user information or creates a new user.

-e VirtServerUserRole=admin

Optional. Gives administrator rights to the created user. Recommended for the first run since only administrators can add new users.

-e VirtServerPassword=Password

A password for the created user. Can be omitted in subsequent runs as long as the volume persists. If specified, updates user information or creates a new user.

-e DockerUser=VirtServerLicenseUser

Optional. The name of the user who checks out the floating VirtServer license. You can see the user name in the License Manager. Default value: root.

-v /path/on/host:/virtserver

Optional. Commands Docker to create a shared file system (volume) for the VirtServer image. This is useful for sharing files/folders in the host machine into the container. As per Docker specification, the path on the left side of the colon should be a fully qualified path to a folder on the host system that you intend to mount into the container. The folder inside the container should be on the right side of the colon. Usually, it is /virtserver. You can then create the /ext folder in the volume and place the .jar files you need to import in it..
For more information about working with Docker volumes, see the Docker documentation.

-e VirtServerClassPathExt=/virtserver/MyExt

Optional. The folder to load extension .jar files from. Default value: /virtserver/ext.

-e UseHTTPS=true

Optional. Commands VirtServer to use only HTTPS for connections to the client. By default, VirtServer uses a pre-generated self-signed certificate. Use the -e CertificateSubject command to generate a new self-signed certificate. Possible values: true, false. If no value is specified, VirtServer uses HTTP.

-e USAGE_STATISTICS=true

Optional. Commands the VirtServer to send usage statistics to SmartBear. Possible values: true, false. If no value is specified, the information is sent.

-e VirtServerClassPathExtras=sample:sample2

Optional. The additional elements to be added to the classpath when running VirtServer. Separate the elements with a colon.

-e CertificateSubject=/C=US/ST=MA/L=Somerville/O=SmartBear/OU=com/CN=virtserver.smartbear.local

Optional. The name properties for the generated self-signed certificate. If not specified, no certificate is generated.

-e CONFIG=/virtserver/newconfig.yml

Optional. The environment variable directs VirtServer to use an alternative configuration file that you want to supply externally. To implement this, utilize the -v flag to mount a volume, placing the .yml settings file in a designated folder on your host machine. Next, mount that folder into your Docker volume at /virtserver and specify the container path to the settings file (e.g., /virtserver/newconfig.yml) for this environment variable. If unspecified, the default file bundled in the Docker image is utilized.

-e JVM_OPT_Xmx=-Xmx2000m"

Optional. Additional JVM options for VirtServer. Full syntax: -e JVM_OPT_<UNIQUE_NAME>="<OPTION><VALUE>".

-e SlmServerUrl=ServerUrl:Port

Required only when using onpremise license server.. It is used for installing Smartbear ID - based License from the onpremise SLM license server. It should include the IP address and port of the SLM license server. If port is not specified it will automatically add default port for server on-premise 40892.

*Required only when your license is hosted onpremise. Do not include if your license is hosted on SmartBear license servers.

-e SlmAccessKey=AccessKey

Required for SmartBear hosted license or for onpremise license server when authentication required. Access key is required when using SmartBear hosted ID-based licenses or when license is hosted in onpremise license server option and Access for Everyone is switched off and authentication is enabled. It is not needed if your onpremise license server is configured for 'access to everyone'.

To run VirtServer in a Docker container using a legacy file based license:

To run VirtServer in a Docker container using a new SmartBear ID-based license use the following command lines relative to where your license is hosted (replacing with your own values):

SmartBear ID-based license hosted on SmartBear license servers:

SmartBear ID-based license hosted in customer on-premise license servers: