Configuring WebSummoner

This section describes supported ways of automatic WebSummoner configuration.

Tip

To quickly configure and run WebSummoner with defaults type:

./cm websummoner start

WebSummoner can be configured in two ways:

• Using Docker containers (default)
• Using standalone binaries (when --use-drivers is added)

To view the list of available commands:

./cm websummoner --help

To launch command:

./cm websummoner <command> [args...]

Supported commands are:

Command	Meaning
args	Print WebSummoner command line arguments
cleanup	Removes WebSummoner traces
configure	Creates WebSummoner configuration file (implies download)
download	Downloads WebSummoner binary or container image
start	Starts WebSummoner process or container (implies download and configure)
status	Shows actual configuration status (whether WebSummoner is downloaded, configured or running)
stop	Stops WebSummoner process or container
update	Updates WebSummoner and configuration to latest version

To see supported flags for each command append --help:

./cm websummoner start --help

Example commands

download command downloads latest or specified WebSummoner release as standalone binary or container image:

./cm websummoner download --version 1.2.1 --force

This command does nothing when already downloaded. Use --force flag to download again.

configure command in addition to downloading WebSummoner also downloads container images or webdriver binaries and generates configuration file:

./cm websummoner configure --browsers firefox:>45.0;opera:53.0 --last-versions 2 --tmpfs 128

Use --browsers to limit browsers to be configured, --tmpfs — to add Tmpfs support, --last-versions — to limit how many last browser versions to download. If you wish to download all available versions — specify --last-versions 0.

start command configures WebSummoner and starts it:

./cm websummoner start

By default WebSummoner data is stored in ~/.websummoner/websummoner but you can specify another directory using --config-dir flag. To download images with VNC server (to see live browser screen) use --vnc flag:

./cm websummoner start --vnc

To override WebSummoner listen port add --port flag:

./cm websummoner start --port 4445

To override WebSummoner startup arguments sessions add --args flag:

./cm websummoner start --args "-limit 10"

To download images from private registry — log in with docker login command and add --registry flag:

docker login my-registry.example.com # Specify user name and password
./cm websummoner start --registry https://my-registry.example.com

Downloading only some browser versions

By default CM downloads browser images corresponding to 2 last versions of Firefox, Chrome and Opera. To download concrete browser versions — use --browsers flag as follows.

Download concrete versions of Firefox and Chrome:

./cm websummoner start --browsers 'firefox:51.0;firefox:55.0;chrome:66.0'

Download a range of Firefox versions and 3 last Opera versions:

./cm websummoner start --browsers 'firefox:>51.0,<=55.0;opera' --last-versions 3

Using an existing configuration file

In some cases you may want to configure WebSummoner to use an existing browsers.json configuration file. This is mainly needed to always use the same browser versions instead of downloading latest versions. To achieve this:

1. Prepare a desired browsers.json configuration file.

2. Launch cm with --browsers-json flag:

   ./cm websummoner start --browsers-json /path/to/browsers.json

Legacy spelling

cm selenoid … is accepted as an alias of cm websummoner …, so scripts written for Selenoid keep working unchanged.