Installing

Native Linux

Note

We only currently officially support automated installation for Ubuntu and Debian. If you would like to use a different distribution, contact support and we will be happy to add support for you.

Native Linux is the preferred distribution of RV-Match, as it comes with full library support and the fastest execution speed of any of our distributions. Only 64-bit Linux variants are supported.

To install RV-Match on native Linux, simply:

  1. Download and install the Oracle Java 8 (or higher) JRE or OpenJDK 8 JRE for your architecture.
  2. Download the native version of RV-Match for Linux.
  3. Run the JAR file and follow on-screen instructions with sudo java -jar rv-match-linux-64-1.0-SNAPSHOT.jar.

See /opt/rv-match/README.md for more information on using RV-Match.

To uninstall RV-Match for Linux, run ./uninstall in /opt/rv-match.

Connecting through a Proxy

In order to verify the validity of your RV license at first install, our installer will make a single connection to our server. We support HTTP, HTTPS, and SOCKS5 proxies for this connection. By default, the installer will attempt to automatically detect proxy settings from your environment. Both GNOME 2.x proxy settings and the $HTTP_PROXY and $HTTPS_PROXY environment variables are supported for automatic detection.

To manually configure proxy files, download and save our sample proxy configuration. By default, the installer will look for this file in ~/proxy.properties. You can manually specify the location of this file by running sudo java -Dproxyconf=proxy.properties -jar [installer jarfile].

Any settings entered in the configuration file will override automatically detected system settings.

If you have any issues with RV-Match licensing in your corporate environment, please contact support for troubleshooting or instructions on installing offline.

Upgrading an Existing Installation

To upgrade an existing installation of RV-Match, simply run wget https://runtimeverification.com/match/upgrade.sh -O upgrade.sh && sh upgrade.sh from any bash terminal and follow the on-screen instructions.

Vagrant VM

The Vagrant VM distribution of RV-Match is the preferred method for running RV-Match on Windows and Mac OS X. It contains a Linux virtual machine with the Linux version of RV-Match, with full library support.

To install RV-Match for Vagrant, simply:

  1. Download and install Virtualbox.
  2. If you are on Windows, download and install Git for Windows. You must select the “use Git and optional Unix tools from the Windows Command Line” option during installation. Restart any command prompt windows and make sure running ssh works and prints usage information.
  3. Download and install Vagrant. If you use a package manager, make sure your version is at least 1.5.2 (or install from the website).
  4. Download and unzip RV-Match for Vagrant.
  5. Run vagrant up in the newly unzipped directory. This will prepare your environment, and will take 10-30 minutes depending on Internet speed.
  6. Run vagrant ssh in the same unzipped directory. This will finish the RV-Match installation.

Note

If on Windows, Vagrant complains about not being able to find a provider, please apply this fix to your Virtualbox installation.

Note

If Vagrant gives a host error in Virtualbox, make sure hardware virtualization is enabled in the BIOS, and that Virtualbox is able to start a machine with 4 cores. If this doesn’t work, please contact our support.

You can then run vagrant ssh in that directory any time to connect to the Vagrant environment containing RV-Match. Simply run kcc from that environment to compile programs. You can access the files on your host system at the preinstalled /host shared folder from the virtual environment. By default, /host contains the contents of the rv-match-vagrant folder on the host operating system, but its location can be configured by changing config.vm.synced_folder ".", "/host" to config.vm.synced_folder "[desired location on host]", "/host" in Vagrantfile, and restarting Vagrant with vagrant halt followed by vagrant up. An example Windows path is C:/Users.

See /opt/rv-match/README.md for more information on using RV-Match.

To uninstall RV-Match for Vagrant, run vagrant destroy in the same directory you ran vagrant up from.

By default, RV-Match for Vagrant comes configured with 4 CPUs and 8GB of RAM in the Virtualbox environment. To change these resource settings, open the virtualbox application, make sure the Vagrant VM listed on the sidebar is shut down (or shut it down by right clicking it and pressing Close -> Power Off), and adjust the system resources in the machine’s settings before restarting it with vagrant up.

For more information on advanced Vagrant options and configuration, see here.

Connecting through a Proxy

Vagrant supports connection through both HTTP and HTTPS proxies for licensing purposes, similar to the native Linux version.

To configure a proxy connection, simply edit the relevant block of the Vagrantfile that describes proxy configuration. Comments are available explaining the available options. Once the proxy is configured in the Vagrantfile, the RV-Match installer will automatically use these settings. To specify settings for the RV-Match installer to use manually, simply edit /home/vagrant/proxy.properties with the desired settings, following the format specified in the comments.

If you have any issues with RV-Match licensing in your corporate environment, please contact support for troubleshooting or instructions on installing offline.

Upgrading an Existing Installation

To upgrade an existing installation of RV-Match, simply run wget https://runtimeverification.com/match/upgrade.sh -O upgrade.sh && sh upgrade.sh from any bash terminal and follow the on-screen instructions.

Windows 10 (Via Windows Subsystem for Linux)

To install a version of RV-Match capable of executing C code which does not depend on any Windows target libraries, you can use the Windows Subsystem for Linux, if you have a copy of Windows 10.

To install RV-Match on native Windows, simply:

  1. Install the Windows Subsystem for Linux according to the provided installation instructions, if it has not already been installed. Note that we only support the Ubuntu version of Windows Subsystem for Linux.
  2. Run sudo apt-get update; sudo apt-get install default-jre to install Java within your Windows Subsystem for Linux installation. Note that running the installer with a native Windows installation of Java will not work correctly.
  3. Download the installer for RV-Match for Windows 10.
  4. Run sudo java -jar rv-match-windows-1.0-SNAPSHOT.jar in the directory containing the installer from within a Bash terminal.

See /opt/rv-match/README.md within your Windows Subsystem for Linux installation for more information on using RV-Match. Note that you will have to be within a Bash terminal to use the installed software.

To uninstall RV-Match for Windows, run ./uninstall in /opt/rv-match from within the Bash terminal.