Fork me on GitHub

Release Information

Rio is distributed under the Apache License, version 2.0.

Rio requires JDK 1.7.x or greater.

Although not required, setting the JAVA_HOME environment variable to point to the home of a Java 7 (or later) installation is always a good idea.

Rio is distributed with dependencies. Dependencies are additional software required for running Rio. Note that each of these libraries is subject to the respective license; check the respective project distribution/website before using any of them in your own environment.

The distribution includes the following third party technology: Apache River 2.2.2 (Jini), Hyperic SIGAR, Commons Compress 1.0, Groovy, SLF4J, Logback and the Prefuse Visualization Toolkit.


To install Rio on Linux or OS/X, unzip the distribution package to the desired installation directory. For example, to install into /opt:

unzip -d /opt

This creates a directory called rio-5.6.6 under /opt

To install Rio on Windows, unzip the distribution package to the desired installation directory. You should use a zip application such as 7zip, not the built-in folder decompression. Note that both Windows and Java 5 have some issues with long file names and file paths, as well as with spaces in directory names. We recommend installing into a directory of your chosen drive, and ensuring that directory names do not have spaces (like C:\Program Files).

Examining the distribution

Once you have unzipped the distribution, you will have a rio-5.6.6 directory containing the following items:

  • bin - The directory that contains command to start Rio services
  • config - Directory that contains configuration for Rio services and platform
  • deploy - The default deploy directory used to serve deployed application resources.
  • docs - The directory that contains API documentation, and other documentation
  • examples - Contains examples of how to develop and deploy applications using Rio
  • lib - The directory where the JAR files are located.
  • lib/hyperic - The directory where Hyperic SIGAR JAR files are located.
  • lib/logging - The directory where logging JAR files are located.
  • lib/resolver - The directory where Rio and Aether resolver JAR files are located.
  • lib-dl - The directory where the client (download) JAR files are located.
  • logs - This directory contains log files for Rio
  • policy - The directory that contains a policy file
  • src - Source code for Rio

Developing Services

You can look at the examples provided, as well as checking put the following tutorials:


Please make sure to examine the examples provided. An overview of all the examples can be found here.

Project Creation

You can create a Rio project in seconds using the Rio Archetype. Simply run:

RIO_HOME/bin/rio create-project

You will be prompted to enter the artifactId, service to create (this will be the classname of the service interface), the groupId, version and package name.

Starting Rio

The RIO_HOME/bin directory contains starter script (and .cmd) files to start Services and Utilities provided by Rio.

Note, you should make sure that you set the RIO_HOME environment variable to point to the directory that you have installed the Rio distribution.

The rio script is the the command and control utility for starting Rio services and the Rio command line interface. All of the other scripts are wrappers around the rio script. The convention for starting services using the rio scripts is as follows:

  • rio start service-starter

For example:

  • rio start cybernode

    Will use the config/start-cybernode.groovy file

  • rio start all

    Will use the config/start-all.groovy file

The following scripts are shortcuts for starting the basic services in Rio:

  • cybernode - Starts a Cybernode and a Webster on an anonymous port
  • monitor - Starts a Provision Monitor, a transient Jini Lookup service and a Webster on port 9010
  • webster - Starts a Webster on port 9010
  • startall - Starts a Webster on port 9010, a Cybernode, Provision Monitor and a transient Jini Lookup Service

By just running rio, you will be put into the interactive command line shell:

Welcome to the Rio Interactive Shell Program. You can interact
with the Rio using the following commands :

list     http     deploy   destroy  dir
help     pwd      jconsole redeploy set
undeploy cd       ls       stats

For help on any of these commands type help [command].
To leave this program type quit

rio> _

Back to top

Version: 5.6.6. Last Published: 2018-10-25.