Linux

1. Install Docker.

   • We suggest installing Docker from here with this simple instructions:
     • curl -fsSL https://get.docker.com -o get-docker.sh
     • sudo sh get-docker.sh
     • The script require root or sudo privileges to run. Therefore, you should carefully examine and audit the scripts before running them.

2. Install Python (2.7 or 3.x).

   • It should be pre-installed on most Linux distributions; if it isn't, you can install it tipically with sudo apt install python.
   • If you're using Python 2.7, you may also need to install the ipaddress lib (already installed in Python 3). The installer will try to do it by using pip by default if the library is not already installed. If you don't want to use pip (or if it doesn't work on your environment) feel free to do it using any other Python package manager. You can run the installer using the --nopip option (for more on this check step 7). To manually install using pip, activate your environment (or stay in the default one) and run pip install ipaddress. If the library is already found, the installer will automatically skip this part.

3. If you want to install the wrapper you'll need gcc (for more informations about the wrapper click here)

   • if you haven't installed simply run sudo apt install build-essential

4. (suggested) Install xterm terminal emulator (usually sudo apt install xterm), that is used by default.

   • You can also specify a different terminal emulator by using the --xterm=... command parameter while starting a network node or a lab. It is also possible to avoid opening new terminals at all by using --noterminals.

5. Download all the files to a directory inside /opt (from a release or git clone https://github.com/KatharaFramework/Kathara.git).

6. Add the environment variable NETKIT_HOME to your system pointing to the bin folder:

   • export NETKIT_HOME=/opt/kathara/bin (you can also do this permanently by adding it to ~/.bashrc or the appropriate initialization file for your shell by executing echo "export NETKIT_HOME=/opt/kathara/bin" >> ~/.bashrc).

7. Run the installer with $NETKIT_HOME/install

   • You can also specify the following options:
     • --p4 to pre-download the P4 image
     • --admin to remove the wrapper (will require sudo before each Kathará command).
     • --nopip will skip the installation of the ipaddress library so that you can do it manually.

8. You can optionally add NETKIT_HOME to your PATH, but the NETKIT_HOME variable is still required.

   • export PATH=$PATH:$NETKIT_HOME (you can also do this permanently by adding it to ~/.bashrc or the appropriate initialization file for your shell by executing echo "export PATH=\$PATH:\$NETKIT_HOME" >> ~/.bashrc).