Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Added notes about drive space requirements

OS

To successfully follow the examples in the Hyperledger Indy Technical Deep Dive training, you will need an operating system that supports docker. We recommend Ubuntu 18.04 or Mac with at least 30G drive space available (20 is known to fail).

Required Tools

If not already installed, you will need to install Git and Docker on your system to be able to do the hands-on Labs during the training. Please use the following steps in your command line tool:

git

  • Ubuntu 18.04

    Code Block
    sudo apt install -y git


  • Mac

    Code Block
    git --version

    If Git is not installed, it will prompt you to install it.        

Docker

Fork the indy-node Git repo:

  • Create a github account for yourself if you do not already have one. Go here if you need help.
  • Go to https://github.com/hyperledger/indy-node
  • Click "fork" (upper right) and select your personal github account from the list.
  • From your fork click the green Code button.
  • Click 'HTTPS" and Copy the URL link shown in the field. Use this link in the next step.

Clone and build from your fork of indy-node:

Copy and paste the following commands into a terminal command prompt:


Code Block
mkdir gitdir
cd gitdir
git clone <paste the path from the previous step> -b ubuntu-20.04-upgrade
cd indy-node 
docker build -t indy-node-dev -f .devcontainer/Dockerfile .devcontainer/ 
docker run --rm -it -v $(pwd):/node:z indy-node-dev
cd /node
pip install .[tests]
cd indy_common 
pytest . 
cd ../indy_node
pytest . 


The last few steps (pytest .) might take a long time to run (more than 20 minutes). A few individual test errors are expected at this time, but not more than 10.  If you get a larger number of failures, try increasing the available drive space. A VM with only 20G of drive space is known to not be enoough for several of the tests.

NOTE: Ubuntu in a VM:

If Ubuntu is installed in a VirtualBox VM do the following:

  • Perform all the steps listed in this tutorial to update your system and enable copy and paste.
  • Make sure to restart your VM and that the Shared Clipboard is set to bidirectional:
    • In your VM machine settings, in Virtual Box > General > Advanced
    • set ‘Shared Clipboard’ to ‘Bidirectional’