linux/ohmyzsh
1
0
Fork 0
mirror of https://github.com/ohmyzsh/ohmyzsh.git synced 2024-12-19 20:29:45 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Extract comments into README for ssh-agent plugin

Browse source
This commit is contained in:
Marc Cornellà 2016-08-21 00:19:59 +02:00
parent 81e73e3d18
commit b60acddefe
2 changed files with 38 additions and 30 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

38
plugins/ssh-agent/README.md Normal file
View file

@ -0,0 +1,38 @@
# 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:
```zsh
plugins=(... ssh-agent)
```
## Instructions
To enable **agent forwarding support** add the following to your zshrc file:
```zsh
zstyle :omz:plugins:ssh-agent agent-forwarding on
```
To **load multiple identities** use the `identities` style, For example:
```zsh
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.
```zsh
zstyle :omz:plugins:ssh-agent lifetime 4h
```
## Credits
Based on code from Joseph M. Reagle: http://www.cygwin.com/ml/cygwin/2001-06/msg00537.html
Agent-forwarding support based on ideas from Florent Thoumie and Jonas Pfenniger

30
plugins/ssh-agent/ssh-agent.plugin.zsh
View file

@ -1,32 +1,3 @@
#
# INSTRUCTIONS
#
# 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
#
# CREDITS
#
# Based on code from Joseph M. Reagle
# http://www.cygwin.com/ml/cygwin/2001-06/msg00537.html
#
# Agent forwarding support based on ideas from
# Florent Thoumie and Jonas Pfenniger
#
local _plugin__ssh_env
local _plugin__forwarding
@ -76,4 +47,3 @@ fi
unfunction _plugin__start_agent
unset _plugin__forwarding
unset _plugin__ssh_env