From 03bf7b0be3b71b5a878d87cba253e05f4fe82d5d Mon Sep 17 00:00:00 2001 From: mrflick72 Date: Wed, 20 Nov 2024 21:30:00 +0100 Subject: [PATCH] docs --- README.md | 7 ++++++- docs/profiles.md | 28 ++++++++++++++++++++++++++++ 2 files changed, 34 insertions(+), 1 deletion(-) create mode 100644 docs/profiles.md diff --git a/README.md b/README.md index e58ddd9a..606ce865 100644 --- a/README.md +++ b/README.md @@ -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) \ No newline at end of file +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) \ No newline at end of file diff --git a/docs/profiles.md b/docs/profiles.md new file mode 100644 index 00000000..11ee38a9 --- /dev/null +++ b/docs/profiles.md @@ -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 +``` +