Add environment variables documentation #18

New issue

Closed

opened 2026-01-17 18:13:04 +00:00 by joezombie · 1 comment

joezombie commented

2026-01-17 18:13:04 +00:00

(Migrated from github.com)

Priority

Low

Description

Create documentation explaining how to override appsettings.json values using environment variables for different deployment scenarios.

Files to Create

Castr/CONFIGURATION.md

Content Needed

# Configuration Guide

## Environment Variables

Override appsettings.json values using environment variables:

### Feed Configuration
\`\`\`bash
# Feed directory
export PodcastFeeds__Feeds__btb__Directory="/custom/path"

# YouTube settings
export PodcastFeeds__Feeds__btb__YouTube__Enabled=false
export PodcastFeeds__Feeds__btb__YouTube__PollIntervalMinutes=120

# Logging level
export Logging__LogLevel__Default=Debug
\`\`\`

## Docker Environment Variables

In docker-compose.yml:
\`\`\`yaml
environment:
  - PodcastFeeds__Feeds__btb__Directory=/podcasts
  - Logging__LogLevel__Default=Information
\`\`\`

## appsettings.json Structure

See [appsettings.json](appsettings.json) for the full schema.

Benefits

Easier configuration management
Better for containerized deployments
Secrets management without code changes
Environment-specific configurations

References

CODE_REVIEW.md: Configuration Issue #2
RECOMMENDATIONS.md: Priority 3, Item 2

Estimate

30 minutes

## Priority Low ## Description Create documentation explaining how to override appsettings.json values using environment variables for different deployment scenarios. ## Files to Create - `Castr/CONFIGURATION.md` ## Content Needed ```markdown # Configuration Guide ## Environment Variables Override appsettings.json values using environment variables: ### Feed Configuration \`\`\`bash # Feed directory export PodcastFeeds__Feeds__btb__Directory="/custom/path" # YouTube settings export PodcastFeeds__Feeds__btb__YouTube__Enabled=false export PodcastFeeds__Feeds__btb__YouTube__PollIntervalMinutes=120 # Logging level export Logging__LogLevel__Default=Debug \`\`\` ## Docker Environment Variables In docker-compose.yml: \`\`\`yaml environment: - PodcastFeeds__Feeds__btb__Directory=/podcasts - Logging__LogLevel__Default=Information \`\`\` ## appsettings.json Structure See [appsettings.json](appsettings.json) for the full schema. ``` ## Benefits - Easier configuration management - Better for containerized deployments - Secrets management without code changes - Environment-specific configurations ## References - CODE_REVIEW.md: Configuration Issue #2 - RECOMMENDATIONS.md: Priority 3, Item 2 ## Estimate 30 minutes

joezombie commented

2026-01-17 20:23:13 +00:00

(Migrated from github.com)

Resolved in merged PR