itzg / itzg/docker-minecraft-server

Config file to expose all environment variables declaratively

Open
#1,439 21 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Shell
Stars
14.3k
Forks
1.9k
Avg merge
2d 10h
Merged PRs (30d)
31

Description

Enhancement Type

A completely new feature

Describe the enhancement

The number of configuration options and environment variables is now quite large and unwieldy.
For more intricate setups, it'd be valuable to consolidate the dozens of environment variables down into a config file.

  • I imagine the environment variables would remain for backwards compatibility and potentially be deprecated until the next major version.
  • All logic that depends on environment variables could transition to reading the config file.
  • The logic behind the config file could contain inline documentation that could be extracted by CI into user-facing documentation (#1440)
  • A helper function would bridge the gap between new and legacy, containing a mapping of environment variables to YAML paths.
    • The helper could generate/update the new config if legacy environment variables are exposed.
    • The helper could possibly inform the user the config file has been generated/updated.
    • The log could also detail which legacy environment variables were converted.
    • The log could also state the legacy variables can be removed from the user's container spec if they wish.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no specific files, tests, or entry points; begin by mapping the existing environment-variable handling and the proposed YAML paths. Done would require a declarative config, compatibility for legacy variables, a conversion helper with logging, and coordination with documentation extraction in #1440.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker, shell
Domain
devops, infrastructure
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.