Skip to content

Some minor improvements for readme #56

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
eliaspr merged 4 commits into from
Jun 29, 2025
Merged

Some minor improvements for readme #56

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b93c2a7
readme changes
eliaspr Jun 29, 2025
1c6e971
Change
eliaspr Jun 29, 2025
4c04110
change
eliaspr Jun 29, 2025
191c241
rewrite caution
eliaspr Jun 29, 2025
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
31 changes: 20 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,20 +27,29 @@ 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 contains the JWT signing key for issued access/refresh tokens.

### 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 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:

| 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

Expand All @@ -49,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
Expand Down Expand Up @@ -83,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

Expand Down Expand Up @@ -114,7 +123,7 @@ Add the package reference to your project:

```csproj
<ItemGroup>
<PackageReference Include="Turnierplan.Adapter" Version="1.0.0" /> <!-- Use the latest version! -->
<PackageReference Include="Turnierplan.Adapter" Version="2025.1.0" /> <!-- Use the latest version! -->
</ItemGroup>
```

Expand Down
Loading