Semantics of this Tutorial

General Information
Command line execution

Important CITK $prefix=$HOME/citk/

Step #1: General Dependencies for running CITK tools

For now the CITK tool chain "only" fully supports Ubuntu 14.04 (Trusty) and 16.04 (Xenial) 64 bit. The CITK tool chain is generally not dependent on a specific UNIX/Linux flavor. However, in order to maintain full support we decided to focus on Ubuntu Linux since it is one of the most popular distributions. If you feel like you need support for any other OS or Linux flavor please contact the developers here.


Before running any script (Jenkins) provided in this tutorial, please unset the following environment variables.

unset http_proxy
unset ftp_proxy
unset https_proxy

In the TechFak environment the packages listed below are already installed, Java-8 should be the default setting.


First of all you will need to install the following dependencies in order to run CITK tools.

sudo apt-get install openjdk-8-jdk curl python2.7 python2.7-dev python-setuptools git subversion maven build-essential build-essential cmake
Install Java 8 in Ubuntu 14.04

Step #2: Download and run a Local Jenkins

Download the jenkins.tar.gz to a location of your choice. In the remainder of this tutorial we will work with ~/citk/ as your install $prefix.

mkdir -p $HOME/citk/ && cd $HOME/citk/
wget --no-check-certificate https://ci.toolkit.cit-ec.de/job/jenkins-distribution/lastStableBuild/artifact/jenkins.tar.gz -O jenkins.tar.gz

Extract the archive...

tar -xzvf jenkins.tar.gz
cd jenkins

Once extraction is completed, you need to configure a new user for Jenkins (can be skipped when upgrading from a previous release).

./create_user.sh

Provide the required instructions in the terminal. Afterwards, Jenkins can be started.

Please note: If you have hard-coded environment variables, i.e., $LD_LIBRARY_PATH, $PYTHONPATH or $PKG_CONFIG_PATH to any "non-standard/patched" installation of libraries (in your .bashrc for instance) please unset them before starting Jenkins because they will leak into the build process — leading to unpredictable build results

./start_jenkins

Now, you may open the Jenkins dashboard at https://localhost:8080/?auto_refresh=true

Jenkins is configured to use SSL communication so that passwords are sent to the server in an encrypted fashion. However, a randomly generated certificate is used for this and therefore your browser will most likely complain about this. You can ignore this warning (after verifying that port 8080 is actually used by the Jenkins instance you just started).

Step #3: Expected Result

You may proceed with the Installing a Distribution

Video Tutorial

All steps shown above are summarized in the video below. The video might (in the future) differ from what is exactly described here (e.g. installed packages, slightly different commands), however we will make sure main content/steps will still be valid.


Support

Support/Issues can be requested/filed under http://opensource.cit-ec.de/projects/citk.