about summary refs log tree commit diff
path: root/nixos
diff options
context:
space:
mode:
authorRobert Hensing <robert@roberthensing.nl>2021-06-15 12:23:09 +0200
committerRobert Hensing <robert@roberthensing.nl>2021-06-15 12:23:09 +0200
commitdab747106e20268e6d3a7c1a758185bc75507bef (patch)
treefe51e4585f4570cbade04052fb6731f754136836 /nixos
parent8352cc9a23a5fea11d467a5b8341b24cd162c62a (diff)
downloadnixlib-dab747106e20268e6d3a7c1a758185bc75507bef.tar
nixlib-dab747106e20268e6d3a7c1a758185bc75507bef.tar.gz
nixlib-dab747106e20268e6d3a7c1a758185bc75507bef.tar.bz2
nixlib-dab747106e20268e6d3a7c1a758185bc75507bef.tar.lz
nixlib-dab747106e20268e6d3a7c1a758185bc75507bef.tar.xz
nixlib-dab747106e20268e6d3a7c1a758185bc75507bef.tar.zst
nixlib-dab747106e20268e6d3a7c1a758185bc75507bef.zip
nixos/ssh: Document authorizedKeysFiles properly
Diffstat (limited to 'nixos')
-rw-r--r--nixos/modules/services/networking/ssh/sshd.nix12
1 files changed, 11 insertions, 1 deletions
diff --git a/nixos/modules/services/networking/ssh/sshd.nix b/nixos/modules/services/networking/ssh/sshd.nix
index 87418a1bf219..227dfe834b29 100644
--- a/nixos/modules/services/networking/ssh/sshd.nix
+++ b/nixos/modules/services/networking/ssh/sshd.nix
@@ -256,7 +256,17 @@ in
       authorizedKeysFiles = mkOption {
         type = types.listOf types.str;
         default = [];
-        description = "Files from which authorized keys are read.";
+        description = ''
+          Specify the rules for which files to read on the host.
+
+          This is an advanced option. If you're looking to configure user
+          keys, you can generally use <xref linkend="opt-users.users._name_.openssh.authorizedKeys.keys"/>
+          or <xref linkend="opt-users.users._name_.openssh.authorizedKeys.keyFiles"/>.
+
+          These are paths relative to the host root file system or home
+          directories and they are subject to certain token expansion rules.
+          See AuthorizedKeysFile in man sshd_config for details.
+        '';
       };
 
       authorizedKeysCommand = mkOption {