Quick Start

Installation

  1. Clone project from GitLab:
git clone https://gitlab.com/entici/public/entici-deploy.git
  1. 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>
  1. 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:

-f docker-compose.monitoring.yml

Keycloak

A keycloak container is defined in docker-compose.keycloak.yml, you can include it via adding the following parameter to the startup:

-f docker-compose.keycloak.yml

Note: It is not recommended to use an internal Keycloak instance for productive use. Thus, we do not provide support for the Keycloak component but merely included it as a convenience for testing purposes.

Smoke Test

Preparation

  1. Create user as described here.
  2. Enable test client
    • Login to the administration console with the admin user
    • In the realm trustcenter, go to Clients and open the client trustcenter-test
    • In Settings, enable the client
    • In Credentials, copy the client secret to the clipboard

Perform test

While any REST client is suitable, this description is based on Postman.

  1. Start Postman
  2. Create new POST request to server:port/v1/process
  3. In Authorization, choose OAuth 2.0 and get new access token via the information described here.
  4. In Body, choose raw and type JSON (application/json), insert the example JSON.
  5. Send the request
  6. In your browser, go to server:port/entitylist/de/index.html, log in with your new user
  7. Search for ABC
  8. You should get ‘Müller’, ‘ABC123’ and a Pseudonymn
Next
Configuration