Skip to content

Commit

Permalink
guide: start improving SSH remote page
Browse files Browse the repository at this point in the history
  • Loading branch information
jorgeorpinel committed Mar 12, 2023
1 parent 46d9cfb commit db17b38
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 8 deletions.
2 changes: 1 addition & 1 deletion content/docs/sidebar.json
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@
"slug": "aliyun-oss"
},
{
"label": "SSH",
"label": "SSH & SFTP",
"slug": "ssh"
},
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ team.

### Self-hosted / On-premises

- [SSH]; Like `scp`
- [SSH] & SFTP (like `scp`)
- [HDFS] & [WebHDFS]
- [HTTP]
- [WebDAV]
Expand All @@ -125,7 +125,7 @@ team.

## File systems (local remotes)

<admon type="tip">
<admon type="info">

Not related to the `--local` option of `dvc remote` and `dvc config`!

Expand Down
24 changes: 19 additions & 5 deletions content/docs/user-guide/data-management/remote-storage/ssh.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,34 @@
# SSH
# SSH and SFTP

<!--
## SSH
-->

[SSH] (Secure Shell) is a protocol to connect to a remote computer, which lets
you transfer files to and from a remote machine using encryption (like [`scp`])
among other features. DVC will act as an SSH client (like [`ssh`]) which means
that the remote storage should be in an [SSH server]. The credentials to
establish the connection (username, password or private key, etc.) are usually
set in [SSH configuration]; SSH remotes in DVC accept the same values.

[SSH]: https://www.ssh.com/academy/ssh
[`scp`]: https://www.ssh.com/academy/ssh/scp
[`ssh`]: https://www.ssh.com/academy/ssh/command
[ssh server]: https://www.ssh.com/academy/ssh/server
[ssh configuration]: https://www.ssh.com/academy/ssh/config

Start with `dvc remote add` to define the remote:

```cli
$ dvc remote add -d myremote ssh://[email protected]/path
```

⚠️ DVC requires both SSH and SFTP access to work with remote SSH locations.
Check that you can connect both ways with tools like `ssh` and `sftp`
(GNU/Linux).
<admon type="warn">

DVC requires both SSH and SFTP access to work with remote SSH locations. Check
that you can connect both ways with tools like `ssh` and `sftp` (GNU/Linux).

> Note that the server's SFTP root might differ from its physical root (`/`).
</admon>

## Configuration parameters

Expand Down

0 comments on commit db17b38

Please sign in to comment.