-
Notifications
You must be signed in to change notification settings - Fork 394
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
guide: start improving SSH remote page
- Loading branch information
1 parent
46d9cfb
commit db17b38
Showing
3 changed files
with
22 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -137,7 +137,7 @@ | |
"slug": "aliyun-oss" | ||
}, | ||
{ | ||
"label": "SSH", | ||
"label": "SSH & SFTP", | ||
"slug": "ssh" | ||
}, | ||
{ | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
24 changes: 19 additions & 5 deletions
24
content/docs/user-guide/data-management/remote-storage/ssh.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
|
||
|