Merge pull request #4 from ronitblenz/main

sante in 5 minutes using docker

index.md

@@ -20,19 +20,17 @@ SANTé stands for Semantic Search Engine and is designed to simplify RDF data ac
 > **SANTé in Multilingual support is in development cycle!**
 > See [the other Branch](https://github.com/aksw/sante/tree/mulang) for a detailed breakdown.
 
-# SANTé in 5 minutes
+# SANTé in 5 minutes using Docker
 {: .no_toc }
 
 
 In this 5 minutes tutorial, we will help you to instantiate your first knowledge base search engine over FOAF ontology using KBox [https://github.com/AKSW/KBox](https://github.com/AKSW/KBox).
 
-1) Download KBox and instantiate the FOAF knowledge graph.
+1) Downloads KBox and instantiates the FOAF knowledge graph.
 
-Download the jar here [https://github.com/AKSW/KBox/releases](https://github.com/AKSW/KBox/releases)
-and run the following command:
+```bash
+docker run --network=host aksw/kbox -server -kb "http://xmlns.com/foaf/0.1,https://www.w3.org/2000/01/rdf-schema,http://www.w3.org/2002/07/owl,http://www.w3.org/1999/02/22-rdf-syntax-ns,http://purl.org/dc/elements/1.1/,http://purl.org/dc/terms/,http://purl.org/dc/dcam/,http://purl.org/dc/dcmitype/" -install
 
-```
-java -jar kbox-vXXXX.jar -server -kb "http://xmlns.com/foaf/0.1,https://www.w3.org/2000/01/rdf-schema,http://www.w3.org/2002/07/owl,http://www.w3.org/1999/02/22-rdf-syntax-ns,http://purl.org/dc/elements/1.1/,http://purl.org/dc/terms/,http://purl.org/dc/dcam/,http://purl.org/dc/dcmitype/" -install
 Loading Model...
 Publishing service on http://localhost:8080/kbox/query
 Service up and running ;-) ...
@@ -41,25 +39,46 @@ You can now access and query your knowledge graph at [http://localhost:8080](htt
 Notice that in the example above, we also include RDFS, RDF, and OWL ontologies. That's because we need their information to correctly instantiate FOAF ontology.
 If the SPARQL endpoint does not contain all necessary information, SANTé will not be capable of retrieving or searching for it and will display the resource as ```URI```.
 
-2) Download one of the available SANTé runnable jar files.
 
-Download the jar here [https://github.com/AKSW/sante/releases](https://github.com/AKSW/sante/releases)
+2) Creating the Volume
+
+```bash
+docker volume create index
+```
+
+This volume stores the ```index``` directory, so that it becomes accessible to all the docker images once it is set up.
+
 
 3) Create the index.
 
-Assuming that you successfully performed step 1,
+Assuming that you successfully performed step (1) and (2),
+
+```bash
+docker build -t sante/main -f sante.main/Dockerfile .
 ```
-java -jar sante-main-*.jar index -endpoint http://localhost:8080/kbox/query -path \foaf_kg
+
+Using the ```URI``` to generate the ```foaf_kg```.
+
+```bash
+docker run --network=host -v index:/sante/foaf_kg -e endpoint=http://localhost:8080/kbox/query sante/main
 ```
 
-4) Download one of the available smile WAR files (same version as step 2).
+The SANTé Main build creates the ```foaf_kg``` folder and inserts it into the mounted volume ```index```.
+
 
-Download the WAR here [https://github.com/AKSW/sante/releases](https://github.com/AKSW/sante/releases)
+4) Instantiate smile
 
-5) Instantiate smile
+```bash
+docker build -t sante/smile -f sante.smile/Dockerfile .   
 ```
-java -jar -Dsante.index.path=\foaf_kg sante.smile-*.war
- ____    _    _   _ _____  __   __        _______ ____       _
+
+To run the docker image along with the specified ```index```, here is the command:
+
+```bash
+docker run -p 7070:7070 -v index:/index -itd sante/smile
+
+
+  ____    _    _   _ _____  __   __        _______ ____       _
  / ___|  / \  | \ | |_   _|/_/_  \ \      / / ____| __ )     / \   _ __  _ __
  \___ \ / _ \ |  \| | | || ____|  \ \ /\ / /|  _| |  _ \    / _ \ | '_ \| '_ \
   ___) / ___ \| |\  | | ||  _|_    \ V  V / | |___| |_) |  / ___ \| |_) | |_) |
@@ -71,7 +90,7 @@ java -jar -Dsante.index.path=\foaf_kg sante.smile-*.war
 2022-09-13 09:58:15.846  INFO 21938 --- [           main] org.aksw.sante.SanteWebApp               : No active profile set, falling back to default profiles: default
 ```
 
-If you correctly executed all the steps above, now you should be able to access SANTé at [http://localhost:9090](http://localhost:9090).
+If you correctly executed all the steps above, now you should be able to access SANTé at [http://localhost:7070](http://localhost:7070).
 
 
 ## About the project