The deployment package for the LAM services.
This repository provides the enterprise architecture and description of capabilities necessary for the digital transformation of the asset publishing life-cycle workflow.
Please follow the official instructions located here.
Please follow the official instructions located here.
Either open a shell and run the following:
git clone https://github.com/meaningfy-ws/lam-workflow.git
or unzip the project that you received.
Navigate to the repository "lam-workflow" (where Git cloned the repository) or to the location where you unzipped the project.
For additional configuration for the validator services check the Configuration chapter from the tech-manual.pdf
After this preparation command, run
make start-servicesin the shell window.
To stop the services run:
make stop-servicesvalidator-set-report-template
- Syntax: make location=</your-custom/shapes/location> validator-set-shacl-shapes
- Used for: copying your custom validator report template inside the container's volume
validator-set-shacl-shapes
- Syntax: make location=</your-custom/shapes/location> validator-set-shacl-shapes
- Used for: copying your custom SHACL shapes inside the container's volume
For usage examples check the Usage chapter from the tech-manual.pdf
- The architectural design and the detailed deployment specifications are provided in the Enterprise Architecture document.
- The technical guide for installing and running the services are provided in the "Installation guide".
/docs- the documentation specific to this project/docs/lam-architecture- the LaTeX source of the enterprise architecture document/docs/references- a database of literature references used in the enterprise architecture document and technical user manual/docs/tech-manual- the technical user manual for installing and running the services
/docker- the docker files representing specification and configurations for running the services on a target server/lam4doc- source code for the LAM Generation Service/validator- source code for the Validator ServiceREADME.md- this file
Please note that the configured values can be changed by modifying the /docker/.env file.
This service encapsulates the actual validation engine and exposes its functionality as an API.
| Description | Value | Associated variable |
|---|---|---|
| Internal URL | http://lam-validator-api | RDF_VALIDATOR_API_LOCATION |
| Port | 10001 | RDF_VALIDATOR_API_PORT |
NOTE: When validating SPARQL endpoints, the fully qualified domain name of the machine must be specified. As a consequence, localhost will not work.
| Description | Value | Associated variable |
|---|---|---|
| Internal URL | http://lam-validator-ui | RDF_VALIDATOR_UI_LOCATION |
| Port | 10002 | RDF_VALIDATOR_UI_PORT |
NOTE: When validating SPARQL endpoints, the fully qualified domain name of the machine must be specified. As a consequence, localhost will never work.
| Description | Value | Associated variable |
|---|---|---|
| Internal URL | http://lam-generation-service-api | LAM_API_LOCATION |
| Port | 4050 | LAM_API_PORT |
| Description | Value | Associated variable |
|---|---|---|
| Internal URL | http://lam-generation-service-ui | LAM_UI_LOCATION |
| Port | 8050 | LAM_UI_PORT |
| Description | Value | Associated variable |
|---|---|---|
| Internal URL | http://lam-generation-service-ui | LAM_UI_LOCATION |
| Port | 8050 | LAM_UI_PORT |
This is the triple store that is used by the LAM generation service software to generate the report and indexes.
| Description | Value | Associated variable |
|---|---|---|
| Admin account password | admin | LAM_FUSEKI_ADMIN_PASSWORD |
| User name | admin | LAM_FUSEKI_USERNAME |
| Password | admin | LAM_FUSEKI_PASSWORD |
| Folder where Fuseki stores data | ./fuseki-lam-volume |
LAM_FUSEKI_DATA_FOLDER |
| Internal port | 3030 | LAM_FUSEKI_PORT |
| External port | 3010 | LAM_FUSEKI_EXTERNAL_PORT |
| Additional arguments passed to JVM | -Xmx2g | LAM_FUSEKI_JVM_ARGS |
| URL | http://rdf-differ-fuseki | LAM_FUSEKI_LOCATION |
| Query URL | /lam/query | LAM_FUSEKI_QUERY_URL |
Please note that the URL is only available inside the same Docker containers network and is not visible from the outside. Its purpose is to provide a named way for a service to connect to another service.
At least 8 Gb of RAM. At least a dual core CPU. At least 64Gb of free space.
A Linux distribution having a kernel with a version higher than 5.4.0.
The following ports must be available on the host machine, as they will be bound to by different docker services:
| Port | Service |
|---|---|
| 3010 | LAM Fuseki |
| 4050 | LAM Generation Service API |
| 8050 | LAM Generation Service UI |
| 10001 | LAM Validator API |
| 10002 | LAM Validator UI |
You are more than welcome to help expand and mature this project.
When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
Please note we adhere to Apache code of conduct, please follow it in all your interactions with the project.
The documents, such as reports and specifications, available in the /doc folder, are licenced under a CC BY 4.0 licence.
The source code and other scripts are licenced under EUPL v1.2 licence.