From 09928d5bfff8a9ff1cb4e7f92cc6eac252563480 Mon Sep 17 00:00:00 2001 From: alexrodriguez <alejandro.rodriguez@tecnalia.com> Date: Tue, 8 Nov 2022 16:54:06 +0100 Subject: [PATCH] Update Readme --- README.md | 31 +++++++------------------------ 1 file changed, 7 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index d0e46e7..9b6a376 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,8 @@ -# Data Storage and Retrieval Component -Microservice for inserting and retrieving data from the databases. +# Anonymize Component +Microservice for anonymize data from the databases. ## Table of Contents -1. [Clone](#clone) -2. [Push](#push) + 1. [Build](#build) 1. [Docker](#docker) 1. [Configuration](#configuration) @@ -11,20 +10,6 @@ Microservice for inserting and retrieving data from the databases. 1. [API Reference](#api-reference) 1. [License](#license) -## Clone -This project has a git submodule called 'shared'. Because of this, it is necessary to download the code including submodules. - -```bash -$ git clone --recurse-submodules <repo> -``` - -Once downloaded: -```bash -$ cd shared -$ mvn install -``` -## Push -Note that if you update the library 'shared', another project makes use of it, so you should update the commit of the other api project called 'open-data-retrieval'. ## Build Requirements: @@ -35,13 +20,13 @@ Requirements: Build docker image: ```bash -$ docker build -t urbanite/datastorage . +$ docker build -t urbanite/anonymize . ``` Run docker image: ```bash -$ docker run -it -p 80:80 urbanite/datastorage +$ docker run -it -p 80:80 urbanite/anonymize ``` ## Configuration @@ -50,13 +35,11 @@ $ docker run -it -p 80:80 urbanite/datastorage | Variable| Description | Default Value | | :--- | :--- | :--- | -| `MONGO_HOST` | The IP of the host where MongoDB is installed. | `mongodb` | -| `MONGO_PORT` | The port where MongoDB is listening. | `27017` | -| `MONGO_DBNAME` | The name of the MongoDB Database to insert/retrive data. | `urbanite` | +| `DATA_STORAGE_URL` | The url of the exporter. | `http://exporter:8080` | e.g. ```bash -$ docker run -it -p 80:80 -e MONGO_HOST=172.26.41.138 -e MONGO_PORT=27018 urbanite/datastorage +$ docker run -it -p 80:80 -e MONGO_HOST=172.26.41.138 -e MONGO_PORT=27018 urbanite/anonymize ``` ## API Reference When the component is deployed, the API reference is accessible from -- GitLab