This guide describes how to login to LinkedDataHub.
In order to authenticate as the owner of a LinkedDataHub instance, you need to use the WebID authentication method.
+In order to authenticate as the owner of a LinkedDataHub instance, you need to use the WebID authentication method.
-Get certificate
-LinkedDataHub uses WebID as the Single sign-on (SSO) - protocol for distributed applications, which is based on authentication using TLS client certficates. Using WebID, you will be able to authenticate with every LinkedDataHub application. - Read more about WebID.
-There are two ways to get a LinkedDataHub WebID: setup and signup.
-Complete the setup and run own an instance of LinkedDataHub.
-The ssl/owner/keystore.p12 file is your WebID certificate. The password is the owner_cert_password Docker secret value.
-Sign up to an existing instance of LinkedDataHub. Click the Sign up button and fill out the form with your - details to get a WebID, as shown below.
-
- 
You will get an email with a .p12 file attached, which is your WebID certificate. The certificate's password is the one you entered in the signup form.
-You'll need a PEM version of the certificate for use with the command line interface scripts. During setup, it is stored under - ssl/owner/cert.pem. If you got the certificate by email, you need to convert the PKCS12 file to PEM using OpenSSL.
-Unlike most LinkedDataHub resources, your WebID profile will have public access as required by the protocol. Your email address will be hidden however.
-Install certificate
-The final step is to install the client certificate into your web browser. It is done by importing the .p12 - file using the browser's certificate manager and providing the password that you supplied during signup. The - manager dialog can be opened following the steps below, depending on which browser you use:
--
-
- Google Chrome -
- Settings > Advanced > Manage Certificates > Import... -
- Mozilla Firefox -
- Options > Privacy & Security > View Certificates... > Import... -
- Apple Safari -
- The file is installed directly into the operating system. Open the file and import it using the - Keychain Access - tool. Drag the .p12 file to the login section. -
- Microsoft Edge -
- Does not support certificate management, you need to install the file into Windows. - Read more here. -
You need to install the certificate on all devices/browsers that you are using to access LinkedDataHub.
+Get certificate
+LinkedDataHub uses WebID as the Single sign-on (SSO) + protocol for distributed applications, which is based on authentication using TLS client certficates. Using WebID, you will be able to authenticate with every LinkedDataHub application. + Read more about WebID.
+There are two ways to get a LinkedDataHub WebID: setup and signup.
+Complete the setup and run own an instance of LinkedDataHub.
+The ssl/owner/keystore.p12 file is your WebID certificate. The password is the owner_cert_password Docker secret value.
Log in
-Open the URL of the LinkedDataHub instance in the web browser (that you installed the WebID certificate into). Using a local setup, it runs on https://localhost:4443/ by default.
-With the certificate installed, there is no login procedure — you are automatically authenticated on all - LinkedDataHub applications. This is known as Single sign-on (SSO).
-Applications can provide public access to some or all documents, meaning you can freely browse their public resources - and perform actions that are allowed for public access. In order to access protected (non-public) resources, as well - as to access administration application, users have to be authenticated as well authorized (authorizations - can be requested).
-Authenticated agents are not guaranteed to have access to all resources. Different access levels for - different agents can be specified by the application administrators.
-Sign up to an existing instance of LinkedDataHub. Click the Sign up button and fill out the form with your + details to get a WebID, as shown below.
+
+
You will get an email with a .p12 file attached, which is your WebID certificate. The certificate's password is the one you entered in the signup form.
Click the Login with Google button in the navbar to authenticate with your Google account.
-If the email address of your Google account matches the dataspace owner's email address that was specified during setup, you will be authenticated as the owner with full control access rights.
-Login with Google is only enabled if LinkedDataHub was configured with social login.
-You'll need a PEM version of the certificate for use with the command line interface scripts. During setup, it is stored under + ssl/owner/cert.pem. If you got the certificate by email, you need to convert the PKCS12 file to PEM using OpenSSL.
+Unlike most LinkedDataHub resources, your WebID profile will have public access as required by the protocol. Your email address will be hidden however.
+Install certificate
+The final step is to install the client certificate into your web browser. It is done by importing the .p12 + file using the browser's certificate manager and providing the password that you supplied during signup. The + manager dialog can be opened following the steps below, depending on which browser you use:
+-
+
- Google Chrome +
- Settings > Advanced > Manage Certificates > Import... +
- Mozilla Firefox +
- Options > Privacy & Security > View Certificates... > Import... +
- Apple Safari +
- The file is installed directly into the operating system. Open the file and import it using the + Keychain Access + tool. Drag the .p12 file to the login section. +
- Microsoft Edge +
- Does not support certificate management, you need to install the file into Windows. + Read more here. +
You need to install the certificate on all devices/browsers that you are using to access LinkedDataHub.
+Log in
+Open the URL of the LinkedDataHub instance in the web browser (that you installed the WebID certificate into). Using a local setup, it runs on https://localhost:4443/ by default.
+With the certificate installed, there is no login procedure — you are automatically authenticated on all + LinkedDataHub applications. This is known as Single sign-on (SSO).
+Applications can provide public access to some or all documents, meaning you can freely browse their public resources + and perform actions that are allowed for public access. In order to access protected (non-public) resources, as well + as to access administration application, users have to be authenticated as well authorized (authorizations + can be requested).
+Authenticated agents are not guaranteed to have access to all resources. Different access levels for + different agents can be specified by the application administrators.
+Click the Login with Google button in the navbar to authenticate with your Google account.
+If the email address of your Google account matches the dataspace owner's email address that was specified during setup, you will be authenticated as the owner with full control access rights.
+Login with Google is only enabled if LinkedDataHub was configured with social login.
To sign in, click on the Login with Google button. A unique agent URI will be assigned to you and used to authenticate you with the applications on the platform.
-Start LinkedDataHub
-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.
-Prerequisites:
--
-
- bash shell. It should be included by default on Linux. On Windows you can install the Windows Subsystem for Linux. -
- openssl available on
$PATH.
- - Docker installed -
- Docker Compose installed -
Steps:
--
-
- Fork the LinkedDataHub repository - and clone the fork into a folder -
- In the folder, create an .env file and fill out the missing values (you can use .env_sample as a template). For example:
-
COMPOSE_CONVERT_WINDOWS_PATHS=1 +
Start LinkedDataHub
+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.
+Prerequisites:
+-
+
- bash shell. It should be included by default on Linux. On Windows you can install the Windows Subsystem for Linux. +
- openssl available on
$PATH.
+ - Docker installed +
- Docker Compose installed +
Steps:
+-
+
- Fork the LinkedDataHub repository + and clone the fork into a folder +
- In the folder, create an .env file and fill out the missing values (you can use .env_sample as a template). For example:
+
COMPOSE_CONVERT_WINDOWS_PATHS=1 COMPOSE_PROJECT_NAME=linkeddatahub PROTOCOL=https @@ -54,51 +46,42 @@ OWNER_ORGANIZATION=My org OWNER_LOCALITY=Copenhagen OWNER_STATE_OR_PROVINCE=Denmark OWNER_COUNTRY_NAME=DK
-
- - Setup the server's SSL certificates by running this from command line:
-
./bin/server-cert-gen.sh .env nginx ssl
- The script will create an ssl/server sub-folder where the SSL certificate will be stored. -
- - Create the following secrets with certificate/truststore passwords:
-
-
-
- secrets/client_truststore_password.txt -
- secrets/owner_cert_password.txt -
- secrets/secretary_cert_password.txt -
- - (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. -
- Run this from command line:
-
docker-compose up --build
- LinkedDataHub will start and mount the following sub-folders: --
-
- data where the backend triplestores will persist RDF data -
- datasets where the owner and secretary agent metadata is persisted -
- ssl/owner and ssl/secretary where the owner and secretary SSL certificates and WebID public keys are persisted -
- uploads where LinkedDataHub stores content-hashed file uploads -
- config where dataspace and service configurations are stored -
-
You are now the owner of this LinkedDataHub instance; ssl/owner/keystore.p12 is your WebID certificate. Password is the owner_cert_password secret value.
-After a successful startup you should see periodic healthcheck requests being made to the https://localhost:4443/ns URL.
-
Reset
-If you need to start fresh and wipe the existing setup, you can do that using:
-sudo rm -rf data datasets uploads ssl && docker-compose down -v-
This will remove persisted RDF data, SSL keys, and uploaded files as well as the Docker volumes.
-Is LinkedDataHub running? Proceed to get an account.
-Access LinkedDataHub Cloud
-LinkedDataHub Cloud is a managed LinkedDataHub service, meaning that you do not have to do any setup yourself.
-Proceed to get an account to see how to login to LinkedDataHub Cloud.
-./bin/server-cert-gen.sh .env nginx ssl+ The script will create an ssl/server sub-folder where the SSL certificate will be stored. +
-
+
- secrets/client_truststore_password.txt +
- secrets/owner_cert_password.txt +
- secrets/secretary_cert_password.txt +
docker-compose up --build+ LinkedDataHub will start and mount the following sub-folders: +
-
+
- data where the backend triplestores will persist RDF data +
- datasets where the owner and secretary agent metadata is persisted +
- ssl/owner and ssl/secretary where the owner and secretary SSL certificates and WebID public keys are persisted +
- uploads where LinkedDataHub stores content-hashed file uploads +
- config where dataspace and service configurations are stored +
You are now the owner of this LinkedDataHub instance; ssl/owner/keystore.p12 is your WebID certificate. Password is the owner_cert_password secret value.
+After a successful startup you should see periodic healthcheck requests being made to the https://localhost:4443/ns URL.
+Reset
+If you need to start fresh and wipe the existing setup, you can do that using:
+sudo rm -rf data datasets uploads ssl && docker-compose down -v+
This will remove persisted RDF data, SSL keys, and uploaded files as well as the Docker volumes.
Is LinkedDataHub running? Proceed to get an account.
User accounts
User account is a subclass of the sioc:UserAccount
class. An account is the actual instance that performs actions on the application
- (manages documents, imports data etc.). An
+ (manages documents, imports data etc.). An
account always belongs to an agent.
ns.ttl — Package ontologyowl:imports and attaches blocks to properties using ldh:view (forward relationships) or ldh:inverseView (inverse relationships). Blocks are typically ldh:View resources with SPARQL queries that render related data for property values.layout.xsl — XSLT stylesheetbs2:* (Bootstrap 2.3.2 components) and xhtml:* (XHTML elements). See Stylesheets reference for details on XSLT customization.bs2:* (Bootstrap 2.3.2 components) and xhtml:* (XHTML elements). See Stylesheets reference for details on XSLT customization.Package files are organized in the LinkedDataHub-Apps repository:
packages/
@@ -191,7 +191,7 @@ schema:knows ldh:view :PersonKnows .
ORDER BY ?person
\"\"\" .
Write XSLT stylesheet
-Create layout.xsl with XSLT templates using system modes like bs2:* and xhtml:*. See the Stylesheets reference for template customization patterns.
Create layout.xsl with XSLT templates using system modes like bs2:* and xhtml:*. See the Stylesheets reference for template customization patterns.
<xsl:template match="schema:knows" mode="bs2:PropertyList"/>
Publish package metadata
Publish package metadata as Linked Data at your package URI:
diff --git a/docs/user-guide/create-data/create-content.ttl b/docs/user-guide/create-data/create-content.ttl index 4731c69..7201683 100644 --- a/docs/user-guide/create-data/create-content.ttl +++ b/docs/user-guide/create-data/create-content.ttl @@ -19,7 +19,7 @@- Linked Data resource
- Any URI that resolves to RDF data diff --git a/docs/user-guide/import-data/import-csv-data.ttl b/docs/user-guide/import-data/import-csv-data.ttl index b05881d..05ea75e 100644 --- a/docs/user-guide/import-data/import-csv-data.ttl +++ b/docs/user-guide/import-data/import-csv-data.ttl @@ -65,7 +65,7 @@
Step by step guide to creating a new dataspace backed by SPARQL services
-