nixos/doc: Clarify wireless examples

This commits makes it clearer to a novice reader how to configure several
diferent types of SSID connections that were otherwise obscurely documented

Resolves #66650
This commit is contained in:
Craige McWhirter 2019-08-15 08:29:13 +10:00 committed by worldofpeace
parent bc0072305b
commit cce7486deb
2 changed files with 21 additions and 4 deletions

View file

@ -19,10 +19,17 @@
NixOS lets you specify networks for wpa_supplicant declaratively:
<programlisting>
<xref linkend="opt-networking.wireless.networks"/> = {
echelon = {
echelon = { # SSID with no spaces or special characters
psk = "abcdefgh";
};
"free.wifi" = {};
"echelon's AP" = { # SSID with spaces and/or special characters
psk = "ijklmnop";
};
echelon = { # Hidden SSID
hidden = true;
psk = "qrstuvwx";
};
free.wifi = {}; # Public wireless network
};
</programlisting>
Be aware that keys will be written to the nix store in plaintext! When no

View file

@ -103,6 +103,13 @@ in {
description = ''
Set this to <literal>true</literal> if the SSID of the network is hidden.
'';
example = literalExample ''
{ echelon = {
hidden = true;
psk = "abcdefgh";
};
}
'';
};
priority = mkOption {
@ -146,10 +153,13 @@ in {
'';
default = {};
example = literalExample ''
{ echelon = {
{ echelon = { # SSID with no spaces or special characters
psk = "abcdefgh";
};
"free.wifi" = {};
"echelon's AP" = { # SSID with spaces and/or special characters
psk = "ijklmnop";
};
"free.wifi" = {}; # Public wireless network
}
'';
};