Commit 5500e89f authored by Gradl, Tobias's avatar Gradl, Tobias
Browse files

12: Compose some initial documentation

Task-Url: #12
parent a004f847
Pipeline #17823 passed with stage
in 1 minute and 54 seconds
# dariahsp: service provider implementation for DARIAH services
This project contains the [dariahsp-core] library and the Spring Boot based [dariahsp-sample-boot] application. Implementations that are based on the core library need to include the dariahsp-core dependency and provide configuration for the primary security entry points.
This project contains the [dariahsp-core](dariahsp-core) library and the Spring Boot based [dariahsp-sample-boot](dariahsp-sample-boot) application. Implementations that are based on the core library need to include the dariahsp-core dependency and provide configuration for the primary security entry points.
The library is a wrapper around [Spring Security](https://spring.io/projects/spring-security), [PAC4J](https://www.pac4j.org/) and [OpenSAML 4](https://build.shibboleth.net/nexus/content/repositories/releases/org/opensaml/opensaml-core/) and implements two security methods that are commonly used in the context of DARIAH: the _local_ method is intended primarily for developer and test setups, the _saml_ method is targeted towards production environments. Both methods can easily be tested within the dariahsp-sample-boot web application. Opposed to earlier version, a choice between the methods is no longer determined by an environment flag, but by setting enabled properties within application properties. Methods can be enabled simultaneously and can work in parallel.
While still being used, the former v1.4 is discontinued and - being based on OpenSAML 2 ([also discontinued](https://wiki.shibboleth.net/confluence/display/OpenSAML/Home)) - should be replaced with a recent version.
## Getting started
## 1. Getting started
The library and sample application are deployed to a Maven repository at [https://minfba.de.dariah.eu/nexus]. Repository configuration can be included in Maven and Gradle settings and build configurations with the following snippets.
### Maven setup
### 1.1 Maven setup
Please find information on the current version of dariahsp-core at the [respective package](https://minfba.de.dariah.eu/nexus/#browse/browse:minfba-central:eu%2Fdariah%2Fde%2Fdariahsp-core) in the deployment repository:
#### Repository configuration
#### Maven: Repository configuration
The Proxy repository _minfba-central_ provides combined access to releases and snapshots.
......@@ -40,7 +40,7 @@ The release and snapshot repositories can be used selectively as well.
</snapshotRepository>
```
#### Dependency to dariahsp-core
#### Maven: Dependency to dariahsp-core
Include the dependency to dariahsp-core in your `pom.xml`.
......@@ -52,9 +52,9 @@ Include the dependency to dariahsp-core in your `pom.xml`.
</dependency>
```
### Gradle setup
### 1.2 Gradle setup
#### Repository configuration
#### Gradle: Repository configuration
For combined access to releases and snapshots, the Proxy repository _minfba-central_ can be utilized.
......@@ -81,15 +81,17 @@ repositories {
}
}
```
#### Dependency to dariahsp-core
#### Gradle: Dependency to dariahsp-core
Include the dependency to dariahsp-core in your `build.gradle`.
```
implementation 'eu.dariah.de:dariahsp-core:2.0.0-SNAPSHOT'
```
## Local user accounts
The library supports a local authentication method that is purely based on application configuration properties. A working example including all configurable aspects:
......
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