Skip to content
Snippets Groups Projects
Commit 09928d5b authored by Rodríguez Ortega, Alejandro's avatar Rodríguez Ortega, Alejandro
Browse files

Update Readme

parent c7abfb65
No related branches found
No related tags found
No related merge requests found
# 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
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment