Install appliance

Install appliance

Download the .ova fileĀ here

Import the .ova file in vCenter or VMware workstation, and start the appliance.

The appliance is configured for DHCP and displays the configured IP address on the welcome screen:

If you for some reason need to login to the appliance, the credentials are: vroast/Hey^#&T3663

Run docker image

Download the Docker image here

Import the image into docker:

docker load -i vroast.<version>.tar


Create a docker volume with:

docker volume create vroastvol


Now start the image with:

docker run --detach -p 80:80 -v vroastvol:/data --restart always <imageID>

Install CLI

The CLI client can be downloaded once logged in to the portal.
The default username/password is Admin/TheRoast123.

There you will find downloads for the Windows, Ubuntu and MacOS under the ‘Download CLI’ header. Download the appropriate one for your platform and unzip it in a sensible folder. It is handy to include this folder in your path so you can run it from anywhere. The commands available in the CLI are listed by just issuing the CLI without any command:



If you need help on the commands from the CLI, just type:

vRoast [verb]


This will give you help on the specified command.
The first thing you want to do is set the target of the CLI to the machine hosting the API (the one you are reading from right now). You do this by issuing the command:

vRoast target --url http://[host]:[port]


The CLI should respond with a message like this:

Set API target to http://localhost:80.


Next thing is to logon, this is done by issuing the command:

vRoast login -u Admin -p ******


And you are ready to configure your vRoast setup.
For security purposes you might want to change the default password first with the CLI by:

vRoast set-admin-password -p ***


Note: because the access to the API is token based, changing the password does not mean you will immediately unable to connect, your login token will work until it expires.

Config first job

The typical use-case for vROAST is to use it to push your code to a vRO machine, a so called ‘push’ config.
In this configuration a GIT repository serves as the intermediary, you push your changes to GIT, and vROAST will monitor this GIT repository for changes. As soon as a change is committed to the GIT repository, vROAST will convert the typescript to javascript and push it to vRO.

The prerequisites for setting up this job are:

  • vRO server addresss and port of API
  • vRO user credentials
  • An empty remote GIT repository (may contain
  • A branch must exist in the GIT repository
  • GIT credentials
  • All plugins active on the vRO server must exist on (with matching version), send .dar file to Dr Ruurd to get your plugin on there

All this data must be entered in a yaml config file. You can find a template here (use ‘save link as’).
When all done, save this file with your info locally somewhere on disk. Now use the CLI to upload this config to vROAST, with:

vRoast set-jobs -c c:\[path to your yml config file]


vROAST will detect that the given GIT repository is empty and because of that will self initiate a ‘pull vRO’ job first. This pull job will place an initial copy of the current vRO contents as typescript (.ts) files in the GIT repository.
Monitor your GIT repo for commits, to see if this is done (should not take more than 2 minutes).

When vROAST is done, clone your repository locally or pull the changes locally if you already cloned it.