Update the README.md

master
Lampros Smyrnaios 2 years ago
parent 1111c850b9
commit 5819bf584b

@ -1,15 +1,13 @@
# UrlsController
This is the Controller's Application.<br>
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.<br>
Then it receives the "WorkerReports" and writes them into the database.<br>
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.<br>
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.<br>
The database used is the [Impala](https://impala.apache.org/) .<br>
[...] <br>
To install and run the application, run ```git clone```.
Then, provide a file *"S3_minIO_credentials.txt"*, inside the *working directory*.<br>
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.
<br>
Afterwards, execute the ```installAndRun.sh``` script.<br>
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.<br>
- Execute the ```installAndRun.sh``` script which builds and runs the app.<br>
If you want to just run the app, then run the script with the argument "1": ```./installAndRun.sh 1```.<br>
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```.<br>
<br>

Loading…
Cancel
Save