Commit c811fe9e authored by Gradl, Tobias's avatar Gradl, Tobias
Browse files

12: Compose some initial documentation

Task-Url: #12
parent 8897f567
Pipeline #17845 passed with stage
in 1 minute and 50 seconds
......@@ -10,7 +10,7 @@ While still being used, the former v1.4 is discontinued and - being based on Ope
A reference implementation and quick-start guide can be found in the [dariahsp-sample-boot](dariahsp-sample-boot) application.
## 2. Repository and dependency setup
## 2. Getting the library
The library and sample application are deployed to the Maven repository available at https://minfba.de.dariah.eu/nexus. Repository configuration can be included in Maven and Gradle settings and build configurations with the following snippets.
### 2.1 Maven setup
......@@ -93,6 +93,10 @@ Include the dependency to dariahsp-core in your `build.gradle`.
implementation 'eu.dariah.de:dariahsp-core:2.0.0-SNAPSHOT'
```
### 2.3 Manual download
The library and sample application can be downloaded from the Maven repository. In addition, build artifacts are composed and held at the GitLab repository of the project. For latest published builds see [dariahsp-core](-/jobs/artifacts/v2.0/browse/dariahsp-core/build/libs/?job=build) and [dariahsp-sample-boot](-/jobs/artifacts/v2.0/browse/dariahsp-sample-boot/build/libs/?job=build). Please not that while a new version is being prepared, a 404 error is issued when following these links.
## 3. Security concepts and entry points
As this library is based on Spring Security, concepts such as _Java-based configuration_, _filters_, _interceptors_ or _global method security_ can be referenced in the respective Spring documentation, e.g. the [Spring Core reference](https://docs.spring.io/spring-framework/docs/current/reference/html/core.html), the [Spring Web reference](https://docs.spring.io/spring-framework/docs/current/reference/html/web.html) and the [Spring Security Architecture](https://spring.io/guides/topicals/spring-security-architecture).
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment