Newer
Older
The User Journey Services Engine (UJSE) can be installed via docker compose. The composition includes:
- A PostgreSQL database.
- The UJSE with its HTTP API.
The HTTP API offered by the UJSE is specified [here](./ujse_openapi.yaml).
## Installation requirements
UJSE requires the following ACROSS components to be already installed:
- [Transparency Dashboard Backend](https://git.code.tecnalia.com/across/public/citizen-front-end/transparency-dashboard/transparency-dashboard-ui): to get the list of given consents by each citizen and the status of them.
- [Usage Control](https://git.code.tecnalia.com/across/public/citizen-data-ownership-and-usage-control/usage-control/Usagecontrol): to do the enforcement of the usage policies defined by the citizen
- [Service Catalogue](https://git.code.tecnalia.com/across/public/data-harmonization-and-connectors/service-registry/Public_Service_Catalog_ENG): to get all the required information of the available services.
- An Identity Server, as Keycloak, installed and configured with its corresponding realm and clients.
To install the project, you need to have Docker and Docker-compose installed on your machine. If you don't have it, you can install it by following the instructions on the official Docker website.
## Identity Server configuration
A client named `ujse` and with the `citizen` role within the realm to be used for all the Across clients must be configured in the Identity Server.
``` bash
git clone https://git.code.tecnalia.com/across/public/user-journey-service-delivery/user-journey-services-engine.git
```
### Configure properties files
Check the following `*.env` files and change the property values as required:
- ./ujse.env: this file contains properties to be used when creating the UJSE container and related to:
- the information required to connect to the PostgreSQL DB.
- Some URL-s of the Identity Server (keycloak) to connect to.
- Some URL-s of the Service Catalogue HTTP API.
- The main URL of the TD HTTP API.
- ./postgres.env: this file contains the properties related to the PostgreSQL DB, as the username and password, and to be used for creating the DB container.
### Start containers
Create and start the containers specified in the docker-compose.yml file:
Read the [license file](./LICENSE) for more information.