\n

Start LinkedDataHub

\n

This section assumes you will be running on your local machine, i.e. localhost. If you intend to run it on a different host, change the system base URI.

\n

Prerequisites:

\n

\n
• A bash shell — included on Linux and macOS; on Windows, install the Windows Subsystem for Linux
\n
• openssl on your $PATH
\n
• Docker
\n
• Docker Compose
\n

\n

Steps:

\n

\n
1. Fork the LinkedDataHub repository\n and clone the fork into a folder
\n
2. In the folder, copy .env_sample to .env and fill in the values. For example:\n

   COMPOSE_CONVERT_WINDOWS_PATHS=1\nCOMPOSE_PROJECT_NAME=linkeddatahub\n\nPROTOCOL=https\nHTTP_PORT=81\nHTTPS_PORT=4443\nHOST=localhost\n\nOWNER_MBOX=john@doe.com\nOWNER_GIVEN_NAME=John\nOWNER_FAMILY_NAME=Doe\nOWNER_ORG_UNIT=My unit\nOWNER_ORGANIZATION=My org\nOWNER_LOCALITY=Copenhagen\nOWNER_STATE_OR_PROVINCE=Denmark\nOWNER_COUNTRY_NAME=DK

   \n If port 81 or 4443 is already in use on your machine, choose different HTTP_PORT/HTTPS_PORT values.\n
\n
3. Set up the server's TLS certificates by running this from the command line:\n

   ./bin/server-cert-gen.sh .env nginx ssl

   \n The script will create an ssl/server sub-folder where the TLS certificate will be stored.\n
\n
4. Create the following secrets with certificate/truststore passwords:\n
   \n
   • secrets/client_truststore_password.txt
   \n
   • secrets/owner_cert_password.txt
   \n
   • secrets/secretary_cert_password.txt
   \n
   \n The one you will need to remember in order to authenticate with LinkedDataHub using WebID client certificate is owner_cert_password.\n
\n
5. (Optional) If you need to configure Bearer token authentication for SPARQL services, create secrets/credentials.trig with your service credentials. See the configuration reference for details.
\n
6. Run this from the command line:\n

   make up -- --build

   \n (make up forwards its arguments to docker-compose up; the -- is needed before arguments starting with -.)\n LinkedDataHub will start and mount the following sub-folders:\n

   LinkedDataHub/\n├── config/     # dataspace and service configuration (dataspaces.trig, system.trig)\n├── datasets/   # owner and secretary agent metadata\n├── fuseki/     # the triplestore's persisted RDF data, one TDB2 directory per dataset\n├── settings/   # dataspace settings changed at runtime, applied over config/ on restart\n├── ssl/\n│   ├── owner/      # your WebID certificate (keystore.p12)\n│   └── secretary/  # the service agent's certificate\n└── uploads/    # content-hashed file uploads

   \n
\n

\n \n

You are now the owner of this LinkedDataHub instance; ssl/owner/keystore.p12 is your WebID certificate. The password is the value you put in secrets/owner_cert_password.txt.

\n

Startup takes up to half a minute while the datasets are loaded into the triplestores. After a successful startup you should see periodic healthcheck requests being made to the https://localhost:4443/ns URL in the log:

\n

linkeddatahub-1  | ... \"GET /ns HTTP/1.1\" 200 ...

\n

\n

Common commands

\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Common commands and what they do

Command	Description
make up	Start the services; extra arguments are forwarded to docker-compose up, e.g. make up -- --build to rebuild the images first
make down	Stop the services; make down -- -v also removes the Docker volumes
make drop	Wipe the setup completely, as described under Reset

\n

make cli builds the command line interface and prints the line that puts it on your $PATH.

\n

\n

Reset

\n

If you need to start fresh and wipe the existing setup, you can do that using:

\n

make drop

\n

It stops the services, removes the Docker volumes, and wipes the local datasets, fuseki, ssl and uploads folders.

\n \n