From 5819bf584b8bfa07039953c268aca9e712ba74ad Mon Sep 17 00:00:00 2001 From: LSmyrnaios Date: Mon, 7 Feb 2022 21:11:03 +0200 Subject: [PATCH] Update the README.md --- README.md | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 3aa699b..5c0d1b7 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,13 @@ # UrlsController -This is the Controller's Application.
-It receives requests coming from the [workers](https://code-repo.d4science.org/lsmyrnaios/UrlsWorker) , constructs an assignments-list with data received from a database and returns the list to the workers.
-Then it receives the "WorkerReports" and writes them into the database.
+The Controller's Application receives requests coming from the [Workers](https://code-repo.d4science.org/lsmyrnaios/UrlsWorker) , constructs an assignments-list with data received from a database and returns the list to the workers.
+Then, it receives the "WorkerReports", it requests the full-texts from the workers, in batches, and uploads them on the S3-Object-Store. Finally, it writes the related reports, along with the updated file-locations into the database.
The database used is the [Impala](https://impala.apache.org/) .
-[...]
- -To install and run the application, run ```git clone```. -Then, provide a file *"S3_minIO_credentials.txt"*, inside the *working directory*.
-In the *"S3_minIO_credentials.txt"* file, you should provide the *endpoint*, the *accessKey*, the *secretKey*, the *region* and the *bucket*, in that order, separated by comma.
-Afterwards, execute the ```installAndRun.sh``` script.
+To install and run the application: +- Run ```git clone``` and then ```cd UrlsController```. +- Provide the **S3 Object Store** related configurations, inside the *src/main/resources/application.properties* file.
+- Execute the ```installAndRun.sh``` script which builds and runs the app.
If you want to just run the app, then run the script with the argument "1": ```./installAndRun.sh 1```.
+If you want to build and run the app on a docker container, then run the script with the argument "0" followed by the argument "1": ```./installAndRun.sh 0 1```.