Skip to content

Commit ad2e3a2

Browse files
rpietzschrpietzsch
committed
update DP config docs
1 parent ef731a3 commit ad2e3a2

6 files changed

Lines changed: 91 additions & 32 deletions

File tree

‎docs/deploy-and-configure/configuration/explore/dataplatform/application-full.md‎

Lines changed: 74 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ URI where to redirect to when the user logs out
6363

6464
## License
6565

66-
By default, DataPlatform is subject to the eccenca free Personal, Evaluation and Development License Agreement (PEDAL), a license intended for non-commercial usage. When your delivery includes a dedicated license file, you have to configure DataPlatform to enable your license.
66+
By default, DataPlatform is subject to the eccenca free Personal, Evaluation and Development License Agreement (PEDAL), a license intended for non-commercial usage. When your delivery includes a dedicated license file, you have to configure DataPlatform to enable your license.
6767
To change the default configuration, you have several options. If the properties under license are not provided the default license included (PEDAL) is used.
6868

6969
In case a dedicated license file is used, different configuration options can overwrite each other. The license is read in the following sequence:
@@ -299,8 +299,17 @@ Use this property to enable or disable the AI capabilities of Explore
299299
| Valid values | string |
300300
| Environment | SPRING_AI_CHAT_CLIENT_ENABLED |
301301
302+
#### Configuration of MCP Server
303+
304+
Changeable configuration settings of the companion mcp server.
305+
306+
307+
#### Server configuration
308+
309+
302310
***Property: spring.ai.mcp.server.name***
303311
312+
Server name for identification
304313
305314
| Category | Value |
306315
|--- | ---: |
@@ -311,6 +320,7 @@ Use this property to enable or disable the AI capabilities of Explore
311320
312321
***Property: spring.ai.mcp.server.version***
313322
323+
Server version
314324
315325
| Category | Value |
316326
|--- | ---: |
@@ -321,12 +331,13 @@ Use this property to enable or disable the AI capabilities of Explore
321331
322332
***Property: spring.ai.mcp.server.type***
323333
334+
Server type (SYNC/ASYNC) s. https://docs.spring.io/spring-ai/reference/index.html
324335
325336
| Category | Value |
326337
|--- | ---: |
327338
| Default | SYNC |
328339
| Required | false |
329-
| Valid values | string |
340+
| Valid values | SYNC, ASYNC |
330341
| Environment | SPRING_AI_MCP_SERVER_TYPE |
331342
332343
***Property: spring.ai.mcp.server.instructions***
@@ -381,6 +392,7 @@ Use this property to enable or disable the AI capabilities of Explore
381392
382393
***Property: spring.ai.mcp.server.enabled***
383394
395+
Whether the mcp server is enabled or not
384396
385397
| Category | Value |
386398
|--- | ---: |
@@ -389,35 +401,49 @@ Use this property to enable or disable the AI capabilities of Explore
389401
| Valid values | string |
390402
| Environment | SPRING_AI_MCP_SERVER_ENABLED |
391403
392-
***Property: spring.ai.mcp.server.sse-message-endpoint***
404+
***Property: spring.ai.mcp.server.protocol***
393405
406+
Protocol used for communication between mcp server and client s. https://docs.spring.io/spring-ai/reference/index.html
394407
395408
| Category | Value |
396409
|--- | ---: |
397-
| Default | /dataplatform/mcp/messages |
410+
| Default | streamable |
411+
| Required | false |
412+
| Valid values | stateless, streamable |
413+
| Environment | SPRING_AI_MCP_SERVER_PROTOCOL |
414+
415+
***Property: spring.ai.mcp.server.streamable-http.mcp-endpoint***
416+
417+
Endpoint for mcp streamable protocol (prefix must be dataplatform)
418+
419+
| Category | Value |
420+
|--- | ---: |
421+
| Default | /dataplatform/mcp/streamable |
398422
| Required | false |
399423
| Valid values | string |
400-
| Environment | SPRING_AI_MCP_SERVER_SSE_MESSAGE_ENDPOINT |
424+
| Environment | SPRING_AI_MCP_SERVER_STREAMABLE_HTTP_MCP_ENDPOINT |
401425
402-
***Property: spring.ai.mcp.server.sse-endpoint***
426+
***Property: spring.ai.mcp.server.sse-message-endpoint***
403427
428+
Endpoint for mcp sse protocol (prefix must be dataplatform)
404429
405430
| Category | Value |
406431
|--- | ---: |
407-
| Default | /dataplatform/mcp/sse |
432+
| Default | /dataplatform/mcp/messages |
408433
| Required | false |
409434
| Valid values | string |
410-
| Environment | SPRING_AI_MCP_SERVER_SSE_ENDPOINT |
435+
| Environment | SPRING_AI_MCP_SERVER_SSE_MESSAGE_ENDPOINT |
411436
412-
***Property: spring.ai.mcp.server.stdio***
437+
***Property: spring.ai.mcp.server.sse-endpoint***
413438
439+
Endpoint for mcp sse protocol (prefix must be dataplatform)
414440
415441
| Category | Value |
416442
|--- | ---: |
417-
| Default | false |
443+
| Default | /dataplatform/mcp/sse |
418444
| Required | false |
419445
| Valid values | string |
420-
| Environment | SPRING_AI_MCP_SERVER_STDIO |
446+
| Environment | SPRING_AI_MCP_SERVER_SSE_ENDPOINT |
421447
422448
***Property: spring.ai.model.chat***
423449
@@ -497,7 +523,7 @@ This configures the possible chat models for interacting with the companion.
497523
498524
| Category | Value |
499525
|--- | ---: |
500-
| Default | <ENDPOINT> |
526+
| Default | <ENDPOINT_URI> |
501527
| Required | false |
502528
| Valid values | string |
503529
| Environment | SPRING_AI_AZURE_OPENAI_ENDPOINT |
@@ -780,7 +806,7 @@ Use this property to define the list of allowed HTTP headers. The special value
780806
781807
| Category | Value |
782808
|--- | ---: |
783-
| Default | [Authorization, X-Requested-With, Content-Type, Content-Length, ETag] |
809+
| Default | [Authorization, X-Requested-With, Content-Type, Content-Length, ETag, mcp-protocol-version, mcp-session-id] |
784810
| Required | false |
785811
| Valid values | list of strings |
786812
| Environment | HTTP_CORS_ALLOWEDHEADERS |
@@ -791,7 +817,7 @@ Use this property to define the list of headers that an actual response might ha
791817
792818
| Category | Value |
793819
|--- | ---: |
794-
| Default | [WWW-Authenticate, Link, ETag] |
820+
| Default | [WWW-Authenticate, Link, ETag, mcp-session-id] |
795821
| Required | false |
796822
| Valid values | list of strings |
797823
| Environment | HTTP_CORS_EXPOSEDHEADERS |
@@ -941,8 +967,7 @@ Use this property to configure the URI of the public user (see section Public ac
941967
942968
***Property: authorization.abox.accessConditions.url***
943969
944-
**DEPRECATED**
945-
Use this property to set the URL of the access conditions model file. This can be either a remote (http://...) or a local (file:...) .rdf file. Refer to section Access conditions for more information on the access conditions model.
970+
**Deprecation:** Use this property to set the URL of the access conditions model file. This can be either a remote (http://...) or a local (file:...) .rdf file. Refer to section Access conditions for more information on the access conditions model.
946971
947972
948973
| Category | Value |
@@ -954,8 +979,7 @@ Use this property to set the URL of the access conditions model file. This can b
954979
955980
***Property: authorization.abox.accessConditions.graph***
956981
957-
**DEPRECATED**
958-
Use this property to set the graph containing the access conditions model.
982+
**Deprecation:** Use this property to set the graph containing the access conditions model.
959983
**Note:** If you change this property, you also need to change the corresponding shape definitions for access conditions (more precisely, the UI SPARQL queries).
960984
961985
@@ -973,7 +997,7 @@ SPARQL endpoints declare how DataPlatform connects to a SPARQL-capable store or
973997
974998
With the default configuration, DataPlatform uses an in-memory database. This means, that no persistent storage is available, unless a store supporting data persistence is configured.
975999
976-
The following example showcases a setup in which for each Resource all rdfs:label, Literals with language es, then en and in the end those without a language are evaluated.
1000+
The following example showcases a setup in which for each Resource all rdfs:label, Literals with language es, then en and in the end those without a language are evaluated.
9771001
If nothing matches here, skos:prefLabel is examined in the same way
9781002
9791003
```yaml
@@ -1022,14 +1046,14 @@ Use this property to specify which RDF properties should be used to provide desc
10221046
10231047
| Category | Value |
10241048
|--- | ---: |
1025-
| Default | [http://purl.org/dc/terms/description, http://www.w3.org/2000/01/rdf-schema#comment] |
1049+
| Default | [http://www.w3.org/2004/02/skos/core#definition, http://purl.org/dc/terms/description, http://www.w3.org/2000/01/rdf-schema#comment] |
10261050
| Required | false |
10271051
| Valid values | list of Properties |
10281052
| Environment | PROXY_DESCRIPTIONPROPERTIES |
10291053
10301054
***Property: proxy.languagePreferences***
10311055
1032-
Specifies base language preferences for this instance.
1056+
Specifies base language preferences for this instance.
10331057
10341058
**Note:** This configuration property affects results of SELECT-queries when the resolveLabels property is set to LABELS.
10351059
@@ -1068,7 +1092,7 @@ Increasing the max fetch will support deeper constructs, but will also add to lo
10681092
10691093
***Property: proxy.maxCBDStatements***
10701094
1071-
The max amount of statements which the Concise Bound Description can contain.
1095+
The max amount of statements which the Concise Bound Description can contain.
10721096
(S)CBDs surpassing this will not load but return an error
10731097
10741098
@@ -1079,6 +1103,19 @@ The max amount of statements which the Concise Bound Description can contain.
10791103
| Valid values | string |
10801104
| Environment | PROXY_MAXCBDSTATEMENTS |
10811105
1106+
***Property: proxy.cbdChangeVersioning***
1107+
1108+
Determines whether the changes on CBDs are added to the graph versioning which exists for
1109+
SHACL-based changes.
1110+
1111+
1112+
| Category | Value |
1113+
|--- | ---: |
1114+
| Default | true |
1115+
| Required | false |
1116+
| Valid values | string |
1117+
| Environment | PROXY_CBDCHANGEVERSIONING |
1118+
10821119
***Property: proxy.shapedMaxValueCount***
10831120
10841121
Maximum Values for shaped Resources
@@ -1177,6 +1214,17 @@ The limit of data for the GSP zip-bomb check in bytes. If this limit is exceeded
11771214
| Valid values | string |
11781215
| Environment | PROXY_GSPUPLOADGZIPCONTENTLIMIT |
11791216

1217+
***Property: proxy.gspPrettyTurtlePrintSizeLimit***
1218+
1219+
The limit of data in bytes for the turtle pretty print GSP option. That amount of data is loaded into memory. On exceeding it the graph download is aborted.
1220+
1221+
| Category | Value |
1222+
|--- | ---: |
1223+
| Default | 1073741824 |
1224+
| Required | false |
1225+
| Valid values | string |
1226+
| Environment | PROXY_GSPPRETTYTURTLEPRINTSIZELIMIT |
1227+
11801228
***Property: proxy.proxy-sparql-streaming-format***
11811229

11821230
The format in which internally SPARQL results are fetched from the store. For streaming either JSON or XML
@@ -1295,7 +1343,7 @@ The committer name which appears in the commit message on system commits
12951343

12961344
***Property: gitSync.committerEmail***
12971345

1298-
The committer email which appears in the commit message on system commits
1346+
The committer email which appears in the commit message on system commits
12991347

13001348
| Category | Value |
13011349
|--- | ---: |
@@ -1706,7 +1754,7 @@ Bulk upload Pool Size - Limits how many (bulk/large) uploads via GSP / bulk load
17061754

17071755
***Property: scheduler.analyticalPoolSize***
17081756

1709-
Limits how many analytical requests can be run in parallel. Analytical requests can have longer runtimes than retrieval requests.
1757+
Limits how many analytical requests can be run in parallel. Analytical requests can have longer runtimes than retrieval requests.
17101758

17111759
| Category | Value |
17121760
|--- | ---: |
@@ -1728,7 +1776,7 @@ Limits how many background query requests can be run in parallel. This applies t
17281776

17291777
## Asynchronous file uploads
17301778

1731-
Files can be asynchronously uploaded to the backend store in multiple steps which include an analysis of the uploaded file.
1779+
Files can be asynchronously uploaded to the backend store in multiple steps which include an analysis of the uploaded file.
17321780
Please s. API documentation under /api/upload/ for further information.
17331781

17341782

@@ -1794,7 +1842,7 @@ One of the supported types of backends DataPlatform can connect to
17941842
|--- | ---: |
17951843
| Default | *none* |
17961844
| Required | true |
1797-
| Valid values | MEMORY, HTTP, GRAPHDB, VIRTUOSO, NEPTUNE |
1845+
| Valid values | MEMORY, HTTP, GRAPHDB, VIRTUOSO, NEPTUNE, TENTRIS |
17981846
| Environment | STORE_TYPE |
17991847

18001848
***Property: store.owlImportsResolution***

‎docs/deploy-and-configure/configuration/explore/dataplatform/application-graphdb-full.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,17 @@ Set to true to use the native Graph Store API endpoint. Set to false to use the
130130
| Valid values | boolean |
131131
| Environment | STORE_GRAPHDB_USEDIRECTTRANSFER |
132132

133+
***Property: store.graphdb.useStatementParallelGspWrite***
134+
135+
Whether to use the parallel GSP write endpoint for statements. This is only relevant when `useDirectTransfer` is true.
136+
137+
| Category | Value |
138+
|--- | ---: |
139+
| Default | false |
140+
| Required | false |
141+
| Valid values | boolean |
142+
| Environment | STORE_GRAPHDB_USESTATEMENTPARALLELGSPWRITE |
143+
133144
***Property: store.graphdb.create-repository-on-startup***
134145

135146
Whether to create the given repository on startup if it does not exist

‎docs/deploy-and-configure/configuration/explore/dataplatform/application-inmemory-full.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ tags:
55

66
## Configuration for connecting to internal memory backend
77

8-
You can configure a in-memory SPARQL backend. Based on Jena Models, in-memory backends do not provide persistent storage.
8+
You can configure a in-memory SPARQL backend. Based on Jena Models, in-memory backends do not provide persistent storage.
99
Hence, shutting down a DataPlatform configured with an in-memory backend deletes your data and therefore you should use it only for testing purposes.
10-
10+
1111
Configuration example:
1212

1313
This example configures an in-memory store which initializes with the triples contained in the given file.
@@ -18,7 +18,7 @@ store:
1818
authorization: REWRITE_FROM
1919
memory:
2020
files:
21-
- "/data/data.trig"
21+
- "/data/data.trig"
2222
```
2323
2424

‎docs/deploy-and-configure/configuration/explore/dataplatform/application-neptune-full.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ tags:
77

88
Configuration example:
99

10-
This example configures a connection to a neptune instance in the AWS region eu-central-1. Authentication is enabled
10+
This example configures a connection to a neptune instance in the AWS region eu-central-1. Authentication is enabled
1111
so it is assumed that CMEM runs on a EC2 VM with configured role for authentication to neptune. Files (uncompressed) greater than 100MB are
1212
uploaded via S3 based bulk loader. The S3 bucket is accessed in this case via an access point which is configured here. The EC2
1313
role CMEM runs under has write access to the bucket. One of the role the neptune cluster runs under is configured in this setting and has read access to the bucket.

‎docs/deploy-and-configure/configuration/explore/dataplatform/application-oauth-full.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ Use this property to specify the claim providing the OAuth 2.0 client ID to whic
104104
105105
#### OAuth 2.0 client configuration
106106
107-
In order to protect access to it's resources, DataPlatform acts as an OAuth 2.0 Client which provides authentication its own clients by means of a session cookie. For this type of authentication a JSON Web Token (JWT)
107+
In order to protect access to it's resources, DataPlatform acts as an OAuth 2.0 Client which provides authentication its own clients by means of a session cookie. For this type of authentication a JSON Web Token (JWT)
108108
is not necessary. The registration which is configured is named "keycloak" and provides a login page redirecting to a keycloak backend. For specific customizations please s. https://docs.spring.io/spring-security/reference/servlet/oauth2/client/index.html
109109
110110

‎docs/deploy-and-configure/configuration/explore/dataplatform/application-virtuoso-full.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ tags:
77

88
Configuration example:
99

10-
This example configures a connection with HTTPS to a remote Virtuoso store (https://remote:8080).
10+
This example configures a connection with HTTPS to a remote Virtuoso store (https://remote:8080).
1111

1212
```yaml
1313
store:

0 commit comments

Comments
 (0)