Test setup

Requirements (Debian 11, should also work in Ubuntu 20.04):

Software packages

• apt-get install sudo git docker.io docker-compose m4 ed openssh-server sharutils uuid-runtime curl rsync

sudo without password

• execute visudo and add a line <username> ALL=(ALL) NOPASSWD: ALL

OR

• add your user to the sudo group: adduser <username> sudo
• alter the line for %sudo via visudo to %sudo ALL=(ALL) NOPASSWD: ALL
• logout and login again to apply the new group assignment

Docker without sudo

• add your user to the docker group: adduser <username> docker
• logout and login again to apply the new group assignment

Java (JDK 8 and Maven)

• Debian only ships OpenJDK 11 or 17, so we are required to install version 8 manually from AdoptOpenJDK.
• Setup and trust the AdoptOpenJDK package repository as explained here.
• apt-get install adoptopenjdk-8-hotspot maven

Hostlist

• The hostlist file defines the target node instances. For the sake of simplicity, we will only setup one CRIMSy node on localhost.
• echo "node1;localhost;<username>" > ~/hostlist (substitute <username> with the user who was given sudo and docker permissions to in the previous steps)

SSH

• Principle: The test setup rolls out the installations to the target nodes defined in the hostlist file via SSH. Automation is achieved using passwordless SSH keys. Please do not use this setup in production systems!
• Generate SSH key without password and save it into ~/.ssh/id_ecdsa: ssh-keygen -t ecdsa -b 521 and hit Enter for all input requests
• Allow SSH logins with this key: ssh-copy-id localhost
• Test the SSH connection and accept the SSH server's fingerprint: ssh localhost

CRIMSy Setup

• clone the CRIMSy project: git clone https://github.com/ipb-halle/CRIMSy.git
• build and roll out: ./CRIMSy/util/bin/testSetup.sh -s -H ~/hostlist
• Browse to https://localhost and accept the snakeoil SSL certificate

Uninstall CRIMSy

• Note: This stops and prunes all CRIMSy-related Docker containers and deletes the database and the stored documents.
• if necessary, clone the CRIMSy project: git clone https://github.com/ipb-halle/CRIMSy.git
• uninstall: ./CRIMSy/util/bin/testSetup.sh -t -H ~/hostlist