SHACL generated JSON:API endpoint for FAIR-compliant research catalogues
89
FairGateway connects to an RDF store such as Apache Jena Fuseki and generates a standards-compliant JSON:API interface from a SHACL-defined data model.
Pull and run the production image:
docker run \
--publish 8000:8000 \
--env-file ./.env \
--name fairgateway \
fairgateway/fairgateway:prod
FairGateway will be available at http://localhost:8000.
API docs are available at http://localhost:8000/redoc (Swagger at http://localhost:8000/docs).
FairGateway is configured via environment variables or a .env file.
| Variable | Description |
|---|---|
| LOG_LEVEL | Log level: DEBUG, INFO, WARNING, ERROR, or CRITICAL |
| PATH_PREFIX | Optional prefix for all routes (e.g. /api) |
| CORS_ALLOWED_ORIGINS | Comma-separated list of origins (domains) that are allowed to make cross-origin requests. |
| DEFAULT_PAGE_SIZE | Default number of results per page (e.g. 25) |
| STORAGE_MODE | Storage backend: FUSEKI or LOCAL |
| LOCAL_DATA_FILES | Comma-separated list of local data TTL files |
| LOCAL_ONT_FILES | Comma-separated list of local ontology TTL files |
| LOCAL_SHAPES_FILES | Comma-separated list of local SHACL shape TTL files |
| FUSEKI_HOST | Fuseki server URL (e.g. http://localhost:3030/dataset) |
| FUSEKI_USER | Fuseki username |
| FUSEKI_PASS | Fuseki password |
| DATA_GRAPH | Named graph for data (default urn:fairgateway:data) |
| ONT_GRAPH | Named graph for ontology (default urn:fairgateway:ontology) |
| SHAPES_GRAPH | Named graph for SHACL shapes (default urn:fairgateway:shapes) |
| HISTORY_GRAPH | Named graph for history (default urn:fairgateway:history) |
| AUTH_MODE | Authentication mode: LOCAL or EXTERNAL |
| JWT_ISSUER | JWT token issuer (used if AUTH_MODE=EXTERNAL) |
| JWT_AUDIENCE | JWT audience (used if AUTH_MODE=EXTERNAL) |
| JWT_SECRET | JWT secret key (used if AUTH_MODE=LOCAL) |
| PUBLIC_SPARQL | Set true to allow unauthenticated SPARQL access |
| Tag | Description |
|---|---|
prod | Production image — use this for deployments |
dev | Development image with hot reload |
test | Test runner image |
Content type
Image
Digest
sha256:489e0e4ce…
Size
43.4 MB
Last updated
1 day ago
docker pull fairgateway/fairgateway