-
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 (intro)
- Loading branch information
1 parent
46d9cfb
commit 9fd1462
Showing
5 changed files
with
46 additions
and
17 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -99,11 +99,13 @@ $ dvc stage add -n download_file \ | |
scp [email protected]:/path/to/data.txt data.txt | ||
``` | ||
|
||
⚠️ 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"> | ||
|
||
> Note that your server's SFTP root might differ from its physical root (`/`). | ||
DVC requires both SSH and SFTP access to work with SSH remote storage. Check | ||
that you can connect both ways with tools like `ssh` and `sftp` (GNU/Linux). | ||
Note that your server's SFTP root might differ from its physical root (`/`). | ||
|
||
</admon> | ||
|
||
</details> | ||
|
||
|
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 |
---|---|---|
|
@@ -125,11 +125,13 @@ $ dvc stage add -d data.txt \ | |
scp data.txt [email protected]:/data.txt | ||
``` | ||
|
||
⚠️ 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"> | ||
|
||
> Note that your server's SFTP root might differ from its physical root (`/`). | ||
DVC requires both SSH and SFTP access to work with SSH remote storage. Check | ||
that you can connect both ways with tools like `ssh` and `sftp` (GNU/Linux). | ||
Note that your server's SFTP root might differ from its physical root (`/`). | ||
|
||
</admon> | ||
|
||
</details> | ||
|
||
|
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
37 changes: 31 additions & 6 deletions
37
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,45 @@ | ||
# SSH | ||
# SSH and SFTP | ||
|
||
<!-- | ||
## SSH | ||
--> | ||
|
||
Start with `dvc remote add` to define the remote: | ||
<details> | ||
|
||
### Click to learn about SSH and SFTP. | ||
|
||
[SSH] (Secure Shell) is a protocol that uses encryption to secure a connection | ||
with a remote computer, which lets you safely transfer files to and from it | ||
(like [`scp`]), among other features. Other operations can be used on top of | ||
SSH, like FTP (simple file transfer protocol) which becomes secure or [SFTP]. | ||
|
||
[SSH]: https://www.ssh.com/academy/ssh | ||
[SFTP]: https://www.ssh.com/academy/ssh/sftp-ssh-file-transfer-protocol | ||
[`scp`]: https://www.ssh.com/academy/ssh/scp | ||
|
||
</details> | ||
|
||
DVC will act as an SSH/SFTP client, which means that the remote storage should | ||
be located in an [SSH server]. Use `dvc remote add` to define the remote by | ||
setting a name and valid [SSH URL] (may include basic auth info. like a user | ||
name): | ||
|
||
```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). | ||
[ssh server]: https://www.ssh.com/academy/ssh/server | ||
[SSH URL]: https://www.ietf.org/archive/id/draft-salowey-secsh-uri-00.html | ||
|
||
<admon type="warn"> | ||
|
||
DVC requires both SSH and SFTP access to work with SSH remote storage. Check | ||
that you can connect both ways with tools like [`ssh`] and `sftp` (GNU/Linux). | ||
Note that your server's SFTP root might differ from its physical root (`/`). | ||
|
||
[`ssh`]: https://www.ssh.com/academy/ssh/command | ||
|
||
> Note that the server's SFTP root might differ from its physical root (`/`). | ||
</admon> | ||
|
||
## Configuration parameters | ||
|
||
|