Skip to content

doc: network: Add default ctrl_interface and related parameters to wpa_supplicant.conf #491

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.

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

TheRealKraytonian
Copy link

This commit adds the following default configuration parameters to the example wpa_supplicant.conf in the handbook:

ctrl_interface=/var/run/wpa_supplicant
eapol_version=1
ap_scan=1
fast_reauth=1

This is necessary for users to effectively disable, debug, and manage their wireless network connections. These parameters are already present in the example configuration files provided with wpa_supplicant, suggesting they are commonly used and beneficial for a standard setup. Including them in the handbook's basic example will provide a more robust and user-friendly default configuration for wireless networking.

PR: 286187
Reported by: kraytonian [email protected]
Reviewed by: ziaee [email protected]
Tested by: kraytonian [email protected]
Discussed with: [email protected]

@concussious
Copy link
Contributor

concussious commented Apr 22, 2025

A better commit message might be:

Handbook/network: Mention wpa_supplicant.conf boilerplate

Mention wpa_supplicant.conf boilerplate required for the wpa_cli wireless network manager. These parameters are already present in the share/examples/wpa_supplicant.conf.

PR: 286187
Reported by: <realnameplease> [email protected]
Discussed with: ziaee on Community Discord

Key points:

  • handbook/network shows what is actually changing
  • keep commit message titles terse for one line, many git tools limit to 50 characters
  • no need to mention what, they can see that, the commit message needs to explain why
  • check that path, I'm on my phone at work
  • never say you tested something you authored, this is expected and required
  • discussed with xor reviewed by, in this case, we talked about it but I hadn't seen a diff until just now
  • you need to use your real name when changing global critical infrastructure

Edit: also please wrap the commit message at 72 columns.

Edit2: committers are just referenced by their username, but we're trying to demonstrate the impact of community discord by mentioning it in the log using the syntax I just provided.

This is necessary for users to effectively disable, debug, and manage their wireless network connections with wpa_cli. These parameters are already present in the example configuration files (located: /usr/share/examples/etc/wpa_supplicant.conf), suggesting they are commonly used and beneficial for a standard setup. Including them in the handbook's basic example will provide a more robust and user-friendly default configuration for wireless networking.

PR:		286187
Reported by:	Creighton Chingarande <[email protected]>
Discussed with:	ziaee in Community Discord
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants