diff --git a/content/docs/command-reference/remote/add.md b/content/docs/command-reference/remote/add.md index adc643d7aa..da58a1a569 100644 --- a/content/docs/command-reference/remote/add.md +++ b/content/docs/command-reference/remote/add.md @@ -344,6 +344,18 @@ $ dvc remote add -d myremote https://example.com/path/to/dir
+### Click for WebDAV + +```dvc +$ dvc remote add -d myremote webdavs://example.com/path/to/dir +``` + +> See also `dvc remote modify` for a full list of WebDAV parameters. + +
+ +
+ ### Click for local remote A "local remote" is a directory in the machine's file system. diff --git a/content/docs/command-reference/remote/modify.md b/content/docs/command-reference/remote/modify.md index 279a791719..00bc54f523 100644 --- a/content/docs/command-reference/remote/modify.md +++ b/content/docs/command-reference/remote/modify.md @@ -582,6 +582,70 @@ more information.
+
+ +### Click for WebDAV + +- `token` - token for WebDAV server, can be empty in case of using + `user/password` authentication. + + ```dvc + $ dvc remote modify --local myremote token mytoken + ``` + +- `user` - username for WebDAV server, can be empty in case of using `token` + authentication. The order in which DVC searches for username is: + + 1. `user` specified in one of the DVC configs; + 2. `user` specified in the url (e.g. `webdav://user@example.com/path`) + + ```dvc + $ dvc remote modify --local myremote user myuser + ``` + +- `password` - password for WebDAV server, can be empty in case of using `token` + authentication. + + ```dvc + $ dvc remote modify --local myremote password mypassword + ``` + +> The username, password, and token (may) contain sensitive user info. +> Therefore, it's safer to add them with the `--local` option, so they're +> written to a Git-ignored config file. + +- `ask_password` - ask each time for the password to use for `user/password` + authentication. + + ```dvc + $ dvc remote modify myremote ask_password true + ``` + + > Note that the `password` parameter takes precedence over `ask_password`. If + > `password` is specified, DVC will not prompt the user to enter a password + > for this remote. + +- `cert_path` - path to certificate used for WebDAV server authentication. + + ```dvc + $ dvc remote modify myremote cert_path /path/to/cert + ``` + +- `key_path` - path to private key to use to access a remote. + + ```dvc + $ dvc remote modify myremote key_path /path/to/key + ``` + +- `timeout` - connection timeout (in seconds) for WebDAV server (default: 30 + seconds). + + ```dvc + $ dvc remote modify myremote timeout 120 + ``` + +
+ ## Example: Customize an S3 remote Let's first set up a _default_ S3 remote.