Installation

Snapshot Debian Packages

Should you want to get started with the latest RSB snapshot and have all the required packages and dependencies installed in a convenient manner, simply run the following command:

sudo apt-get install rsb-snapshot r-properties r-rsbxml r-rsbjson

These packages are found in this repository: deb.openanalytics.eu. Follow this guide to add this repository to your system.

Prerequisites

RSB needs R, several R packages and also relies on RPooli for interacting with R.

If you haven't installed R already, consider doing so using the r-base and r-rj packages from deb.openanalytics.eu

The R packages can be installed in two ways:

  • install.packages(c("properties", "RSBXml", "RSBJson"), repos = "http://repos.openanalytics.eu", type = "source")
  • Install the Debian packages: r-properties, r-rsbxml, r-rjsonio and r-rsbjson from deb.openanalytics.eu

RPooli is bundled with RSB in its full distribution (which also contains a Tomcat web container).

If you chose not to use the full distribution of RSB, you'll need to install RPooli yourself, which is easily done with the RPooli package from deb.openanalytics.eu

WAR-only Deployment

RSB should deploy fine on any Java web-container supporting Servlet 2.5.

To ensure an RSB instance is running and can access its default RPooli pool, browse to or curl:

http://${RSB host}/rsb/api/rest/system/health/check

If all is good, RSB should respond: OK

Full Distribution Installation

Simply unzip the distribution Zip archive in your preferred location and ensure the files in the bin directory are executable.

Configuration

RSB is configured with a unique JSON file named rsb-configuration.json, which must be located either in /etc/rsb or at the root of the JVM classpath (for example, in Tomcat's lib directory).

Samples

Here are a few examples of configuration files:

Default Configuration

If RSB can't locate a configuration file, it will try to generate one (named rsb-configuration.json, as above) and store it either in /etc/rsb or in WEB-INF/classes. Here is the content of the default configuration:

In this configuration, $RSB_HOME$ is replaced by either, and in order of preference:

  • The user's home directory, if it exists and is writeable,
  • The rsb.war WEB-INF directory, if it is writeable,
  • The operating system temporary directory

If RSB generates such a default configuration file inWEB-INF/classes, it is recommended to review it so it uses the desired values and move it to /etc/rsb, as discussed in the previous section.

Description

Configuration attributes are documented on the persisted configuration classes.