Add CONFIG.md documenting all config.sh parameters and link from README.md

[Copilot]

• Create CONFIG.md with a subsection for each parameter in config.sh
• Remove example code block from each parameter subsection
• Add bullet-point list of all configurable parameters to the intro section
• Add an example with clear values for each parameter subsection
• Add reference to CONFIG.md in README.md section 4.2
• Add remark in README.md section 5.1.1 that the YAML excerpt is simplified, with links to the full /autoinstall/autoinstall.yaml and /autoinstall/README.md
• Add notes to NET_IF_NAME: managed by networkd, NET_IF_MACADDRESS and NET_IF_MTU are mandatory, installer-step1 must run without network connectivity, ethernet-only installation
• Add note to NET_WIFI_IF_NAME: optional parameter, WiFi managed by NetworkManager not networkd
• Add note to NET_NTP_STATIC_SERVER: optional parameter, adjusted chrony config can be used if omitted
• Add note to GRUB_KERNEL_CMDLINE: must be set with system-specific values, default optimized for Intel Gen 9 CPU with i915 GPU (disables DMAR, limits C-state for performance)
• Add note to NEXTDNS_ID that the value must omit the NextDNS- prefix
• Add note to NEXTDNS_STAMP that the value must omit the sdns:// prefix; fix example value to exclude the prefix
• Update USER_IDS description to clarify the installer processes hardening per user, and that all listed users must also be defined in autoinstall.yaml for a complete installation

---

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

[clauspruefer]

@copilot please remove the example section from each parameter sub-section.

[clauspruefer]

@copilot please add (bullet point list) of all configurable parameters to the first section.

[Copilot]

@copilot please remove the example section from each parameter sub-section.

Done — example sections removed from all 12 parameter subsections in commit 4a48556.

[Copilot]

@copilot please add (bullet point list) of all configurable parameters to the first section.

Done — a linked bullet-point list of all 12 parameters has been added to the intro section in commit dd41fa5.

[clauspruefer]

@copilot please add an example of how to set a config parameter for each config parameter subsection (the example should contain clear values what can be uses,not how to source it, this is developer documentation, we are documenting for the user).

[clauspruefer]

@copilot please add a reference to CONFIG.md in README.md.

[Copilot]

@copilot please add an example of how to set a config parameter for each config parameter subsection (the example should contain clear values what can be uses,not how to source...

Done — each of the 12 parameter subsections now has an Example: sh code block showing a concrete value (commit e173378).

[Copilot]

@copilot please add a reference to CONFIG.md in README.md.

Done — a reference to CONFIG.md has been added to section 4.2 of README.md in commit d033396.

[clauspruefer]

@copilot please add a remark to README.md subsection ### 5.1.1. Configuration File Structure that the following example autoinstall.yaml excerpt does not contain installation commands, the one used in the installation process can be found in /autoinstall/autoinstall.yaml and also a /autoinstall/README.md.

[Copilot]

@copilot please add a remark to README.md subsection ### 5.1.1. Configuration File Structure that the following example autoinstall.yaml excerpt does not contain installation com...

Done — a [!NOTE] callout has been added at the top of section 5.1.1 explaining the excerpt is simplified and linking to both /autoinstall/autoinstall.yaml and /autoinstall/README.md (commit 8b16bd2).

[clauspruefer]

@copilot add the following remarks to CONFIG.md: 1. NET_IF_NAME is managed globally by networkd and that NET_IF_MACADDRESS and NET_IF_MTU are mandatory, also add that the installation installer-step1 must have no network connectivity otherwise unattended_upgrades will be started and further installation will fail; add final remark that installation only can be run via ethernet and not wifi 2. NET_WIFI_IF_NAME is optional, if ommited no wifi configuration will be done, also add remark that wifi management will be done by NetworkManager not networkd 3. NET_NTP_STATIC_SERVER is optional, if ommited an adjusted chrony config can be used 4. GRUB_KERNEL_CMDLINE must be set and should contain system specific settings, the default is optimized for intel CPU gen9 containing a i915 on chip gpu (disable DMAR - dma remapping, limit intel c-state to guarantee performance)

[Copilot]

@copilot add the following remarks to CONFIG.md: 1. NET_IF_NAME is managed globally by networkd and that NET_IF_MACADDRESS and NET_IF_MTU are mandatory, also add that the installat...

Done (commit 85991c3). Four [!NOTE] callouts added to CONFIG.md:

1. NET_IF_NAME — interface managed by networkd; NET_IF_MACADDRESS and NET_IF_MTU are mandatory; installer-step1 must run with no network connectivity to avoid triggering unattended-upgrades; installation is ethernet-only.
2. NET_WIFI_IF_NAME — optional; if omitted no WiFi configuration is performed; WiFi management is handled by NetworkManager, not networkd.
3. NET_NTP_STATIC_SERVER — optional; if omitted an adjusted chrony config without a static server can be used instead.
4. GRUB_KERNEL_CMDLINE — must be set with system-specific values; default is optimised for Intel Gen 9 CPU with integrated i915 GPU (disables DMAR, limits C-state for performance).

[clauspruefer]

@copilot 1. Change NEXTDNS_ID: add remark that config parameter must only be non-prefixed ("NextDNS-" ommited). 2. Change NEXTDNS_STAMP, also here the prefix "sdns://" must be ommited, also correct this in given example parameter value 3. In USER_IDS change "A space-separated list of local user account names that exist on the system." to "A space-separated list of users ... the installer will process hardening per user ... also must be defined in autoinstall.yaml else the installation is not 100%".

[Copilot]

@copilot 1. Change NEXTDNS_ID: add remark that config parameter must only be non-prefixed ("NextDNS-" ommited). 2. Change NEXTDNS_STAMP, also here the prefix "sdns://" must be ommited, also correct th...

Done (commit 395d9f3):

1. NEXTDNS_ID — added a [!NOTE] that the value must be the bare identifier without the NextDNS- prefix.
2. NEXTDNS_STAMP — added a [!NOTE] that the value must omit the sdns:// prefix; corrected the example value to "AgEAAAAAAAAAAAAOZG5zLm5leHRkbnMuaW8EL2RucwA" (no prefix).
3. USER_IDS — updated the description to "A space-separated list of users the installer will process hardening for" and moved the autoinstall.yaml dependency into a [!NOTE] callout clarifying that missing users there will result in an incomplete installation.

[Copilot]

Pull request overview

This PR adds comprehensive configuration documentation by creating CONFIG.md with detailed descriptions of all 12 parameters in config.sh, and updates README.md to reference this new documentation. The changes improve the user experience by providing clear guidance on all configurable parameters, including their purpose, usage, requirements, and examples.

Changes:

• Created CONFIG.md documenting all configuration parameters with detailed descriptions, usage notes, and examples
• Added reference to CONFIG.md in README.md section 4.2 for configuration guidance
• Added clarifying note in README.md section 5.1.1 explaining that the YAML excerpt is simplified with links to full documentation

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File	Description
CONFIG.md	New comprehensive documentation covering all 12 config.sh parameters with descriptions, usage context, mandatory/optional status, technical notes, and examples
README.md	Updated configuration section to reference CONFIG.md and added clarifying note about simplified YAML example with links to full documentation

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

Spelling inconsistency: "organisation" should be "organization" to match the American English spelling used elsewhere in the codebase (e.g., "organizational" in CHANGELOG.md:114, "optimized" in CONFIG.md:144).

Suggested change

	Used by `set-sysctl.sh` when deploying `sysctl-10-domainname.conf`, replacing the `[KERNEL_DOMAIN_NAME]` placeholder. Set this to the DNS domain of the local network or organisation.
	Used by `set-sysctl.sh` when deploying `sysctl-10-domainname.conf`, replacing the `[KERNEL_DOMAIN_NAME]` placeholder. Set this to the DNS domain of the local network or organization.