Upstream/waveterm
1
0
Fork 0
mirror of https://github.com/wavetermdev/waveterm.git synced 2024-12-22 16:48:23 +01:00
Code Issues Packages Projects Releases Wiki Activity

Connection Dropdown Photo in docs (#1242)

Browse Source
This commit is contained in:
Sylvie Crowe 2024-11-08 11:11:06 -08:00 committed by GitHub
parent d5297cc5d4
commit 59abdc7971
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 10 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/docs/connections.mdx
View File

@ -12,7 +12,10 @@ Wave allows users to connect to various machines and unify them together in a wa
The easiest way to access connections is to click the <i className="fa-sharp fa-laptop"/> icon. From there, you can either type `[user]@[host]` for a desired SSH remote or type `wsl://<distribution name>` for a desired WSL distribution. Alternatively, if the connection already exists in the dropdown list, you can either click it or navigate to it with arrow keys and press enter to connect. The easiest way to access connections is to click the <i className="fa-sharp fa-laptop"/> icon. From there, you can either type `[user]@[host]` for a desired SSH remote or type `wsl://<distribution name>` for a desired WSL distribution. Alternatively, if the connection already exists in the dropdown list, you can either click it or navigate to it with arrow keys and press enter to connect.
![a dropdown showing a list of connections that already exist](/img/connection-dropdown.png)
## What are wsh Shell Extensions? ## What are wsh Shell Extensions?
`wsh` is a small program that helps manage waveterm regardless of which machine you are currently connected to. In order to not interrupt the normal flow of the remote session, we install it on your remote machine at `~/.waveterm/bin/wsh`. Then, when wave connects to your connection (and only when wave connects to your connection), `~/.waveterm/bin` is added to your `PATH` for that individual session. For more info on what `wsh` is capable of, see [wsh command](/wsh). And if you wish to view the source code of `wsh`, you can find it [here](https://github.com/wavetermdev/waveterm/tree/main/cmd/wsh). `wsh` is a small program that helps manage waveterm regardless of which machine you are currently connected to. In order to not interrupt the normal flow of the remote session, we install it on your remote machine at `~/.waveterm/bin/wsh`. Then, when wave connects to your connection (and only when wave connects to your connection), `~/.waveterm/bin` is added to your `PATH` for that individual session. For more info on what `wsh` is capable of, see [wsh command](/wsh). And if you wish to view the source code of `wsh`, you can find it [here](https://github.com/wavetermdev/waveterm/tree/main/cmd/wsh).
## Add a New Connection to the Dropdown ## Add a New Connection to the Dropdown
@ -22,6 +25,7 @@ The SSH values that are loaded into the dropdown by default are obtained by pars
WSL values are added by searching the installed WSL distributions as they appear in the Windows Registry. WSL values are added by searching the installed WSL distributions as they appear in the Windows Registry.
## SSH Config Parsing ## SSH Config Parsing
At the moment, we are capable of parsing any SSH config file that does not contain the `Match` keyword. This keyword is incompatible with a library we are using, but we are hoping to fix that soon. While all other valid keywords are parsed, we only support the functionality of a small subset of them at the moment: At the moment, we are capable of parsing any SSH config file that does not contain the `Match` keyword. This keyword is incompatible with a library we are using, but we are hoping to fix that soon. While all other valid keywords are parsed, we only support the functionality of a small subset of them at the moment:
| Keyword | Description | | Keyword | Description |
|---------|-------------| |---------|-------------|
@ -38,7 +42,9 @@ At the moment, we are capable of parsing any SSH config file that does not conta
|ProxyJump| Specifies one or more jump proxies in a comma separated list. Each will be visited sequentially using TCP forwarding before connecting to the desired connection (also using TCP forwarding). It can be set to `none` to disable the feature.| |ProxyJump| Specifies one or more jump proxies in a comma separated list. Each will be visited sequentially using TCP forwarding before connecting to the desired connection (also using TCP forwarding). It can be set to `none` to disable the feature.|
### Example SSH Config Host ### Example SSH Config Host
For a quick example, a host in your config file may look like: For a quick example, a host in your config file may look like:
``` ```
Host myhost Host myhost
User username User username
@ -46,7 +52,9 @@ Host myhost
IdentityFile ~/.ssh/id_rsa IdentityFile ~/.ssh/id_rsa
AddKeysToAgent yes AddKeysToAgent yes
``` ```
You would then be able to access this connection with `myhost` or `username@myhost`. And if you wanted to manually specify a port such as port 2222, you could do that by either adding `Port 2222` to the config file or connecting to `username@myhost:2222`. You would then be able to access this connection with `myhost` or `username@myhost`. And if you wanted to manually specify a port such as port 2222, you could do that by either adding `Port 2222` to the config file or connecting to `username@myhost:2222`.
## Managing Connections with the CLI ## Managing Connections with the CLI
The `wsh` command gives some commands specifically for interacting with the connections. You can view these [here](/wsh#conn). The `wsh` command gives some commands specifically for interacting with the connections. You can view these [here](/wsh#conn).

BIN
docs/static/img/connection-dropdown.png vendored Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 150 KiB