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

12: Compose some initial documentation

Task-Url: #12
parent dad25ff8
Pipeline #17819 passed with stage
in 1 minute and 51 seconds
......@@ -42,6 +42,20 @@ implementation 'eu.dariah.de:dariahsp-core:2.0.0-SNAPSHOT'
The library supports a local authentication method that is purely based on application configuration properties. A working example including all configurable aspects:
```yaml
#Minimal working sample configuration with local authentication enabled and one configured user
auth:
local:
enabled: true
#Password hash for: 1234
users:
- username: 'admin'
passhash: '$2y$10$nmTcpRxs.RFUstkJJms6U.AW61Jmr64s9VNQLuhpU8gYrgzCapwka'
```
A more sophisticated configuration of the local authentication method could involve roles and role mappings along with a configured hierarchy between the roles
```yaml
auth:
#settings under roleHierarchy and roleDefinitions apply to all supported authentication methods
......@@ -50,18 +64,15 @@ auth:
- role: ADMINISTRATOR
level: 100
mappings:
local: ["application_admin"]
saml: ["application_admin"]
local: ["application_admin"]
- role: CONTRIBUTOR
level: 50
mappings:
local: ["application_contributor"]
saml: ["application_contributor"]
- role: USER
level: 10
mappings:
local: ["application_user"]
saml: ["application_user"]
#Enabled local authentication method with three configured users
local:
enabled: true
......
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