Skip to content

Align documentation with documentation webpage content (single source of truth) #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
GGoetzelmann merged 1 commit into from
Jun 13, 2025
Merged

Align documentation with documentation webpage content (single source of truth) #23

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 0 additions & 42 deletions howtos/INSTALL
View file
Open in desktop

This file was deleted.

35 changes: 35 additions & 0 deletions howtos/build-from-source.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
absorb: true
---

## Prerequisites

* git
* maven installed (tested 3.5.x)
* OpenJDK 8+

## Building the WAP Server

At first, you have to clone the software repository and change to the project folder:

```
user@localhost:/home/user/$ git clone https://github.com/kit-data-manager/wap-server.git
[...]
user@localhost:/home/user/$ cd wap-server
user@localhost:/home/user/wap-server$
```

The build can now be started via:

```
user@localhost:/home/user/wap-server$ mvn clean verify
[...]
```

Now, copy the final jar file from the *target/* folder to an empty folder in order to prepare the first start of the service.

```
user@localhost:/home/user/wap-server$ mkdir /home/user/wap-instance
user@localhost:/home/user/wap-server$ cp target/PSE-AA-0.0.1-SNAPSHOT.jar /home/user/wap-instance
[...]
```
32 changes: 32 additions & 0 deletions howtos/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
absorb: true
---

| Property | Description | Default |
|---------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------|
| JsonLdCachedProfileValidityInMs | The time in ms a cached JSON-LD profile is regarded up to date. If elapsed, the registry performs an update-download. | 86400000 |
| ShouldAppendStackTraceToErrorMessages | Should stack traces be appended to http error messages. Of great help during debugging. | false |
| DataBasePath | The path where the database gets stored. | ./production_db |
| EnableMandatorySlugInContainerPost | Is the Slug header mandatory when creating containers via POST. | false |
| EnableValidation | Is validation of Annotation and Container during POST active. | true |
| WebClientFolder | The folder where the web client is located. | /webcontent |
| JsonLdProfileFolder | The folder where the JSON-LD profiles are locally cached. | ./profiles |
| SparqlReadIp | The IP of the SPARQL read-only endpoint. Either a specific one (including localhost) or * for all | * |
| EnableContentNegotiation | Is content negotiation active. | true |
| SparqlReadPort | The port of the SPARQL read-only endpoint. Use -1 to disable this endpoint. | 3330 |
| FallbackValidation | Is fallback validation active. When posting elements in a format that has no specific validator implementation, the data is converted to JSON-LD and validated in this format before it gets posted. | true |
| Hostname | The hostname under which this server can be reached. It has to be translated to the IP set in WapIp by DNS. This setting has influence on the root IRI and cannot be changed after a database has been created. For details refers to the Root Container section later. | localhost |
| CorsAllowedOriginsPath | The file where CORS allowed origins are stored. If the file does not exist on application startup, it is autocreated using the default setting to allow CORS for all origins. For details refers to the Cors section later. | ./cors_allowed_origins.conf |
| WapIp | The IP of the WAP endpoint. Either a specific one (including localhost) or * for all. | * |
| EnableMandatoryLabelInContainers | Are labels mandatory when creating containers via POST. | false |
| JavaDocFolder | The folder where the javadoc is stored. | ./doc |
| EnableHttps | Is HTTPS active. HTTPS has additional dependencies. This setting has influence on the root IRI and cannot be changed after a database has been created. For details refer so the SSL section later. | false |
| JsonLdFrameFolder | The folder where the JSON-LD frames are stored. | ./profiles |
| JsonLdValidator_SchemaFolder | The folder where the JSON-LD schemas are stored. | ./schemas |
| SimpleFormatters | The string configuring simple formats. For details refer to the Formats section later. | NTRIPLES\*application/n-triples | RDF_JSON\*application/rdf+json |
| SparqlWritePort | The port of the SPARQL read-write endpoint. Use -1 to disable this endpoint. | 3331 |
| SparqlWriteIp | The IP of the SPARQL read-write endpoint. Either a specific one (including localhost) or * for all. | localhost |
| PageSize | The count of annotations that lie within one PAGE in responses. | 20 |
| MultipleAnnotationPost | Is posting multiple annotations in one request possible. | true |
| WapPort | The port under which the WAP service is reachable. This port is used for HTTP and HTTPS service. When 80 is set and a http service is used, the port is omitted. The same applies to HTTPS and port 443. This setting has influence on the root IRI and cannot be changed after a database has been created. For details refer to the Root Container section. | 80 |
| RdfBackendImplementation | The qualifier of the used RDF backend implementation. The default backend is 'jena'. | jena |
Loading