Skip to content

Commit

Permalink
Adding module-documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
cuioss committed Nov 13, 2023
1 parent 2150380 commit 92a7106
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions modules/authentication/portal-authentication-mock/README.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
= portal-authentication-mock
:toc:


== What is it?
Implementation of 'portal-authentication-api' for cases where it is only needed technically or for documentation purpose.
In contrast to 'portal-authentication-dummy' this module must never be used in production environments.

== Maven Coordinates

[source, xml]
----
<dependency>
<groupId>de.cuioss.portal.authentication</groupId>
<artifactId>portal-authentication-mock</artifactId>
</dependency>
----

== Configuration

Keys and defaults:

[source, properties]
----
portal.MockAuthenticationFacade.authenticated=true
portal.MockAuthenticationFacade.username=user
portal.MockAuthenticationFacade.system=mock
portal.MockAuthenticationFacade.groups= // Comma separated String
portal.MockAuthenticationFacade.roles= // Comma separated String
portal.MockAuthenticationFacade.contextMap= // Suffix with the conrete keys, like portal.MockAuthenticationFacade.contextMap.mykey=myValue
----

0 comments on commit 92a7106

Please sign in to comment.