Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -191,14 +191,21 @@ This [JSON Schema](https://raw.githubusercontent.com/CycriLabs/ws-ctrl/refs/head

### Secret templates

The secret templates are used to configure the secrets that are necessary for all services
running locally to connect to the remote Keycloak and other services. In addition,
they container environment variables specific to each service. The secret templates
The secret templates are used to provide the secrets that are necessary for all services
running locally to connect to Keycloak or other services. In addition,
they can contain environment variables specific to each service. The secret templates
are located in the `config/secret-templates` directory.

The secret templates are based on the [Keycloak Configurator](https://github.com/CycriLabs/keycloak-configurator).
For more details, check the [documentation](https://github.com/CycriLabs/keycloak-configurator?tab=readme-ov-file#sub-command-export-secrets).

If secret templates are the input for the `generate-service-configuration` executor,
then, the [Keycloak Configurator](https://github.com/CycriLabs/keycloak-configurator) gets
the `.env` file as input as well as additionally the following variables:

- `KCC_WORKSPACE_PATH`: The absolute path to the workspace directory.
- `KCC_WORKING_DIR`: The absolute path to the working directory.

## Use cases

Use cases are scripts based on JSON that can be executed in the workspace. They
Expand Down
Loading