Quick Start

Mon, 01 Jan 0001 00:00:00 +0000

Installation

Clone project from GitLab:

git clone https://gitlab.com/entici/public/entici-deploy.git

Checkout desired version as a new branch:

# Example: git checkout tags/v2.1.1 -b v2.1.1-branch
git checkout tags/<TAG_NAME> -b <NEW_BRANCH_NAME>

Adjust configuration

A template .env file is available here. An overview and description of all configuration parameters can be found here.

Start Up

docker-compose -f docker-compose.yml up -d

Monitoring

The monitoring components are defined in docker-compose.monitoring.yml, you can include it via adding the following parameter to the start up:

Configuration

Mon, 01 Jan 0001 00:00:00 +0000

Environment variables

The configuration is handled via one single .env file. A template file is available here. This section gives an overview of all available configuration parameters.

Basic Configuration

Name	Description	Default Value
`VERSION_CONFIG_SERVER`	Version of the Config Server service.	-
`VERSION_WEBAPP_BACKEND`	Version of the Webapp Backend service.	-
`VERSION_WEBAPP_HOME`	Version of the Webapp Home service.	-
`VERSION_WEBAPP_FRONTEND`	Version of the Webapp Frontend service.	-
`VERSION_PSEUDONYMIZATION`	Version of the Pseudonymization service.	-
`VERSION_DEPSEUDONYMIZATION`	Version of the Depseudonymization service.	-
`VERSION_INTERFACE`	Version of the Interface service.	-
`VERSION_MONITORING`	Version of the Monitoring service.	-
`LOG_LEVEL`	Log level for application logging. This only applies to self-developed code.	`INFO`

Template with default values

##### Version per service.
VERSION_CONFIG_SERVER=5.3.0-RELEASE
VERSION_WEBAPP_BACKEND=5.3.0-RELEASE
VERSION_WEBAPP_HOME=5.3.0-RELEASE
VERSION_WEBAPP_FRONTEND=5.3.0-RELEASE
VERSION_PSEUDONYMIZATION=5.3.0-RELEASE
VERSION_DEPSEUDONYMIZATION=5.3.0-RELEASE
VERSION_INTERFACE=5.3.0-RELEASE
VERSION_MONITORING=5.3.0-RELEASE
LOG_LEVEL=INFO

Server Configuration

Name	Description	Default Value
`SERVER_NAME`	Hostname for the server, e.g. example.de	-
`SERVER_PORT`	Port for the server.	443
`KEYCLOAK_SERVER_NAME`	URL of the Keycloak server, .e.g https://keycloak.example. Avoid trailing slashes.	-
`KEYCLOAK_SERVER_TYPE`	Keycloak server type (`Internal` or `External`). Internal is not supported for productive use.	External
`KEYCLOAK_ADMIN_PW`	Password for the Keycloak admin user (required if `KEYCLOAK_SERVER_TYPE` is set to `Internal`)	-
`DOCKER_REGISTRY_PREFIX_DOCKERHUB`	Docker registry prefix	see below
`DOCKER_REGISTRY_PREFIX_QUAYIO`	Docker registry prefix	see below
`DOCKER_REGISTRY_PREFIX_GITLAB`	Docker registry prefix	see below

Template with default values

###################################################################
###################### Server configuration #######################
###################################################################

##### Hostname
# Example: entici.med.tum.de
SERVER_NAME=

##### Port
SERVER_PORT=443

##### URL of the keycloak server
# Example: https://keycloak.example
# Note: Avoid trailing slashes!
KEYCLOAK_SERVER_NAME=

#### Keycloak server type (Internal or External)
# Default: External.
# Note: Use Internal only for testing purposes.
KEYCLOAK_SERVER_TYPE=External

##### Password for the keycloak admin user (must be set if 'KEYCLOAK_SERVER_TYPE'==Internal)
KEYCLOAK_ADMIN_PW=

##### Docker registry prefix
DOCKER_REGISTRY_PREFIX_DOCKERHUB=docker.io
DOCKER_REGISTRY_PREFIX_QUAYIO=quay.io
DOCKER_REGISTRY_PREFIX_GITLAB=registry.gitlab.com/entici/public

Keycloak Configuration

For testing purposes, an optional Keycloak server has been integrated into this deployment package. In order to enable the internal Keycloak server, apply the following configuration:

Architecture

Mon, 01 Jan 0001 00:00:00 +0000

Components

Resource List

The core of the software is the resource list, which comprises five components:

Name	Type	Own	Since
Database	PostgreSQL	❌	v1.0.0
Psn Service	Spring Boot App	✔️	v1.0.0
Depsn Service	Spring Boot App	✔️	v4.0.0
Webapp Backend	Spring Boot App	✔️	v1.0.0
Webapp Frontend	Angular App	✔️	v1.0.0

The Psn Service provides REST interfaces for pseudonymization purposes and uses the underlying database for storage. The Depsn Service provides REST interfaces for depseudonymization purposes based on the stored data. The Webapp Frontend provides a graphical user interface including different views on the data. The Webapp Backend provides REST interfaces for the frontend in order to populate its views.

Installation Guide on entici

Quick Start

Installation

Start Up

Configuration

Environment variables

Basic Configuration

Server Configuration

Keycloak Configuration

Architecture

Components

Resource List