Commit 477b7229 authored by YannGarcia's avatar YannGarcia
Browse files

Enhance README file

parent 5e7d7b83

README.md

+11 −11
Original line number Diff line number Diff line
@@ -37,7 +37,7 @@ Alternatively, you may clone the project together with the required libraries wi 


    git clone --recurse-submodules <URL to the repository>



## Installation

# Installation



The CISE Test System builds and tests regularly on the following platforms:
@@ -45,7 +45,7 @@ The CISE Test System builds and tests regularly on the following platforms: 


Note: The [OpenSSL](https://www.openssl.org) version > 1.1.x is also required.



### How to do it?

## How to do it?



They are two different methods:

- Using [Vagrant](https://www.vagrantup.com/)
@@ -56,12 +56,12 @@ How to choose one of these methods is depending of your host system. 
NOTE: In all case, if you want to setup an continuous integration process (e.g. Jenkins), Docker is the best choice. 





#### The host system is Windows

### The host system is Windows

The both methods require a virtual machine. You can use either VirtualBox or WMware.

In this case, the easiest way is to use Vagrant.





#### The host system is Linux

### The host system is Linux



Vagrant requires a virtual machine. You can use either VirtualBox or WMware.

Docker does not need a virtual machine, so it is the more efficant way.
@@ -73,7 +73,7 @@ The following clauses describes four ways to build and deploy the CISE Test Sys 
- [From scratch](#from-scratch)





### Using TITAN compiler on a Docker image

## Using TITAN compiler on a Docker image



In this configuration, TITAN compiler is located on a Docker image and the sources and the outputs are located on the host.
@@ -151,7 +151,7 @@ $ ./docker-run.sh run 
. Updating HTTP port setting





### Using development Docker image

## Using development Docker image



In this configuration, the TITAN compiler, the sources and the outputs are located on the Docker image.
@@ -179,7 +179,7 @@ $ ./docker/run-container.sh 
- Switch to the next clause (Usage)





### Using Vagrant

## Using Vagrant



Pre-requisites on your host machine:

- Install [Virtualbox](https://www.virtualbox.org/manual/ch01.html)
@@ -222,7 +222,7 @@ $ vagrant ssh 
NOTE The user password is vagrant.





### From scratch

## From scratch



Pre-requisites:

- Install Virtualbox
@@ -308,7 +308,7 @@ $ cp ./ttcn/patch_lib_common_titan/*.ttcn ./ttcn/LibCommon/ 
- Switch to the next clause (Usage)





## Generate certificates for TLS and Cise security support 

# Generate certificates for TLS and Cise security support 



This clause describes how generate certificates desrived from Let's encrypt certificate. These certificate will be used for TS mutual authentication and for Cise Security tests.

<b>NOTE:</b>
@@ -330,7 +330,7 @@ $ sudo certbot certonly --debug --cise-test-cert --config-dir $HOME/var/ssl --wo 
<b>NOTE:</b> For testing certificate generation and renewal, use the certbot's --dry-run option.





## Usage

# Usage



This clause describes how to compile and execute an Abstract Test Suite.
@@ -372,7 +372,7 @@ $ ./run-all.bash 
- The log files are located in ../logs folder. You can edit them using any editor or using the Eclipse TITAN log plugins





## How to Report a Bug

# How to Report a Bug



The ETSI CISE Test System is under constant development, so it is possible that you will

encounter a bug while using it. Please report bugs at cti_support at etsi dot org.