Skip to content

Commit

Permalink
Merge pull request #214 from kinode-dao/hf/hosted-nodes-edits
Browse files Browse the repository at this point in the history
kit connect edits
  • Loading branch information
jurij-jukic authored Jun 7, 2024
2 parents 5d34cde + 5e96234 commit d2c262d
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions src/kit/connect.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,38 +9,38 @@ Then use
```
kit connect --host <SSH Address>
```
and paste in the password when prompted.
and paste in the node's SSH password when prompted.
You will be prompted for your password twice.
This is to first determine the port to create the SSH tunnel to, and then to create the tunnel.
You can also provide the port (Valet displays it as Local HTTP Port) and only be prompted for password once:
```
kit connect --host <SSH Address> --port <Valet Local HTTP Port>
```

It is recommended to [set up your SSH configuration on your local machine and the remote host]()../hosted-nodes.md#using-ssh-keys.
It is recommended to [set up your SSH configuration on your local machine and the remote host](../hosted-nodes.md#using-ssh-keys).
Then `kit connect` usage looks like:
```
kit connect --host <Host>
```
where `<Host>` here is defined in your `~/.ssh/config` file.

To disconnect a SSH tunnel, use the `--disconnect` flag and the local port bound, by default, `9090`:
To disconnect an SSH tunnel, use the `--disconnect` flag and the local port bound, by default, `9090`:
```
kit connect 9090 --disconnect
```

## Discussion

See discussion of why SSH tunnels are useful for development with `kit` [here](../hosted-nodes.md#using-kit-with-your-hosted-node).
Briefly, creating a SSH tunnel allows you to use `kit` with a remote hosted node in the same way you do with a local one.
Briefly, creating an SSH tunnel allows you to use `kit` with a remote hosted node in the same way you do with a local one.
Setting up your SSH configuration will make `kit connect` work better.
You can find instructions for doing so [here](../hosted-nodes.md#using-ssh-keys).

## Arguments

```
$ kit connect --help
Connect (or disconnect) a ssh tunnel to a remote server
Connect (or disconnect) an SSH tunnel to a remote server
Usage: kit connect [OPTIONS] [LOCAL_PORT]
Expand Down

0 comments on commit d2c262d

Please sign in to comment.