diff --git a/README.md b/README.md index 0502eebe5bf6feda1684bdb0f61fd4e1f9dd8d3e..2d593d127e69eb377adf9964467a63750a79c036 100644 --- a/README.md +++ b/README.md @@ -21,12 +21,24 @@ A client named `usagecontrol` and with the `citizen` role within the realm to be ## Installation +### Get the code Clone this repository: ``` bash git clone https://git.code.tecnalia.com/across/public/citizen-data-ownership-and-usage-control/usage-control/Usagecontrol.git ``` +### Configure properties files +Check the following `*.env` files and change the property values as required: +- `./postgres.env`: this file contains the properties related to the PostgreSQL DB, as the username and password, to be used for creating the DB container. +- `./datausage.env`: this file contains properties to be used when creating the UsageControl container and related to: + - the information required to connect to the PostgreSQL DB. + - Some URL-s of the Identity Server (keycloak) to connect to, and information related to the clients and realm to use. + - The main URL of the Service Catalogue HTTP API. + - The main URL of the TD HTTP API. + - The URL of the PIP endpoint to get the number of times accessed a specific service, and to be used when doing the enforcement of the "N times usage" policy. + +### Start containers Create and start the containers specified in the docker-compose.yml file: ``` bash