Add initial Docker configuration for the SPARQL and NGINX endpoint, including startup scripts, configuration files and static resources.

Author: mjanez

.env.example

@@ -1,10 +1,30 @@
 # Server Configuration
-SV_PORT_HOST=5000
+PROXY_SERVER_NAME=localhost
 SV_WORKERS=2
+# Common proxy server for NGINX.
+NGINX_PORT_HOST=80
+NGINX_SSLPORT_HOST=443
 
 # Security
 ENABLE_CORS=false
 ALLOWED_ORIGINS=*
 
-# Options
+# RDF of filename in folder ./data 
 CATALOG_FILE=catalog.rdf
+
+# SPARQL Query Configuration
+DEFAULT_SPARQL_QUERY="PREFIX rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#>\nPREFIX rdfs: <http://www.w3.org/2000/01/rdf-schema#>\nSELECT * WHERE {\n    ?s ?p ?o .\n} LIMIT 100"
+EXAMPLE_SPARQL_QUERIES='{
+    "HVD info": {
+        "query": "prefix dct: <http://purl.org/dc/terms/>\nprefix dcatap: <http://data.europa.eu/r5r/>\nprefix dcat: <http://www.w3.org/ns/dcat#>\n\nselect distinct ?title ?hvdCategory ?applicableLegislation ?accessService ?accessURL ?license\nwhere {\n    # Filtrar por catálogos ES\n    ?catalogo ?cp ?d.\n\n    # Dataset y su categoría HVD\n    ?d dcatap:applicableLegislation <http://data.europa.eu/eli/reg_impl/2023/138/oj>.\n    ?d a dcat:Dataset.\n    optional { ?d dcatap:hvdCategory ?hvdCategory. }\n    \n    # Distribución y sus propiedades\n    ?d dcat:distribution ?dist.\n    ?dist dcatap:applicableLegislation <http://data.europa.eu/eli/reg_impl/2023/138/oj>.\n    \n    optional { \n        ?dist dct:title ?title.\n        FILTER(langMatches(lang(?title), \"es\"))\n    } \n    optional { ?dist dcatap:applicableLegislation ?applicableLegislation. } \n    optional { ?dist dcat:accessURL ?accessURL. } \n    optional { ?dist dcat:accessService ?accessService. } \n    optional { ?dist dct:license ?license. } \n}\nORDER BY ?dist"
+    },
+    "Query types": {
+        "query": "PREFIX rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#>\nSELECT DISTINCT ?type WHERE {\n    ?s rdf:type ?type\n} LIMIT 10"
+    },
+    "Count triples": {
+        "query": "SELECT (COUNT(*) AS ?count) WHERE {\n    ?s ?p ?o .\n}"
+    }
+}'
+SPARQL_ENDPOINT_TITLE="RDF SPARQL Endpoint-Catalog"
+SPARQL_ENDPOINT_DESCRIPTION="Endpoint SPARQl and RDF Catalog to query and explore linked data"
+SPARQL_ENDPOINT_VERSION="1.0.0"

README.md

@@ -1,8 +1,9 @@
 # README - Serving RDF with Docker & Flask
 
 ## Overview
-This project provides a simple **Dockerized RDF endpoint** that serves an `.rdf` file with the correct `Content-Type: application/rdf+xml`, ensuring compatibility with **DCAT-AP federators** and **RDF parsers** like `rdflib`.
+This project provides a simple **Dockerized RDF endpoint** that serves an `.rdf` file an provides an SPARQL Endpoint based on [`vemonet/rdflib-endpoint`](https://github.com/vemonet/rdflib-endpoint)
 
+The RDF file using the correct `Content-Type: application/rdf+xml`, ensuring compatibility with **DCAT-AP federators** and **RDF parsers** like `rdflib`.
 
 ## Quick Start
 Use [Codespaces](https://github.com/features/codespaces) to test `easy-rdf-endpoint` in your browser
@@ -18,22 +19,22 @@ Before starting the deployment, you'll need to set up a `.env` file. This file i
 1. Clone project
     ```shell
     cd /path/to/my/project
-    git clone https://github.com/mjanez/easy-rdf-endpoint.git & cd ckan-docker
+    git clone https://github.com/mjanez/easy-rdf-endpoint.git & cd easy-rdf-endpoint
     ```
 
-2. Copy the `.env.example` template and modify the resulting `.env` to suit your needs.
+2. Copy the [`.env.example`](.env.example) template and modify the resulting `.env` to suit your needs.
 
     ```shell
     cp .env.example .env
     ```
 
-    Adjust the vars as necessary
+    Adjust the vars as necessary, example:
     ```ini
-    # Host Ports
-    SV_PORT_HOST=5000
+    # Server Configuration
+    PROXY_SERVER_NAME=my-example-sparql-server.org
 
-    # Options
-    CATALOG_FILE=catalog.rdf
+    # RDF of filename in folder ./data 
+    CATALOG_FILE=my-custom-catalog.rdf
     ```
 
 3. Build & up the container.
@@ -42,27 +43,101 @@ Before starting the deployment, you'll need to set up a `.env` file. This file i
 docker compose up -d
 ```
 
-Then, access your RDF file at: 
-
-  👉 `http://localhost:5000/catalog.rdf`
+Then, access your RDF file an [endpoints](#endpoints).
 
 ---
 
+### Endpoints
+The endpoints will be available at:
+* Landing page[`http://localhost:5000`](http://localhost:5000)
+    * Access your RDF file at: [`http://localhost:5000/catalog`](http://localhost:5000/catalog)
+    * Default query editor (Yasgui): [`http://localhost:5000/sparql-editor`](http://localhost:5000/sparql-editor)
+    * SPARQL endpoint: [`http://localhost:5000/sparql`](http://localhost5000/sparql)
+
 ## Project Structure
-```
-/rdf-server
-│── /data/catalog.rdf          # Your RDF file (replace with your own)
-│── /scr/app.py                # Flask server to serve RDF
-│── /src/requirements.txt      # Python dependencies
-│── /docker/Dockerfile         # Docker setup
+```sh
+/easy-rdf-endpoint
+│── /data/catalog.rdf          # Your Catalog RDF file (replace with your own)
+│── /doc/                      # References, as images or documents, used in repo
+│── /easy-rdf-endpoint/        # RDF+SPARQL Endpoint setup
+│── /nginx/                    # NGINX docker setup
+│── /src/                      # Now using NGINX instead of the old RDF serving mode
+│── .env.example               # Sample ENVVars file for use with Docker Compose
 │── docker-compose.yml         # Docker Compose config
 │── README.md                  # Documentation
 ```
 
-## Notes
-- Replace `catalog.rdf` with your actual RDF file.  
-- Modify `app.py` if you need additional routes or enhancements.  
-- Works with **Codespaces, Docker, Kubernetes, and any containerized environment**.
+[!NOTE]
+> - Replace `catalog.rdf` with your actual RDF file.  
+> - Works with **Codespaces, Docker, Kubernetes, and any containerized environment**.
+
+## Update SSL Certificate
+To update the local SSL certificate, follow these steps:
+
+1. Generate a new certificate and private key:
+```sh
+openssl req -x509 -nodes -days 365 -newkey rsa:2048 \
+  -keyout nginx/setup/easy-rdf-endpoint_local.key \
+  -out nginx/setup/easy-rdf-endpoint_local.crt \
+  -subj "/C=ES/ST=Madrid/L=Madrid/O=Development/CN=localhost"
+```
+
+2. Verify that the files have been created correctly:
+```sh
+ls -l nginx/setup/easy-rdf-endpoint_local.*
+```
+
+3. Restart the `nginx` container to apply the changes:
+```sh
+docker compose restart nginx
+```
+
+> [!CAUTION]
+> This certificate is for local development only. In production, use a valid certificate from a certificate authority.
+
+## Development
+
+### Using DevContainers
+This project supports development using DevContainers, which provides a consistent development environment for all contributors.
+
+**Requirements**:
+* [Docker](https://docs.docker.com/get-docker/)
+- [VS Code](https://code.visualstudio.com/) or [GitHub Codespaces](https://github.com/features/codespaces)
+- [VS Code Remote - Containers extension](https://docs.rancherdesktop.io/how-to-guides/vs-code-remote-containers/)
+
+#### Getting Started with DevContainer
+1. Clone the repository:
+```bash
+git clone https://github.com/mjanez/easy-rdf-endpoint.git
+cd easy-rdf-endpoint
+```
+
+2. Open in VS Code:
+```bash
+code .
+```
+
+3. When prompted "*Reopen in Container*", click "*Reopen in Container*". Alternatively:
+   - Press `F1`
+   - Type "*Remote-Containers: Reopen in Container*"
+   - Press *Enter*
+
+VS Code will build and start the development container. This may take a few minutes the first time.
+
+#### What's Included
+The development container includes:
+- Python 3.11 environment
+- Required Python packages pre-installed
+- Popular VS Code extensions for Python/Docker development
+- Git configuration
+- Port forwarding for the application
+
+#### Working in the Container
+Once inside the container you can:
+- Run the application: `exec gunicorn --bind 0.0.0.0:5000 app:app`
+- Modify the [`easy-rdf-endpoint/setup/rdflib-endpoint/sparql_override.py`](./easy-rdf-endpoint/setup/rdflib-endpoint/sparql_override.py)
+- Execute SPARQL queries: `http://localhost:5000/sparql`
+- Debug with VS Code's integrated debugger
 
 ## License
 This project is licensed under the **MIT License**. 

doc/img/easy-rdf-endpoint_landing-page.png

@@ -1,21 +1,36 @@
 services:
-  rdf-endpoint:
+  nginx:
     build:
       context: .
-      dockerfile: docker/Dockerfile
+      dockerfile: nginx/Dockerfile
+    env_file:
+      - .env
+    logging:
+      driver: "json-file"
+      options:
+        max-size: "100m"
+        max-file: "10"
+    depends_on:
+      - sparql-endpoint
+    volumes:
+      - ./data/${CATALOG_FILE}:/usr/share/nginx/html/catalog.rdf
+    ports:
+      - "0.0.0.0:${NGINX_PORT_HOST}:80"
+      - "0.0.0.0:${NGINX_SSLPORT_HOST}:443"
+    restart: on-failure:3
+
+  sparql-endpoint:
+    build:
+      context: .
+      dockerfile: easy-rdf-endpoint/Dockerfile.sparql
     env_file:
       - .env
     logging:
       driver: "json-file"
       options:
         max-size: "10m"
         max-file: "5"
-    ports:
-      - "${SV_PORT_HOST}:5000"
     volumes:
-      - ./data/${CATALOG_FILE}:/app/catalog.rdf
-    healthcheck:
-      test: ["CMD", "curl", "-f", "http://localhost:5000/catalog.rdf"]
-      interval: 30s
-      timeout: 10s
-      retries: 3
+      - ./data/${CATALOG_FILE}:/app/data/catalog.rdf
+    restart: on-failure:3
+