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

12: Compose some initial documentation

Task-Url: #12
parent 74eb16bc
Pipeline #17822 passed with stage
in 1 minute and 51 seconds
...@@ -6,12 +6,16 @@ The library is a wrapper around [Spring Security](https://spring.io/projects/spr ...@@ -6,12 +6,16 @@ The library is a wrapper around [Spring Security](https://spring.io/projects/spr
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. 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.
## Deployment and distribution ## 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. 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.
#### 1a) Maven: repository configuration ### Maven setup
The Proxy repository _minfba-central_ provides access to releases and snapshots. 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
The Proxy repository _minfba-central_ provides combined access to releases and snapshots.
```xml ```xml
<repository> <repository>
...@@ -36,37 +40,52 @@ The release and snapshot repositories can be used selectively as well. ...@@ -36,37 +40,52 @@ The release and snapshot repositories can be used selectively as well.
</snapshotRepository> </snapshotRepository>
``` ```
#### 1b) Gradle: repository configuration #### Dependency to dariahsp-core
Include the dependency to dariahsp-core in your `pom.xml`.
```xml
<dependency>
<groupId>eu.dariah.de</groupId>
<artifactId>dariahsp-core</artifactId>
<version>2.0.0-SNAPSHOT</version>
</dependency>
```
### Gradle setup
Likewise, repository configuration in Gradle can be based on the central or dedicated snapshot and release repositories as well. #### Repository configuration
For combined access to releases and snapshots, the Proxy repository _minfba-central_ can be utilized.
```groovy ```groovy
repositories { repositories {
maven { maven {
url "https://minfba.de.dariah.eu/nexus/repository/minfba-central/" url "https://minfba.de.dariah.eu/nexus/repository/minfba-central/"
} }
// maven {
// url "https://minfba.de.dariah.eu/nexus/repository/minfba-releases/"
// }
// maven {
// url "https://minfba.de.dariah.eu/nexus/repository/minfba-snapshots/"
// }
} }
``` ```
#### 2a) Maven: dependency to dariahsp-core Immediate access to either releases or snapshots can be configured based on the respective repositories.
For the [current snapshot version](https://minfba.de.dariah.eu/nexus/#browse/browse:minfba-central:eu%2Fdariah%2Fde%2Fdariahsp-core) of the library:
```xml ```groovy
<dependency> repositories {
<groupId>eu.dariah.de</groupId> maven {
<artifactId>dariahsp-core</artifactId> url "https://minfba.de.dariah.eu/nexus/repository/minfba-central/"
<version>2.0.0-SNAPSHOT</version> }
</dependency> maven {
url "https://minfba.de.dariah.eu/nexus/repository/minfba-releases/"
}
maven {
url "https://minfba.de.dariah.eu/nexus/repository/minfba-snapshots/"
}
}
``` ```
#### Dependency to dariahsp-core
Include the dependency to dariahsp-core in your `build.gradle`.
#### 2b) Gradle: dependency to dariahsp-core
``` ```
implementation 'eu.dariah.de:dariahsp-core:2.0.0-SNAPSHOT' implementation 'eu.dariah.de:dariahsp-core:2.0.0-SNAPSHOT'
``` ```
......
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