Skip to content

Commit 88d94c5

Browse files
kcpeveyviniciusdc
andauthored
Apply suggestions from code review
Co-authored-by: Vinicius D. Cerutti <[email protected]>
1 parent 93295c9 commit 88d94c5

File tree

1 file changed

+22
-8
lines changed

1 file changed

+22
-8
lines changed

docs/docs/how-tos/connect-via-ssh.mdx

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -30,21 +30,18 @@ You may add a note and expiration date to the token. You can leave the scopes fi
3030

3131
## Connect to Nebari via SSH
3232

33-
Before you being, you'll need to have SSH installed on your local machine. From a terminal, use `ssh` to begin the connection.
33+
Before you begin, you'll need to have SSH installed on your local machine. From a terminal, use `ssh` to start the connection.
3434

3535
`ssh <your-nebari-domain.com> -l <your-username> -p 8022`
3636

3737
:::important
38-
The syntax for `<your-nebari-domain.com>` is important - do not include `https://` or a trailing `/`.
39-
40-
If you have the incorrect syntax, it will result in the error:
41-
42-
`Could not resolve hostname <your-nebari-domain.com>: nodename nor servname provided, or not known`
38+
The syntax for `<your-nebari-domain.com>` is important - do not include `https://` or a trailing `/`. If you have the incorrect syntax, it will result in the error:
39+
```Could not resolve hostname <your-nebari-domain.com>: nodename nor servname provided, or not known```
4340
:::
4441

4542
You will then be prompted for your password. Enter the token as the password and press `Enter`.
4643

47-
If you don't already have a JupyterLab server running on your Nebari instance, it may take several minutes for the server to start up. The `ssh` connection has it's own timeout period which is likely shorter than the time it takes to spinup a new server. Therefore, you may see the following error as the `ssh` connection times out:
44+
If you don't already have a JupyterLab server running on your Nebari instance, the server may take a few minutes to start up. The `ssh` connection has its own timeout period, likely shorter than the time it takes to spin up a new server. Therefore, you may see the following error as the `ssh` connection times out:
4845

4946
`Starting your server............................................failed to start server on time!`
5047

@@ -54,10 +51,27 @@ Once the connection is complete, you will have terminal access to your JupyterLa
5451

5552
## Use SFTP to transfer files to/from Nebari
5653

57-
SFTP, which stands for _Secure File Transfer Protocol_, is a protocol built into SSH that can implement file transfer commands over a secure connection. The SFTP port on Nebari is 8023.
54+
By default, SFTP uses the SSH protocol to authenticate and establish a secure connection. Because of this, the same authentication token used previously in its SSH counterpart can be used here.
5855

5956
Utilizing SFTP will depend on how your local machine is configured and the utility you're using for SFTP. In some cases, your SSH configuration will allow SFTP to work "out of the box". Other times, special SFTP setup is required in your SSH configuration to allow for these connections.
57+
Similar to `ssh`, from a terminal, use `sftp` to begin a new connection:
58+
```sftp <your-nebari-domain.com> -l <your-username> -p 8023```
59+
60+
### Transferring Files with SFTP
61+
62+
Downloading Files:
63+
64+
- Use the `get` command to download files from the remote host:
65+
- `get <remote-file>` downloads the file with the same name to the local system.
66+
- `get <remote-file> <local-file>` downloads and saves the file with a different name.
67+
- To download a directory and its contents, use `get -r <some-directory>`.
68+
- To maintain permissions and access times, use `get -Pr <some-directory>`.
69+
70+
Uploading Files:
6071

72+
- Use the `put` command to upload files to the remote system:
73+
- `put <local-file>` uploads the file.
74+
- To upload a directory and its contents, use `put -r <some-directory>`.
6175
## Dangerous, but useful information
6276

6377
:::warning

0 commit comments

Comments
 (0)