Training Manuals

  • Beginner training workbook: Getting Started with iRODS 4.1
  • Notes about using this training manual…

    This workbook was produced for a training originally presented at the iRODS User Group Meeting 2015. Students were asked to set up a Linux virtual machine (instructions below) as a pre-requisite.

    The training originally used iRODS 4.1.1. If a different version of iRODS is used, it will be necessary to re-compile the metadata extraction microservice used for the “Workflow Automation” section of the workbook. See instructions below.

    Preparation Instructions: Setting up a Virtual Machine


    Course participants will need to bring a laptop with the following minimum specifications:

    • A 64-bit processor
    • 1 GB RAM
    • 10GB free disk space
    • Wireless networking (i.e., a 802.11g adapter, installed and configured)
    • An operating system compatible with VirtualBox 4.3.26. See to verify that your operating system is compatible.

    Preparation Instructions

    Before the day of training participants need to install a virtual machine (steps 1 – 4), and within that, a machine image linked below (steps 5 – 10).

    1. Navigate to
    2. Download VirtualBox by clicking the appropriate link for your operating system. (You do not need the Extension Pack or the Developer Kit.)
    3. Once downloaded, double-click the VirtualBox installer to run it (accept all default options).
    4. Download the machine image we have generated for the course: Please note that this file is 1.9GB and will take some time to download.
    5. Double-click the downloaded image to import it, or use the File –> Import Appliance dialogue on the VirtualBox main menu.
    6. When you are presented with this pop-up window, check the box near the bottom that says Reinitialize the MAC address of all network cards. (We recommend the default settings as the minimum acceptable configuration; but you may wish to increase the amount of RAM or the number of processors allocated to the VM based on your laptop’s capabilities.)Import Virtual Appliance
    7. Click Import to begin the installation. This will take a few minutes.importing appliance
    8. Once installation completes, you will be returned to the VirtualBox main menu. Double-click the ubuntu14-ugm2015 machine in the left column of the menu to start it up.
      virtualbox manager
    9. If the installation was successful, you should be presented with the login screen for the user learner. The password is also learner.
      vm startupYou can shut down the VM when you are done by closing the VM window. It will ask you if you want to Save the machine state, Send the shutdown signal, or Power off the machine. Click the radio button next to Power off the machine and then click OK. Then you may quit VirtualBox.


    If you see the error below, it may mean there is a Virtualization Technology setting on your computer that you need to enable. Visit for help with  Lenovo, HP, Dell, ASUS, and Acer computers. If you have a different computer, check with your laptop manufacturer for instructions to enable VT-x Virtualization Technology. For any other errors, please contact us.

    virtualbox error vtx

    Instructions: Recompiling the Metadata Extraction Microservice

    The following commands are used to recompile the metadata extraction microservice used in the “Workflow Automation” section of the workbook. Note, commands starting with # are comments, and they should not be typed.

Blog Posts

Technical Documentation

Communication with the iRODS Community