-
Notifications
You must be signed in to change notification settings - Fork 409
docs: Std. SSH URLs and rel. notes about SFTP #1649
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
715b8b9
d27e07d
c27303b
94926ee
8c60723
8703362
ce32ddf
aa5d6fd
7414ce6
710720d
3be66c1
6ec6717
f68eb40
dfbc33e
2879de2
990de59
0fb4b0d
34bae5c
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -62,7 +62,7 @@ DVC supports several types of (local or) remote locations (protocols): | |
| | `s3` | Amazon S3 | `s3://mybucket/data` | | ||
| | `azure` | Microsoft Azure Blob Storage | `azure://my-container-name/path/to/data` | | ||
| | `gs` | Google Cloud Storage | `gs://mybucket/data` | | ||
| | `ssh` | SSH server | `ssh://user@example.com:/path/to/data` | | ||
| | `ssh` | SSH server | `ssh://user@example.com/path/to/data` | | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. same
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Auto-formatted. To align columns I guess. Looks "prettier" tehehe |
||
| | `hdfs` | HDFS to file (explanation below) | `hdfs://user@example.com/path/to/data.csv` | | ||
| | `http` | HTTP to file with _strong ETag_ (explanation below) | `https://example.com/path/to/data.csv` | | ||
| | `remote` | Remote path (see explanation below) | `remote://myremote/path/to/data` | | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -307,16 +307,11 @@ $ dvc remote add -d myremote ssh://user@example.com/path/to/dir | |
|
|
||
| > See also `dvc remote modify` for a full list of SSH parameters. | ||
|
|
||
| ⚠️ DVC requires both SSH and SFTP access to work with SSH remote storage. Please | ||
| check that you are able to connect both ways to the remote location, with tools | ||
| like `ssh` and `sftp` (GNU/Linux). | ||
|
|
||
| > Note that your server's SFTP root might differ from its physical root (`/`). | ||
| > (On Linux, see the `ChrootDirectory` setting in `/etc/ssh/sshd_config`.) In | ||
| > these cases, the path component in the SSH URL (e.g. `/path/to/dir` above) | ||
| > should be specified relative to the SFTP root instead. For example, on some | ||
| > Sinology NAS drives, the SFTP root might be in directory `/volume1`, in which | ||
| > case you should use path `/path/to/dir` instead of `/volume1/path/to/dir`. | ||
|
Comment on lines
-315
to
-319
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I decided to remove these details. They seem more like tips unrelated to DVC. Users can research SFTP details on other sites easily, I think. Left a quick note: "Note that the server's SFTP root might differ from its physical root (
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. ounds good! and we can elaborate when we have a separate page per remote I guess
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We're planning to do separate pages per remote? I don't recall that decision. It sounds like a good plan except that the remote types are already burried in docs->cmd ref->remote->add/modify->expandable sections so not sure adding yet another level to that tree is a good idea. Maybe the remote types should all be in the remote ref. index? And the remote concept explanation in Basic Concepts. |
||
| ⚠️ DVC requires both SSH and SFTP access to work with remote SSH locations. | ||
| Please check that you are able to connect both ways with tools like `ssh` and | ||
| `sftp` (GNU/Linux). | ||
|
|
||
| > Note that the server's SFTP root might differ from its physical root (`/`). | ||
|
|
||
| </details> | ||
|
|
||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
do we need the trailing space?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes. It's all formatted by Prettier this way.