1
0
Fork 0
mirror of https://github.com/ohmyzsh/ohmyzsh.git synced 2024-12-21 03:41:57 +00:00
ohmyzsh/plugins/ssh-agent/README.md
Will Boyce 0e232d4853
feat(ssh-agent): add ssh-add-args setting (#7908)
* ssh-agent: add `:omz:plugins:ssh-agent ssh_add_args` option

* Clean up and document extra setting

* Document valid ssh-add arguments

Co-authored-by: Marc Cornellà <hello@mcornella.com>
2021-03-15 22:51:33 +01:00

1.6 KiB

ssh-agent plugin

This plugin starts automatically ssh-agent to set up and load whichever credentials you want for ssh connections.

To enable it, add ssh-agent to your plugins:

plugins=(... ssh-agent)

Settings

IMPORTANT: put these settings before the line that sources oh-my-zsh

To enable agent forwarding support add the following to your zshrc file:

zstyle :omz:plugins:ssh-agent agent-forwarding on

To load multiple identities use the identities style, For example:

zstyle :omz:plugins:ssh-agent identities id_rsa id_rsa2 id_github

To set the maximum lifetime of the identities, use the lifetime style. The lifetime may be specified in seconds or as described in sshd_config(5) (see TIME FORMATS). If left unspecified, the default lifetime is forever.

zstyle :omz:plugins:ssh-agent lifetime 4h

To pass arguments to the ssh-add command that adds the identities on startup, use the ssh-add-args setting. You can pass multiple arguments separated by spaces:

zstyle :omz:plugins:ssh-agent ssh-add-args -K -c -a /run/user/1000/ssh-auth

These will then be passed the the ssh-add call as if written directly. The example above will turn into:

ssh-add -K -c -a /run/user/1000/ssh-auth <identities>

For valid ssh-add arguments run ssh-add --help or man ssh-add.

Credits

Based on code from Joseph M. Reagle: https://www.cygwin.com/ml/cygwin/2001-06/msg00537.html

Agent-forwarding support based on ideas from Florent Thoumie and Jonas Pfenniger