Skip to content

Commit

Permalink
command-reference: remote: add: add a note about SSH/SFTP quirks
Browse files Browse the repository at this point in the history
Fixes #781 
Fixes #802
  • Loading branch information
efiop authored Nov 19, 2019
1 parent def161a commit 0798d9a
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions static/docs/command-reference/remote/add.md
Original file line number Diff line number Diff line change
Expand Up @@ -250,6 +250,17 @@ $ dvc remote add myremote gs://bucket/path
$ dvc remote add myremote ssh://[email protected]/path/to/dir
```

> **NOTE!** DVC requires SSH and SFTP access to work properly. Please use `ssh`
> and `sftp` CLI commands to ensure that you are able to connect to your remote.
> **NOTE!** Your server's SFTP root might differ from the physical root
> (see `ChrootDirectory` config option in `/etc/ssh/sshd_config`), in which
> case you have to specify `/path/to/dir` component of the remote url relative
> to the SFTP root and not the physical root. For example, on some Synology NASes
> your SFTP root might correspond to a physical directory `/volume1`, in which
> case you should specify something like `ssh://[email protected]/path/to/dir`
> instead of `ssh://[email protected]/volume1/path/to/dir`.
</details>

<details>
Expand Down

0 comments on commit 0798d9a

Please sign in to comment.