mirror of
https://github.com/wez/wezterm.git
synced 2024-12-27 15:37:29 +03:00
2509e7bd67
Link to the new ssh backend config option and adjust the wording slightly around libssh2.
68 lines
2.0 KiB
Markdown
68 lines
2.0 KiB
Markdown
## SSH Connections
|
|
|
|
wezterm uses an embedded ssh library to provide an integrated SSH client. The
|
|
client can be used to make ad-hoc SSH connections to remote hosts
|
|
by invoking the client like this:
|
|
|
|
```bash
|
|
$ wezterm ssh wez@my.server
|
|
```
|
|
|
|
(checkout `wezterm ssh -h` for more options).
|
|
|
|
When invoked in this way, wezterm may prompt you for SSH authentication
|
|
and once a connection is established, open a new terminal window with
|
|
your requested command, or your shell if you didn't specify one.
|
|
|
|
Creating new tabs or panes will each create a new channel in your existing
|
|
session so you won't need to re-authenticate for additional tabs that you
|
|
create.
|
|
|
|
SSH sessions created in this way are non-persistent and all associated
|
|
tabs will die if your network connection is interrupted.
|
|
|
|
Take a look at [the multiplexing section](multiplexing.html) for an
|
|
alternative configuration that connects to a remote wezterm instance
|
|
and preserves your tabs.
|
|
|
|
The [ssh_backend](config/lua/config/ssh_backend.md) configuration can
|
|
be used to specify which ssh library is used.
|
|
|
|
*Since: 20210404-112810-b63a949d*
|
|
|
|
wezterm is now able to parse `~/.ssh/config` and `/etc/ssh/ssh_config`
|
|
and respects the following options:
|
|
|
|
* `IdentityFile`
|
|
* `Hostname`
|
|
* `User`
|
|
* `Port`
|
|
* `ProxyCommand`
|
|
* `Host` (including wildcard matching)
|
|
* `UserKnownHostsFile`
|
|
* `IdentitiesOnly`
|
|
|
|
All other options are parsed but have no effect. Notably, neither `Match` or
|
|
`Include` will do anything.
|
|
|
|
*Since: 20210502-154244-3f7122cb:*
|
|
|
|
`Match` is now recognized but currently supports only single-phase (`final`,
|
|
`canonical` are not supported) configuration parsing for `Host` and
|
|
`LocalUser`. `Exec` based matches are recognized but not supported.
|
|
|
|
*Since: 20210814-124438-54e29167:*
|
|
|
|
`Include` is now supported.
|
|
|
|
### CLI Overrides
|
|
|
|
`wezterm ssh` CLI allows overriding config settings via the command line. This
|
|
example shows how to specify the private key to use when connecting to
|
|
`some-host`:
|
|
|
|
```bash
|
|
wezterm ssh -oIdentityFile=/secret/id_ed25519 some-host
|
|
```
|
|
|