Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

sshAuthSock.enable

Whether to set SSH_AUTH_SOCK in shells, systemd, and the D-BUS daemon unless it was already defined through SSH agent forwarding.

Typically, this module will be implicitly enabled and configured by SSH agent modules.

Type: boolean

Default:

false

Example:

true

Declared by:

sshAuthSock.initialization.bash

Code that initializes SSH_AUTH_SOCK in bash.

Type: string

Example:

"export SSH_AUTH_SOCK=$HOME/.ssh/agent.sock"

Declared by:

sshAuthSock.initialization.fish

Code that initializes SSH_AUTH_SOCK in fish.

Type: string

Example:

"set -x SSH_AUTH_SOCK $HOME/.ssh/agent.sock"

Declared by:

sshAuthSock.initialization.nushell

Code that initializes SSH_AUTH_SOCK in nushell.

Type: string

Example:

"$env.SSH_AUTH_SOCK = $HOME/.ssh/agent.sock"

Declared by:

sshAuthSock.initialization.zsh

Code that initializes SSH_AUTH_SOCK in zsh.

Type: string

Default:

config.sshAuthSock.initialization.bash

Example:

"export SSH_AUTH_SOCK=$HOME/.ssh/agent.sock"

Declared by:

sshAuthSock.systemd.socketProviderUnit

The name of the systemd unit responsible for providing the SSH_AUTH_SOCK.

Services that rely on an active SSH authentication agent can reference this option to declare a dependency onto this unit, ensuring that the socket is available and being served before they start.

Type: string

Example:

"ssh-agent.service"

Declared by: