RDF store

Store and search on RDF data that conform to SHACL.

Installation

git clone https://github.com/ULB-Darmstadt/rdf-store.git
cd rdf-store
cp .env.example .env (see below)
docker compose up -d

Afterwards, open browser at http://localhost:8089

.env setup for Docker Compose

1. Copy the example file: cp .env.example .env.
2. Update values as needed:
   • APP_URL: base URL for the deployment (used in redirects).
   • FUSEKI_PASSWORD: admin password for Fuseki. Needs to be set before first starting the services.
   • OAUTH2_PROXY_*: OIDC/OAuth settings (issuer, client id/secret, cookie secret).
   • DISABLE_OAUTH: set to a non-empty value to bypass OAuth2 proxy authentication. For this to work, activate the port mapping 3000:3000 for the app service in docker-compose.yml. The base URL of the application then is http://localhost:3000
   • RDF_NAMESPACE, LOG_LEVEL: optional service tuning.

Updating

cd rdf-store
git pull
docker compose up -d --build --force-recreate

SHACL shapes (aka application profiles)

RDF store supports loading SHACL shapes locally from the directory rdf-store/backend/local/profiles/ or remotely from the NFDI4Ing metadata profiles service. See the .env.example file on how to enable/disable/configure these sources.

Backend API

The backend API is exposed under http://localhost:8089/api/v1/ when running via Docker Compose. Key endpoints include:

• /api/v1/sparql/query for SPARQL queries on stored RDF resources.
• /api/v1/solr/{colletion}/query for SOLR search requests.
• /api/v1/resource for CRUD operations on RDF resources.

For a complete, interactive API reference, open the Swagger UI at http://localhost:8089/api/v1/ or refer to the OpenAPI document at http://localhost:8089/api/v1/openapi.json.

Example SPARQL query:

curl -Lk -X POST http://localhost:8089/api/v1/sparql/query -d "query=SELECT * WHERE { GRAPH ?g {?s ?p ?o } }"

Development setup

Prerequisites

• install go
• install npm

When modifying the code in this repo (backend or frontend), the recommended steps for running/testing the local changes are:

1. cd rdf-store
2. edit docker-compose.yml and comment in the port mappings for fuseki, solr and validator services
3. docker compose up -d --build
4. docker compose stop app
5. cd backend && go run . -> starts backend on port 3000, needs to be run again after each change in the backend
6. cd frontend && npm run dev -> starts frontend on port 5173 with live reload
7. open browser at http://localhost:5173

Architecture

flowchart TB
    User[User browser]
    Frontend[Frontend UI]
    Gateway[Nginx gateway]
    OAuth[OAuth2 proxy]
    Redis[(Redis)]
    App[Backend API]
    Validator[SHACL validator<br/>and shape conformance classifier]
    Fuseki[(Triple store<br/>Apache Jena Fuseki)]
    Solr[(Search Index<br/>Solr)]
    Profiles[SHACL Shape Sources<br/>Local + NFDI4Ing MPS]

    User --> Frontend
    Frontend -->|Search requests| Gateway
    Frontend -->|View/Edit requests| Gateway
    Gateway --> OAuth
    OAuth --> Redis
    OAuth --> App
    Gateway --> App
    App --> Validator
    App --> Fuseki
    App --> Solr
    App --> Profiles

Loading