From 97a275478dd97ab8be42a612f87c4c7ad886935c Mon Sep 17 00:00:00 2001 From: ThompsonNye Date: Tue, 22 Jul 2025 21:13:26 +0200 Subject: [PATCH] Update configuration documentation in README --- README.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index b342469..8f98d6c 100644 --- a/README.md +++ b/README.md @@ -8,12 +8,14 @@ Includes the backend (`src/Vegasco.Server.Api`) and the frontend (`src/Vegasco-W ### Configuration -| Configuration | Description | Default | Required | -|--------------------------|---------------------------------------------------------------------------------------------------------------|------------------------------------------------------------|----------| -| JWT:MetadataUrl | The oidc meta data url | - | true | -| JWT:ValidAudience | The valid audience of the JWT token. | - | true | -| JWT:NameClaimType | The claim type of the user's name claim. For keycloak, using `preferred_username` is often the better choice. | http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name | false | -| JWT:AllowHttpMetadataUrl | Whether to allow the meta data url to have http as protocol. Always true when `ASPNETCORE_ENVIRONMENT=true` | false | false | +| Configuration | Description | Default | Required | +|------------------------------------|---------------------------------------------------------------------------------------------------------------|------------------------------------------------------------|----------| +| JWT:MetadataUrl | The oidc meta data url | - | true | +| JWT:ValidAudience | The valid audience of the JWT token. | - | true | +| JWT:NameClaimType | The claim type of the user's name claim. For keycloak, using `preferred_username` is often the better choice. | http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name | false | +| JWT:AllowHttpMetadataUrl | Whether to allow the meta data url to have http as protocol. Always true when `ASPNETCORE_ENVIRONMENT=true` | false | false | +| ConnectionStrings:seq | The seq http endpoint to send the logs and traces to. If not set, logs and traces will not be sent to seq. | - | false | +| ConnectionStrings:vegasco-database | The connection string to the postgres database. | - | true | The application uses the prefix `Vegasco_` for environment variable names. The prefix is removed when the application reads the environment variables and duplicate entries are overwritten by the environment variables.