From b93c2a7aae75746360e3c6b8781d3ae1883c065b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Elias=20H=C3=B6rner?= Date: Sun, 29 Jun 2025 08:47:52 +0200 Subject: [PATCH 1/4] readme changes --- README.md | 23 ++++++++++++++++------- 1 file changed, 16 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 84e88004..64032df2 100644 --- a/README.md +++ b/README.md @@ -34,13 +34,22 @@ To persist the **turnierplan.NET** application data (including any uploaded imag ### Environment Variables -The application can be configured by setting the following environment variables: +For a basic installation, the following environment variables *must* be set: -| Environment Variable | Description | Required | Default | -|-----------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|---------| -| `ApplicationUrl` | The URL which can be used to access your instance in the format `https://hostname-or-IP:port/`. The port can be omitted. | Yes | - | -| `Database__ConnectionString` | The PostgreSQL connection string with read/write permission | Yes | - | -| `ApplicationInsights__ConnectionString` | Can be set if you wish that your instance sends telemetry data to [Azure Application Insights](https://learn.microsoft.com/en-us/azure/azure-monitor/app/app-insights-overview) | No | - | +| Environment Variable | Description | +|------------------------------|-------------------------------------------------------------------| +| `ApplicationUrl` | The preferred URL used to access the website as an external user. | +| `Database__ConnectionString` | The PostgreSQL connection string with read/write permission. | + +> The `ApplicationUrl` is currently only used when creating PDF documents that contain a link/QR-Code to the **turnierplan.NET** application. + +The following environment variables *can* be set if you want to enable specific features or modify default behavior: + +| Environment Variable | Description | Default | +|-----------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| `ApplicationInsights__ConnectionString` | Can be set if you wish that your instance sends telemetry data to [Azure Application Insights](https://learn.microsoft.com/en-us/azure/azure-monitor/app/app-insights-overview). | - | +| `Identity__AccessTokenLifetime` | Defines the lifetime of issued JWT access tokens. | `00:30:00` (30 mins) | +| `Identity__RefreshTokenLifetime` | Defines the lifetime of issued JWT refresh tokens. | `1.00:00:00` (1 day) | ### Docker Compose Example @@ -114,7 +123,7 @@ Add the package reference to your project: ```csproj - + ``` From 1c6e971db3a412465b3459c92254402d3479c942 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Elias=20H=C3=B6rner?= Date: Sun, 29 Jun 2025 08:49:28 +0200 Subject: [PATCH 2/4] Change --- README.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 64032df2..c370b59e 100644 --- a/README.md +++ b/README.md @@ -41,15 +41,17 @@ For a basic installation, the following environment variables *must* be set: | `ApplicationUrl` | The preferred URL used to access the website as an external user. | | `Database__ConnectionString` | The PostgreSQL connection string with read/write permission. | -> The `ApplicationUrl` is currently only used when creating PDF documents that contain a link/QR-Code to the **turnierplan.NET** application. +> The `ApplicationUrl` is currently only used when creating PDF documents that contain a link/qr-code to the **turnierplan.NET** application. The following environment variables *can* be set if you want to enable specific features or modify default behavior: -| Environment Variable | Description | Default | -|-----------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| -| `ApplicationInsights__ConnectionString` | Can be set if you wish that your instance sends telemetry data to [Azure Application Insights](https://learn.microsoft.com/en-us/azure/azure-monitor/app/app-insights-overview). | - | -| `Identity__AccessTokenLifetime` | Defines the lifetime of issued JWT access tokens. | `00:30:00` (30 mins) | -| `Identity__RefreshTokenLifetime` | Defines the lifetime of issued JWT refresh tokens. | `1.00:00:00` (1 day) | +| Environment Variable | Description | Default | +|-----------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------| +| `ApplicationInsights__ConnectionString` | Can be set if you wish that your instance sends telemetry data to [Azure Application Insights](https://learn.microsoft.com/en-us/azure/azure-monitor/app/app-insights-overview). | - | +| `Identity__AccessTokenLifetime` | Defines the lifetime of issued JWT access tokens. | `00:30:00` | +| `Identity__RefreshTokenLifetime` | Defines the lifetime of issued JWT refresh tokens. | `1.00:00:00` | + +> The token lifetimes must be specified as .NET `TimeSpan` strings. For example `00:30:00` means 30 minutes or `1.00:00.00` means 1 day. ### Docker Compose Example From 4c041106c71b4dace8a4c72c3bc4c9b4c6de47c4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Elias=20H=C3=B6rner?= Date: Sun, 29 Jun 2025 08:56:45 +0200 Subject: [PATCH 3/4] change --- README.md | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index c370b59e..753a30b9 100644 --- a/README.md +++ b/README.md @@ -27,21 +27,19 @@ The credentials of the initial admin user are displayed in the container logs. ### Persisting Data -To persist the **turnierplan.NET** application data (including any uploaded images), create a Docker volume mapping to the `/var/turnierplan` folder inside the container. +To persist the **turnierplan.NET** application data, create a Docker volume mapping to the `/var/turnierplan` folder inside the container. > [!CAUTION] -> Treat the data as highly confidential as it contains the signing key used for issued JWT tokens! +> This folder will store the JWT signing key! ### Environment Variables For a basic installation, the following environment variables *must* be set: -| Environment Variable | Description | -|------------------------------|-------------------------------------------------------------------| -| `ApplicationUrl` | The preferred URL used to access the website as an external user. | -| `Database__ConnectionString` | The PostgreSQL connection string with read/write permission. | - -> The `ApplicationUrl` is currently only used when creating PDF documents that contain a link/qr-code to the **turnierplan.NET** application. +| Environment Variable | Description | +|------------------------------|--------------------------------------------------------------| +| `ApplicationUrl` | The URL used to access the website. | +| `Database__ConnectionString` | The PostgreSQL connection string with read/write permission. | The following environment variables *can* be set if you want to enable specific features or modify default behavior: @@ -60,7 +58,7 @@ You can use the following docker compose file to get a complete instance running ```yaml services: turnierplan.database: - image: postgres:17.0 + image: postgres:latest environment: - POSTGRES_PASSWORD=P@ssw0rd - POSTGRES_DB=turnierplan @@ -94,7 +92,7 @@ networks: ``` > [!TIP] -> Choose a secure password for the database user. +> It is recommended to *not* use the `latest` tag. Rather, pin your docker services to a specific image version. ## Documentation From 191c241b7efeb700d2321d82ebe50fcbc8df7a0b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Elias=20H=C3=B6rner?= Date: Sun, 29 Jun 2025 09:00:35 +0200 Subject: [PATCH 4/4] rewrite caution --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 753a30b9..712ead0c 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,7 @@ The credentials of the initial admin user are displayed in the container logs. To persist the **turnierplan.NET** application data, create a Docker volume mapping to the `/var/turnierplan` folder inside the container. > [!CAUTION] -> This folder will store the JWT signing key! +> This folder contains the JWT signing key for issued access/refresh tokens. ### Environment Variables