nix-community/home-manager
1
0
Fork 0
mirror of https://github.com/nix-community/home-manager.git synced 2025-12-07 01:21:03 +01:00
Code Activity

deploy: 3882f88691

Browse source
This commit is contained in:
khaneliman 2025-08-26 22:13:07 +00:00
parent a225036f99
commit d1f7eddc1e
1 changed files with 146 additions and 216 deletions
Download patch file Download diff file Expand all files Collapse all files

362
options.xhtml
View file

@ -66462,68 +66462,21 @@ boolean</p>
</dd>
<dt>
<span class="term">
<a id="opt-programs.ssh.package"></a><a class="term" href="options.xhtml#opt-programs.ssh.package"><code class="option">programs.ssh.package</code>
<a id="opt-programs.ssh.enableDefaultConfig"></a><a class="term" href="options.xhtml#opt-programs.ssh.enableDefaultConfig"><code class="option">programs.ssh.enableDefaultConfig</code>
</a>
</span>
</dt>
<dd>
<p>The openssh package to use. By default, the client provided by your system is used.</p>
<p><span class="emphasis"><em>Type:</em></span>
null or package</p>
<p><span class="emphasis"><em>Default:</em></span>
<code class="literal">null</code></p>
<p><span class="emphasis"><em>Declared by:</em></span></p>
<table border="0" summary="Simple list" class="simplelist">
<tr><td>
<code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ssh.nix" target="_top">
&lt;home-manager/modules/programs/ssh.nix&gt;
</a></code>
</td></tr>
</table>
</dd>
<dt>
<span class="term">
<a id="opt-programs.ssh.addKeysToAgent"></a><a class="term" href="options.xhtml#opt-programs.ssh.addKeysToAgent"><code class="option">programs.ssh.addKeysToAgent</code>
</a>
</span>
</dt>
<dd>
<p>When enabled, a private key that is used during authentication will be
added to ssh-agent if it is running (with confirmation enabled if
set to ‘confirm’). The argument must be ‘no’ (the default), ‘yes’, ‘confirm’
(optionally followed by a time interval), ‘ask’ or a time interval (e.g. ‘1h’).</p>
<p><span class="emphasis"><em>Type:</em></span>
string</p>
<p><span class="emphasis"><em>Default:</em></span>
<code class="literal">&quot;no&quot;</code></p>
<p><span class="emphasis"><em>Declared by:</em></span></p>
<table border="0" summary="Simple list" class="simplelist">
<tr><td>
<code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ssh.nix" target="_top">
&lt;home-manager/modules/programs/ssh.nix&gt;
</a></code>
</td></tr>
</table>
</dd>
<dt>
<span class="term">
<a id="opt-programs.ssh.compression"></a><a class="term" href="options.xhtml#opt-programs.ssh.compression"><code class="option">programs.ssh.compression</code>
</a>
</span>
</dt>
<dd>
<p>Specifies whether to use compression.</p>
<p>Whether to enable or not the old default config values.
This option will become deprecated in the future.</p>
<p><span class="emphasis"><em>Type:</em></span>
boolean</p>
<p><span class="emphasis"><em>Default:</em></span>
<code class="literal">true</code></p>
<p><span class="emphasis"><em>Example:</em></span>
<code class="literal">false</code></p>
<p><span class="emphasis"><em>Declared by:</em></span></p>
@ -66537,69 +66490,18 @@ boolean</p>
</dd>
<dt>
<span class="term">
<a id="opt-programs.ssh.controlMaster"></a><a class="term" href="options.xhtml#opt-programs.ssh.controlMaster"><code class="option">programs.ssh.controlMaster</code>
<a id="opt-programs.ssh.package"></a><a class="term" href="options.xhtml#opt-programs.ssh.package"><code class="option">programs.ssh.package</code>
</a>
</span>
</dt>
<dd>
<p>Configure sharing of multiple sessions over a single network connection.</p>
<p>The openssh package to use. By default, the client provided by your system is used.</p>
<p><span class="emphasis"><em>Type:</em></span>
one of “yes”, “no”, “ask”, “auto”, “autoask”</p>
null or package</p>
<p><span class="emphasis"><em>Default:</em></span>
<code class="literal">&quot;no&quot;</code></p>
<p><span class="emphasis"><em>Declared by:</em></span></p>
<table border="0" summary="Simple list" class="simplelist">
<tr><td>
<code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ssh.nix" target="_top">
&lt;home-manager/modules/programs/ssh.nix&gt;
</a></code>
</td></tr>
</table>
</dd>
<dt>
<span class="term">
<a id="opt-programs.ssh.controlPath"></a><a class="term" href="options.xhtml#opt-programs.ssh.controlPath"><code class="option">programs.ssh.controlPath</code>
</a>
</span>
</dt>
<dd>
<p>Specify path to the control socket used for connection sharing.</p>
<p><span class="emphasis"><em>Type:</em></span>
string</p>
<p><span class="emphasis"><em>Default:</em></span>
<code class="literal">&quot;~/.ssh/master-%r@%n:%p&quot;</code></p>
<p><span class="emphasis"><em>Declared by:</em></span></p>
<table border="0" summary="Simple list" class="simplelist">
<tr><td>
<code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ssh.nix" target="_top">
&lt;home-manager/modules/programs/ssh.nix&gt;
</a></code>
</td></tr>
</table>
</dd>
<dt>
<span class="term">
<a id="opt-programs.ssh.controlPersist"></a><a class="term" href="options.xhtml#opt-programs.ssh.controlPersist"><code class="option">programs.ssh.controlPersist</code>
</a>
</span>
</dt>
<dd>
<p>Whether control socket should remain open in the background.</p>
<p><span class="emphasis"><em>Type:</em></span>
string</p>
<p><span class="emphasis"><em>Default:</em></span>
<code class="literal">&quot;no&quot;</code></p>
<p><span class="emphasis"><em>Example:</em></span>
<code class="literal">&quot;10m&quot;</code></p>
<code class="literal">null</code></p>
<p><span class="emphasis"><em>Declared by:</em></span></p>
<table border="0" summary="Simple list" class="simplelist">
@ -66650,58 +66552,6 @@ attribute set of string</p>
<p><span class="emphasis"><em>Default:</em></span>
<code class="literal">{ }</code></p>
<p><span class="emphasis"><em>Declared by:</em></span></p>
<table border="0" summary="Simple list" class="simplelist">
<tr><td>
<code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ssh.nix" target="_top">
&lt;home-manager/modules/programs/ssh.nix&gt;
</a></code>
</td></tr>
</table>
</dd>
<dt>
<span class="term">
<a id="opt-programs.ssh.forwardAgent"></a><a class="term" href="options.xhtml#opt-programs.ssh.forwardAgent"><code class="option">programs.ssh.forwardAgent</code>
</a>
</span>
</dt>
<dd>
<p>Whether the connection to the authentication agent (if any)
will be forwarded to the remote machine.</p>
<p><span class="emphasis"><em>Type:</em></span>
boolean</p>
<p><span class="emphasis"><em>Default:</em></span>
<code class="literal">false</code></p>
<p><span class="emphasis"><em>Declared by:</em></span></p>
<table border="0" summary="Simple list" class="simplelist">
<tr><td>
<code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ssh.nix" target="_top">
&lt;home-manager/modules/programs/ssh.nix&gt;
</a></code>
</td></tr>
</table>
</dd>
<dt>
<span class="term">
<a id="opt-programs.ssh.hashKnownHosts"></a><a class="term" href="options.xhtml#opt-programs.ssh.hashKnownHosts"><code class="option">programs.ssh.hashKnownHosts</code>
</a>
</span>
</dt>
<dd>
<p>Indicates that
<span class="citerefentry"><span class="refentrytitle">ssh</span>(1)</span>
should hash host names and addresses when they are added to
the known hosts file.</p>
<p><span class="emphasis"><em>Type:</em></span>
boolean</p>
<p><span class="emphasis"><em>Default:</em></span>
<code class="literal">false</code></p>
<p><span class="emphasis"><em>Declared by:</em></span></p>
<table border="0" summary="Simple list" class="simplelist">
<tr><td>
@ -66770,6 +66620,33 @@ DAG of submodule</p>
</code></pre>
<p><span class="emphasis"><em>Declared by:</em></span></p>
<table border="0" summary="Simple list" class="simplelist">
<tr><td>
<code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ssh.nix" target="_top">
&lt;home-manager/modules/programs/ssh.nix&gt;
</a></code>
</td></tr>
</table>
</dd>
<dt>
<span class="term">
<a id="opt-programs.ssh.matchBlocks._name_.addKeysToAgent"></a><a class="term" href="options.xhtml#opt-programs.ssh.matchBlocks._name_.addKeysToAgent"><code class="option">programs.ssh.matchBlocks.&lt;name&gt;.addKeysToAgent</code>
</a>
</span>
</dt>
<dd>
<p>When enabled, a private key that is used during authentication will be
added to ssh-agent if it is running (with confirmation enabled if
set to ‘confirm’). The argument must be ‘no’ (the default), ‘yes’, ‘confirm’
(optionally followed by a time interval), ‘ask’ or a time interval (e.g. ‘1h’).</p>
<p><span class="emphasis"><em>Type:</em></span>
null or string</p>
<p><span class="emphasis"><em>Default:</em></span>
<code class="literal">null</code></p>
<p><span class="emphasis"><em>Declared by:</em></span></p>
<table border="0" summary="Simple list" class="simplelist">
<tr><td>
@ -66868,6 +66745,81 @@ null or boolean</p>
<p><span class="emphasis"><em>Default:</em></span>
<code class="literal">null</code></p>
<p><span class="emphasis"><em>Declared by:</em></span></p>
<table border="0" summary="Simple list" class="simplelist">
<tr><td>
<code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ssh.nix" target="_top">
&lt;home-manager/modules/programs/ssh.nix&gt;
</a></code>
</td></tr>
</table>
</dd>
<dt>
<span class="term">
<a id="opt-programs.ssh.matchBlocks._name_.controlMaster"></a><a class="term" href="options.xhtml#opt-programs.ssh.matchBlocks._name_.controlMaster"><code class="option">programs.ssh.matchBlocks.&lt;name&gt;.controlMaster</code>
</a>
</span>
</dt>
<dd>
<p>Configure sharing of multiple sessions over a single network connection.</p>
<p><span class="emphasis"><em>Type:</em></span>
null or one of “yes”, “no”, “ask”, “auto”, “autoask”</p>
<p><span class="emphasis"><em>Default:</em></span>
<code class="literal">null</code></p>
<p><span class="emphasis"><em>Declared by:</em></span></p>
<table border="0" summary="Simple list" class="simplelist">
<tr><td>
<code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ssh.nix" target="_top">
&lt;home-manager/modules/programs/ssh.nix&gt;
</a></code>
</td></tr>
</table>
</dd>
<dt>
<span class="term">
<a id="opt-programs.ssh.matchBlocks._name_.controlPath"></a><a class="term" href="options.xhtml#opt-programs.ssh.matchBlocks._name_.controlPath"><code class="option">programs.ssh.matchBlocks.&lt;name&gt;.controlPath</code>
</a>
</span>
</dt>
<dd>
<p>Specify path to the control socket used for connection sharing.</p>
<p><span class="emphasis"><em>Type:</em></span>
null or string</p>
<p><span class="emphasis"><em>Default:</em></span>
<code class="literal">null</code></p>
<p><span class="emphasis"><em>Declared by:</em></span></p>
<table border="0" summary="Simple list" class="simplelist">
<tr><td>
<code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ssh.nix" target="_top">
&lt;home-manager/modules/programs/ssh.nix&gt;
</a></code>
</td></tr>
</table>
</dd>
<dt>
<span class="term">
<a id="opt-programs.ssh.matchBlocks._name_.controlPersist"></a><a class="term" href="options.xhtml#opt-programs.ssh.matchBlocks._name_.controlPersist"><code class="option">programs.ssh.matchBlocks.&lt;name&gt;.controlPersist</code>
</a>
</span>
</dt>
<dd>
<p>Whether control socket should remain open in the background.</p>
<p><span class="emphasis"><em>Type:</em></span>
null or string</p>
<p><span class="emphasis"><em>Default:</em></span>
<code class="literal">null</code></p>
<p><span class="emphasis"><em>Example:</em></span>
<code class="literal">&quot;10m&quot;</code></p>
<p><span class="emphasis"><em>Declared by:</em></span></p>
<table border="0" summary="Simple list" class="simplelist">
<tr><td>
@ -67050,6 +67002,33 @@ boolean</p>
<p><span class="emphasis"><em>Default:</em></span>
<code class="literal">false</code></p>
<p><span class="emphasis"><em>Declared by:</em></span></p>
<table border="0" summary="Simple list" class="simplelist">
<tr><td>
<code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ssh.nix" target="_top">
&lt;home-manager/modules/programs/ssh.nix&gt;
</a></code>
</td></tr>
</table>
</dd>
<dt>
<span class="term">
<a id="opt-programs.ssh.matchBlocks._name_.hashKnownHosts"></a><a class="term" href="options.xhtml#opt-programs.ssh.matchBlocks._name_.hashKnownHosts"><code class="option">programs.ssh.matchBlocks.&lt;name&gt;.hashKnownHosts</code>
</a>
</span>
</dt>
<dd>
<p>Indicates that
<span class="citerefentry"><span class="refentrytitle">ssh</span>(1)</span>
should hash host names and addresses when they are added to
the known hosts file.</p>
<p><span class="emphasis"><em>Type:</em></span>
null or boolean</p>
<p><span class="emphasis"><em>Default:</em></span>
<code class="literal">null</code></p>
<p><span class="emphasis"><em>Declared by:</em></span></p>
<table border="0" summary="Simple list" class="simplelist">
<tr><td>
@ -67621,10 +67600,10 @@ list of string</p>
without SSH receiving any messages back from the server.</p>
<p><span class="emphasis"><em>Type:</em></span>
positive integer, meaning &gt;0</p>
null or (positive integer, meaning &gt;0)</p>
<p><span class="emphasis"><em>Default:</em></span>
<code class="literal">3</code></p>
<code class="literal">null</code></p>
<p><span class="emphasis"><em>Declared by:</em></span></p>
<table border="0" summary="Simple list" class="simplelist">
@ -67645,10 +67624,10 @@ positive integer, meaning &gt;0</p>
<p>Set timeout in seconds after which response will be requested.</p>
<p><span class="emphasis"><em>Type:</em></span>
signed integer</p>
null or signed integer</p>
<p><span class="emphasis"><em>Default:</em></span>
<code class="literal">0</code></p>
<code class="literal">null</code></p>
<p><span class="emphasis"><em>Declared by:</em></span></p>
<table border="0" summary="Simple list" class="simplelist">
@ -67709,56 +67688,7 @@ null or string</p>
</dd>
<dt>
<span class="term">
<a id="opt-programs.ssh.serverAliveCountMax"></a><a class="term" href="options.xhtml#opt-programs.ssh.serverAliveCountMax"><code class="option">programs.ssh.serverAliveCountMax</code>
</a>
</span>
</dt>
<dd>
<p>Sets the default number of server alive messages which may be
sent without SSH receiving any messages back from the server.</p>
<p><span class="emphasis"><em>Type:</em></span>
positive integer, meaning &gt;0</p>
<p><span class="emphasis"><em>Default:</em></span>
<code class="literal">3</code></p>
<p><span class="emphasis"><em>Declared by:</em></span></p>
<table border="0" summary="Simple list" class="simplelist">
<tr><td>
<code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ssh.nix" target="_top">
&lt;home-manager/modules/programs/ssh.nix&gt;
</a></code>
</td></tr>
</table>
</dd>
<dt>
<span class="term">
<a id="opt-programs.ssh.serverAliveInterval"></a><a class="term" href="options.xhtml#opt-programs.ssh.serverAliveInterval"><code class="option">programs.ssh.serverAliveInterval</code>
</a>
</span>
</dt>
<dd>
<p>Set default timeout in seconds after which response will be requested.</p>
<p><span class="emphasis"><em>Type:</em></span>
signed integer</p>
<p><span class="emphasis"><em>Default:</em></span>
<code class="literal">0</code></p>
<p><span class="emphasis"><em>Declared by:</em></span></p>
<table border="0" summary="Simple list" class="simplelist">
<tr><td>
<code class="filename"><a class="filename" href="https://github.com/nix-community/home-manager/blob/master/modules/programs/ssh.nix" target="_top">
&lt;home-manager/modules/programs/ssh.nix&gt;
</a></code>
</td></tr>
</table>
</dd>
<dt>
<span class="term">
<a id="opt-programs.ssh.userKnownHostsFile"></a><a class="term" href="options.xhtml#opt-programs.ssh.userKnownHostsFile"><code class="option">programs.ssh.userKnownHostsFile</code>
<a id="opt-programs.ssh.matchBlocks._name_.userKnownHostsFile"></a><a class="term" href="options.xhtml#opt-programs.ssh.matchBlocks._name_.userKnownHostsFile"><code class="option">programs.ssh.matchBlocks.&lt;name&gt;.userKnownHostsFile</code>
</a>
</span>
</dt>
@ -67768,10 +67698,10 @@ database, separated by whitespace. The default is
<code class="filename">~/.ssh/known_hosts</code>.</p>
<p><span class="emphasis"><em>Type:</em></span>
string</p>
null or string</p>
<p><span class="emphasis"><em>Default:</em></span>
<code class="literal">&quot;~/.ssh/known_hosts&quot;</code></p>
<code class="literal">null</code></p>
<p><span class="emphasis"><em>Declared by:</em></span></p>
<table border="0" summary="Simple list" class="simplelist">