Deploying ROSMOD

This page acts as a launchpad for diving into the different aspects of the code, the interfaces provided by each submodule, and learning how everything works behind the scenes. It covers everything from how to create meta-models, how to create domain-specific interfaces and plugins based on those meta-models and provides some guide-lines for such interfaces.

Pre-Requisites for Installation

First and foremost, ROSMOD server’s plugins require Linux, but if you wish to not run any of the compilation, deployment, or generation functions, you can run the server on any platform for which node and mongodb are available.

To run a ROSMOD WebGME server, you must have the following things installed:

For Base Server

  • node, version 4.X;

Note

you cannot install node from apt-get as it is the wrong version

  • mongodb: installable from apt-get

For Plugins

  • ROS: installable according to the instructions at http://www.ros.org
  • ROSMOD-COMM : installable according to the comm instructions
  • doxygen: for documentation generation
  • pandoc: for documentation generation
  • sphinx: for documentation generation
apt-get install doxygen pandoc python-sphinx
pip install sphinx_rtd_theme sphinx-autobuild

And for compilation and deployment you must have proper SSH keys and accessibility set up in you system.

Cloning, Installing Dependencies, and Running the Server

After you have these prerequisites installed, you can clone the repository and install the dependencies:

git clone https://github.com/rosmod/webgme-rosmod
npm update

Assuming you have mongod running, you can now start the server (sudo permissions are required because by default it starts on port 80):

sudo npm start