From ba8e9d36e9f22115882565925c0a1cb970c705bf Mon Sep 17 00:00:00 2001 From: Kirill Yankov Date: Thu, 24 Mar 2022 13:07:06 +0100 Subject: [PATCH] architecture diagram and a bit improved docs #22 --- README.md | 4 +++- documentation/gstore_dia.svg | 4 ++++ documentation/running.md | 4 +++- documentation/usage.md | 6 +++--- 4 files changed, 13 insertions(+), 5 deletions(-) create mode 100644 documentation/gstore_dia.svg diff --git a/README.md b/README.md index 82581ab..460c303 100644 --- a/README.md +++ b/README.md @@ -8,5 +8,7 @@ The G is an ORcronym for (git|graph). You can find the documentation under: https://dbpedia.gitbook.io/databus/v/gstore/ +You can find a test instance to try queries on your own under: http://gstore-playground.tools.dbpedia.org/ + ## Overview -TODO architecture diagram showing the three components, maybe include a centralized and a de-centralized architecture view +![Gstore architecture](./documentation/gstore_dia.svg) diff --git a/documentation/gstore_dia.svg b/documentation/gstore_dia.svg new file mode 100644 index 0000000..0729beb --- /dev/null +++ b/documentation/gstore_dia.svg @@ -0,0 +1,4 @@ + + + +
Local git
Local git
Sparql service
(Virtuoso / Jena Fuseki)
Sparql service...
Http API (Jetty)
Http API (Jetty)
G(it|raph) Store
G(it|raph) Store
JDBC
JDBC
User
User
Text is not SVG - cannot display
\ No newline at end of file diff --git a/documentation/running.md b/documentation/running.md index 74b474b..09be0cc 100644 --- a/documentation/running.md +++ b/documentation/running.md @@ -7,6 +7,8 @@ git clone https://github.com/dbpedia/gstore.git cd gstore # create folder (writable by all services) mkdir databus -# run docker-compose (builds new image from the sources) +# run docker-compose (builds new image from the sources), this will start virtuoso docker-compose up --build +# or (for running gstore with Jena Fuseki) +docker-compose -f docker-compose-fuseki.yml up --build ``` \ No newline at end of file diff --git a/documentation/usage.md b/documentation/usage.md index a057077..52119e1 100644 --- a/documentation/usage.md +++ b/documentation/usage.md @@ -3,11 +3,11 @@ After the containers are up, the following services will be available: * GIT File Browser http://localhost:3002/file -* Virtuoso SPARQL http://localhost:3003/sparql +* SPARQL endpoint http://localhost:3002/sparql * GSTORE http://localhost:3002/ with swagger documentation * GET /graph/read - * POST /graph/delete - * DELETE /graph/save + * DELETE /graph/delete + * POST /graph/save * POST /dataid/tractate * POST /shacl/validate