smartbear/ready-api-virtserver

•Updated about 1 month ago

Docker Image containing released builds of ReadyAPI VirtServer.

Image

1M+

smartbear/ready-api-virtserver repository overview

⁠Introduction

VirtServer⁠ allows SmartBear users to run Virtual Services in a server environment. It delivers the most value when used together with ReadyAPI⁠.

⁠Before You Start

To run VirtServer, you need a valid license. Purchase a license from the SmartBear website⁠.
To run VirtServer in a Docker container using a SmartBear ID–based license, run the docker login command first.
Expose all ports used in the configuration and ensure your network allows traffic on those ports.

⁠Environment Variables

When running docker run (or the equivalent in Docker Cloud or similar platforms), you pass configuration values to the container using environment variables.

In Docker Cloud and similar platforms, you typically configure these variables in a table view. When running from the command line, define them as environment variables in the container configuration.

The following parameters are available:

Parameter	Required	Description
`VirtServerUser`	✅*	User name added to the VirtServer user database as an administrator.
`VirtServerPassword`	✅*	Password for `VirtServerUser`.
`VirtServerUserRole`	✅*	Assigns administrator rights to the created user. Use `admin` for the first run because only administrators can add new users.
`ACCEPT_TOU`	✅*	Accept the Terms of Use⁠ by setting `ACCEPT_TOU=true`. If you use a mapped volume, VirtServer stores this acceptance and you do not need to set it again.
`VirtServerLicenseServer`	✅	`hostname:port` of the floating license server. If omitted, the server expects a trial license passed using `VirtServerLicense`.
`PUID`	➖	User ID.
`PGID`	➖	Group ID.
`TZ`	➖	Time zone.
`VirtServerClassPathExt`	➖	Location of the `ext` directory for adding additional JAR files.
`DockerUser`	➖	User name used instead of root when requesting a license from the floating license server. If not set, the container uses root.
`UseHTTPS`	➖	Enables HTTPS communication with VirtServer. Default value: `true` (recommended).
`CertificateSubject`	➖	Subject string used when generating a self-signed certificate. Example: `/C=US/ST=MA/L=Somerville/O=SmartBear/OU=com/CN=virtserver.smartbear.local`.
`CONFIG`	➖	Image-relative path to an alternative configuration file.
`JVM_OPT_<unique_id>`	➖	Additional JVM options. Use the format `JVM_OPT_1=-Dproperty=value`.
`USAGE_STATISTICS`	➖	Sends usage statistics (default: `true`).

* Required only for the initial run. If you reuse the same storage volume (/virtserver) between runs, VirtServer retains its stored configuration and user data. In this case, specifying VirtServerUser and VirtServerPassword creates the user if it does not exist or updates the existing user’s record. It does not modify other users.

⁠Other Parameters

Parameter	Required	Description
`-v {path}:/virtserver`	➖	Mounts `/virtserver` to `{path}` on the local file system.
`-p 9090:9090`	✅	Publishes port 9090 from the container to the host. This is the port for the admin console.
`-p 8000-8010:8000-8010`	✅	Publishes the port range used by the virtualized APIs.

⁠Application Setup

Default Web UI address: https://localhost:9090

⁠Example Run Command

docker run -d \
  --name virtserver \
  -v /opt/virtserver:/virtserver \  # optional
  -p 9090:9090 \
  -p 8000-8010:8000-8010 \
  -e UseHTTPS=true \
  -e ACCEPT_TOU=true \
  -e VirtServerUser=john.smith \
  -e VirtServerPassword=secret \
  -e VirtServerUserRole=admin \
  -e DockerUser=virtserver1 \
  -e VirtServerLicenseServer=172.0.64.128:1099 \  # optional
  --restart unless-stopped \
  smartbear/ready-api-virtserver:latest

⁠Alternative Run Commands

SmartBear ID–based license hosted on SmartBear license server

docker run -v /opt/virtserver:/virtserver \
  -p 9090:9090 \
  -p 8000-8010:8000-8010 \
  -e VirtServerUser=User-Name \
  -e VirtServerPassword=Smith \
  -e VirtServerUserRole=admin \
  -e DockerUser=VirtServerLicenseUser \
  -e ACCEPT_TOU=true \
  -e SlmAccessKey=<SLM access key> \
  smartbear/ready-api-virtserver:latest

SmartBear ID–based license hosted on a customer-managed on-premises license server

docker run -v /opt/virtserver:/virtserver \
  -p 9090:9090 \
  -p 8000-8010:8000-8010 \
  -e VirtServerUser=User-Name \
  -e VirtServerPassword=Smith \
  -e VirtServerUserRole=admin \
  -e DockerUser=VirtServerLicenseUser \
  -e ACCEPT_TOU=true \
  -e SlmServerUrl=<SLM license server address:40892> \
  -e SlmAccessKey=<SLM access key> \
  smartbear/ready-api-virtserver:latest

⁠docker-compose

version: "3.8"

services:
  virtserver:
    image: smartbear/ready-api-virtserver:latest
    container_name: virtserver
    ports:
      - "9090:9090"
      - "8082:8082"
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Etc/UTC
      - UseHTTPS=true
      - ACCEPT_TOU=true
      - SlmServerUrl=https://license-server.example.com:443   # optional
      - SlmAccessKey=YOUR_ACCESS_KEY_HERE
    volumes:
      - ./virtserver:/virtserver # optional
    restart: unless-stopped

Start the service:

docker-compose up -d

Tag summary

Recent tags

Content type

Image

Digest

sha256:b6658da77…

Size

313 MB

Last updated

about 1 month ago

docker pull smartbear/ready-api-virtserver