Merge pull request #66652 from craigem/clarify_wireless_examples

nixos/doc: Clarify wireless examples
This commit is contained in:
worldofpeace 2019-09-26 22:56:20 -04:00 committed by GitHub
commit 985697bff7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 21 additions and 4 deletions

View File

@ -19,10 +19,17 @@
NixOS lets you specify networks for wpa_supplicant declaratively: NixOS lets you specify networks for wpa_supplicant declaratively:
<programlisting> <programlisting>
<xref linkend="opt-networking.wireless.networks"/> = { <xref linkend="opt-networking.wireless.networks"/> = {
echelon = { echelon = { # SSID with no spaces or special characters
psk = "abcdefgh"; 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> </programlisting>
Be aware that keys will be written to the nix store in plaintext! When no Be aware that keys will be written to the nix store in plaintext! When no

View File

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