From 9ddd34ed62f71f991d68988ad6a608e323599e8b Mon Sep 17 00:00:00 2001 From: Marc Scheib Date: Wed, 21 Feb 2024 18:28:06 +0100 Subject: [PATCH] docs: extend docs by specific secret templates (#40) --- README.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 92753fc..cd7a3ed 100644 --- a/README.md +++ b/README.md @@ -133,7 +133,28 @@ QUARKUS_OIDC_IDENTITY_SERVICE_SECRET=$clients["identity-service"].secret The `client_id` variable can be used within the filename of secret templates as well. In comparison to the usage in templates, the `$` must be omitted. Each client is exported to a separate file then. Otherwise, multiple clients will -overwrite each other. For example, as possible name could be `client_id-oidc.env`. +overwrite each other. For example, a possible name could be `client_id-oidc.env`. +If there are two clients, `client-a` and `client-b`, the following files are created: + +- `client-a-oidc.env` +- `client-b-oidc.env` + +It is possible to provide multiple secret templates at once. The configurator will +generate a file for each client and secret template combination. If a secret template +has the same name as an expanded file would have, this file has precedence. For example, +if the following secrets templates are provided for the clients `client-a` and `client-b`: + +- `client-a-oidc.env` +- `client_id-oidc.env` +- `client_id-oidc.json` + +The following files are created: + +- `client-a-oidc.env` (based on `client-a-oidc.env`) +- `client-b-oidc.env` (based on `client_id-oidc.env`) +- `client-a-oidc.json` (based on `client_id-oidc.json`) +- `client-b-oidc.json` (based on `client_id-oidc.json`) + ### Sub-Command `rotate-secrets`