From 56e0f864974af4cff6ecfaa3bd83adfc5e151eff Mon Sep 17 00:00:00 2001
From: Idoia Murua <idoia.murua@tecnalia.com>
Date: Fri, 26 Apr 2024 10:16:48 +0200
Subject: [PATCH] README inital version

---
 README.md | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/README.md b/README.md
index 2aa167d..0851d52 100644
--- a/README.md
+++ b/README.md
@@ -22,12 +22,24 @@ A client named `ujse` and with the `citizen` role within the realm to be used fo
 
 
 ## Installation
+### Get code
 Clone this repository:
 
 ``` 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:
 
 ``` bash
-- 
GitLab