Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mrFlick72 committed Nov 20, 2024
1 parent c01669f commit 03bf7b0
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,9 @@ Right now it is based, as said before to the latest version on spring oauth2/ope

### local environment

For more details please follow to this link [readme.md](local-environment%2Freadme.md)
For more details please follow to this link [readme.md](local-environment%2Freadme.md)

### profiling

The application configuration is very versatile and you can decide what persistence and key management provider to use AWS or not AWS native.
For more details please refer to the detailed page [here](docs/profiles.md)
28 changes: 28 additions & 0 deletions docs/profiles.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Profile

VAuthenticator can be configured to be strongly AWS integrated using DynamoDB for the persistence layer and KMS for Key management.

If your organization or for you run VAuthenticator so tiny integrated with AWS does not is suitable you can decide to switch postgresql instead dynamodb for the persistence
and plain java security key management instead of KMS

All what you need is enable the relative spring profile as below:

use ```spring.profiles.active``` with

- ```database```: to use PostgresSQL
- ```dynamo```: to use DyanamoDB
- ```kms``` to use KMS
- omitting ```kms``` to use plain java security api

in case of plain java security implementation the follow configuration is required:


```yaml
key:
master-key:
storage:
content:
key : value
key2 : value2
```

0 comments on commit 03bf7b0

Please sign in to comment.