From a00dd309798c5a99b12d702647bd3421bf9d79f9 Mon Sep 17 00:00:00 2001 From: Christoph Berganski Date: Wed, 22 Jul 2020 23:45:55 +0200 Subject: [PATCH 01/23] cmd: add parameters for configuration of WebDAV remotes Relates to iterative#1153, https://github.com/iterative/dvc/pull/4256 --- content/docs/command-reference/remote/add.md | 12 ++++ .../docs/command-reference/remote/modify.md | 59 +++++++++++++++++++ 2 files changed, 71 insertions(+) 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..fd68953d86 100644 --- a/content/docs/command-reference/remote/modify.md +++ b/content/docs/command-reference/remote/modify.md @@ -582,6 +582,65 @@ more information.
+
+ +### Click for WebDAV + +- `token` - token for WebDAV server, can be empty in case of using + `user/password` authentication. + +- `user` - username for WebDAV server, can be empty in case of using `token` + authentication. The order in which DVC searches for username: + + 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 myremote --local password mypassword + ``` + +> The username and password (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 to use for WebDAV. + + ```dvc + $ dvc remote modify myremote timeout timeoutseconds + ``` + +
+ ## Example: Customize an S3 remote Let's first set up a _default_ S3 remote. From 9864d502f927640226e432bfe3e3e8605002c5b8 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Wed, 22 Jul 2020 21:36:41 -0500 Subject: [PATCH 02/23] Update content/docs/command-reference/remote/modify.md --- content/docs/command-reference/remote/modify.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/command-reference/remote/modify.md b/content/docs/command-reference/remote/modify.md index fd68953d86..ce17b39813 100644 --- a/content/docs/command-reference/remote/modify.md +++ b/content/docs/command-reference/remote/modify.md @@ -593,7 +593,7 @@ more information. authentication. The order in which DVC searches for username: 1. `user` specified in one of the DVC configs; - 2. `user` specified in the url(e.g. `webdav://user@example.com/path`); + 2. `user` specified in the url (e.g. `webdav://user@example.com/path`) ```dvc $ dvc remote modify --local myremote user myuser From 6d7eeeb60f39bf90d9829325b3df09c6eaab2c8e Mon Sep 17 00:00:00 2001 From: Christoph Berganski Date: Thu, 23 Jul 2020 10:53:57 +0200 Subject: [PATCH 03/23] cmd: add token authentication example to remote modify for WebDAV Context: https://github.com/iterative/dvc.org/pull/1617#discussion_r459185785 --- content/docs/command-reference/remote/modify.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/content/docs/command-reference/remote/modify.md b/content/docs/command-reference/remote/modify.md index ce17b39813..efbf8d48ba 100644 --- a/content/docs/command-reference/remote/modify.md +++ b/content/docs/command-reference/remote/modify.md @@ -589,6 +589,10 @@ more information. - `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: @@ -603,11 +607,11 @@ more information. authentication. ```dvc - $ dvc remote modify myremote --local password mypassword + $ dvc remote modify --local myremote password mypassword ``` -> The username and password (may) contain sensitive user info. Therefore, it's -> safer to add them with the `--local` option, so they're written to a +> 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` From 127d00e18342f1413008156b59b7f50b6835156f Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Wed, 5 Aug 2020 00:41:08 -0500 Subject: [PATCH 04/23] Update content/docs/command-reference/remote/modify.md --- content/docs/command-reference/remote/modify.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/content/docs/command-reference/remote/modify.md b/content/docs/command-reference/remote/modify.md index efbf8d48ba..5daad80cab 100644 --- a/content/docs/command-reference/remote/modify.md +++ b/content/docs/command-reference/remote/modify.md @@ -610,9 +610,9 @@ more information. $ 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. +> 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. From feb10a082785f06d553288d78a60b87249b1f16a Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Wed, 5 Aug 2020 00:41:53 -0500 Subject: [PATCH 05/23] Update content/docs/command-reference/remote/modify.md --- content/docs/command-reference/remote/modify.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/command-reference/remote/modify.md b/content/docs/command-reference/remote/modify.md index 5daad80cab..c5b0be3c06 100644 --- a/content/docs/command-reference/remote/modify.md +++ b/content/docs/command-reference/remote/modify.md @@ -594,7 +594,7 @@ more information. ``` - `user` - username for WebDAV server, can be empty in case of using `token` - authentication. The order in which DVC searches for username: + 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`) From 49e894d21ea06834e54107cbd6ecd62ecbb2a225 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Wed, 5 Aug 2020 00:48:07 -0500 Subject: [PATCH 06/23] Update content/docs/command-reference/remote/modify.md --- content/docs/command-reference/remote/modify.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/command-reference/remote/modify.md b/content/docs/command-reference/remote/modify.md index c5b0be3c06..514ea7b1aa 100644 --- a/content/docs/command-reference/remote/modify.md +++ b/content/docs/command-reference/remote/modify.md @@ -637,7 +637,7 @@ more information. $ dvc remote modify myremote key_path /path/to/key ``` -- `timeout` - connection timeout to use for WebDAV. +- `timeout` - connection timeout for WebDAV server. ```dvc $ dvc remote modify myremote timeout timeoutseconds From 4fa3d8bcb8111877b98302bc94dd049fecf2bc44 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Wed, 5 Aug 2020 00:56:25 -0500 Subject: [PATCH 07/23] Update content/docs/command-reference/remote/modify.md --- content/docs/command-reference/remote/modify.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/command-reference/remote/modify.md b/content/docs/command-reference/remote/modify.md index 514ea7b1aa..5741e4675f 100644 --- a/content/docs/command-reference/remote/modify.md +++ b/content/docs/command-reference/remote/modify.md @@ -637,7 +637,7 @@ more information. $ dvc remote modify myremote key_path /path/to/key ``` -- `timeout` - connection timeout for WebDAV server. +- `timeout` - connection timeout (in seconds) for WebDAV server. ```dvc $ dvc remote modify myremote timeout timeoutseconds From 8f0836cf908f2acb0a4889726ea3d3e6f2ff5b1f Mon Sep 17 00:00:00 2001 From: Christoph Berganski Date: Wed, 5 Aug 2020 14:37:22 +0200 Subject: [PATCH 08/23] Update content/docs/command-reference/remote/modify.md Co-authored-by: Jorge Orpinel --- content/docs/command-reference/remote/modify.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/command-reference/remote/modify.md b/content/docs/command-reference/remote/modify.md index 5741e4675f..a53d08bb10 100644 --- a/content/docs/command-reference/remote/modify.md +++ b/content/docs/command-reference/remote/modify.md @@ -640,7 +640,7 @@ more information. - `timeout` - connection timeout (in seconds) for WebDAV server. ```dvc - $ dvc remote modify myremote timeout timeoutseconds + $ dvc remote modify myremote timeout 120 ``` From b449189a0a8ad75c414f6eb7fcb901875be4be67 Mon Sep 17 00:00:00 2001 From: Christoph Berganski Date: Wed, 5 Aug 2020 14:44:58 +0200 Subject: [PATCH 09/23] Update modify.md --- content/docs/command-reference/remote/modify.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/command-reference/remote/modify.md b/content/docs/command-reference/remote/modify.md index a53d08bb10..c0f5e8988e 100644 --- a/content/docs/command-reference/remote/modify.md +++ b/content/docs/command-reference/remote/modify.md @@ -637,7 +637,7 @@ more information. $ dvc remote modify myremote key_path /path/to/key ``` -- `timeout` - connection timeout (in seconds) for WebDAV server. +- `timeout` - connection timeout (in seconds) for WebDAV server (default: 30 seconds). ```dvc $ dvc remote modify myremote timeout 120 From 84b76dc74f8313f1847762171a42f1e3c25bd487 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Thu, 6 Aug 2020 03:06:09 -0500 Subject: [PATCH 10/23] Update content/docs/command-reference/remote/modify.md --- content/docs/command-reference/remote/modify.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/command-reference/remote/modify.md b/content/docs/command-reference/remote/modify.md index c0f5e8988e..28d355fede 100644 --- a/content/docs/command-reference/remote/modify.md +++ b/content/docs/command-reference/remote/modify.md @@ -637,7 +637,7 @@ more information. $ dvc remote modify myremote key_path /path/to/key ``` -- `timeout` - connection timeout (in seconds) for WebDAV server (default: 30 seconds). +- `timeout` - connection timeout (in seconds) for WebDAV server (default: 30). ```dvc $ dvc remote modify myremote timeout 120 From e70cd5bac6630ccc202698c3128fa73ae400dd56 Mon Sep 17 00:00:00 2001 From: Christoph Berganski Date: Thu, 6 Aug 2020 15:50:53 +0200 Subject: [PATCH 11/23] Update content/docs/command-reference/remote/add.md Co-authored-by: Jorge Orpinel --- content/docs/command-reference/remote/add.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/command-reference/remote/add.md b/content/docs/command-reference/remote/add.md index da58a1a569..7d5e5ce521 100644 --- a/content/docs/command-reference/remote/add.md +++ b/content/docs/command-reference/remote/add.md @@ -347,7 +347,7 @@ $ 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 +$ dvc remote add -d myremote webdavs://example.com/public.php/webdav ``` > See also `dvc remote modify` for a full list of WebDAV parameters. From b76cec5113c42579745ca538fd7a9aaf2ca1ee2f Mon Sep 17 00:00:00 2001 From: Christoph Berganski Date: Thu, 6 Aug 2020 15:58:25 +0200 Subject: [PATCH 12/23] cmd: add explanation of WebDAV API location to 'remote add' command Context: https://github.com/iterative/dvc.org/pull/1617#discussion_r466217041 --- content/docs/command-reference/remote/add.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/content/docs/command-reference/remote/add.md b/content/docs/command-reference/remote/add.md index 7d5e5ce521..e25c5f71ca 100644 --- a/content/docs/command-reference/remote/add.md +++ b/content/docs/command-reference/remote/add.md @@ -352,6 +352,9 @@ $ dvc remote add -d myremote webdavs://example.com/public.php/webdav > See also `dvc remote modify` for a full list of WebDAV parameters. +> Note that the location of the WebDAV API endpoint `/public.php/webdav` might +> be different for your server. +
From b413b0e520d84a0962db0b4c06ba97bb3abc94af Mon Sep 17 00:00:00 2001 From: Christoph Berganski Date: Thu, 6 Aug 2020 16:16:33 +0200 Subject: [PATCH 13/23] cmd: clarify user/password, token and ask_password relation for WebDAV Context: https://github.com/iterative/dvc.org/pull/1617#discussion_r465486883 --- content/docs/command-reference/remote/modify.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/content/docs/command-reference/remote/modify.md b/content/docs/command-reference/remote/modify.md index 28d355fede..140d0e002a 100644 --- a/content/docs/command-reference/remote/modify.md +++ b/content/docs/command-reference/remote/modify.md @@ -614,6 +614,10 @@ more information. > Therefore, it's safer to add them with the `--local` option, so they're > written to a Git-ignored config file. +> Note that `user/password` and `token` authentication are incompatible. You +> should authenticate against yout WebDAV remote by either `user/password` or +> `token`. + - `ask_password` - ask each time for the password to use for `user/password` authentication. @@ -625,6 +629,10 @@ more information. > `password` is specified, DVC will not prompt the user to enter a password > for this remote. + > Note that `token` authentication does not require a `password`. If `token` + > is specified, `ask_password` is ignored and DVC will not prompt the user to + > enter a password for this remote. + - `cert_path` - path to certificate used for WebDAV server authentication. ```dvc From 2f72006c2234f478151b3193e73aea2ef62fb44c Mon Sep 17 00:00:00 2001 From: Christoph Berganski Date: Thu, 6 Aug 2020 16:30:57 +0200 Subject: [PATCH 14/23] cmd: add ' quotes to token as it might contain special characters Context: https://github.com/iterative/dvc.org/pull/1617#discussion_r465488141 --- content/docs/command-reference/remote/modify.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/command-reference/remote/modify.md b/content/docs/command-reference/remote/modify.md index 140d0e002a..b680a0d508 100644 --- a/content/docs/command-reference/remote/modify.md +++ b/content/docs/command-reference/remote/modify.md @@ -590,7 +590,7 @@ more information. `user/password` authentication. ```dvc - $ dvc remote modify --local myremote token mytoken + $ dvc remote modify --local myremote token 'mytoken' ``` - `user` - username for WebDAV server, can be empty in case of using `token` From d870b34984020a8a0488608ea74ea6dec1d15c9b Mon Sep 17 00:00:00 2001 From: Christoph Berganski Date: Thu, 6 Aug 2020 17:24:19 +0200 Subject: [PATCH 15/23] cmd: move 'user' order explanation after the example as suggested Context: https://github.com/iterative/dvc.org/pull/1617#discussion_r465488372 --- content/docs/command-reference/remote/modify.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/content/docs/command-reference/remote/modify.md b/content/docs/command-reference/remote/modify.md index b680a0d508..214918dd56 100644 --- a/content/docs/command-reference/remote/modify.md +++ b/content/docs/command-reference/remote/modify.md @@ -594,15 +594,17 @@ more information. ``` - `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`) + authentication. ```dvc $ dvc remote modify --local myremote user myuser ``` + 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`) + - `password` - password for WebDAV server, can be empty in case of using `token` authentication. From 31bccb535f08f88fdc6fe09d99362c886d4b2142 Mon Sep 17 00:00:00 2001 From: Christoph Berganski Date: Thu, 6 Aug 2020 17:45:10 +0200 Subject: [PATCH 16/23] cmd: add more explanation to WebDAV certificates parameters Context: https://github.com/iterative/dvc.org/pull/1617#discussion_r466211810 --- content/docs/command-reference/remote/modify.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/content/docs/command-reference/remote/modify.md b/content/docs/command-reference/remote/modify.md index 214918dd56..0dbafa1d75 100644 --- a/content/docs/command-reference/remote/modify.md +++ b/content/docs/command-reference/remote/modify.md @@ -635,7 +635,8 @@ more information. > is specified, `ask_password` is ignored and DVC will not prompt the user to > enter a password for this remote. -- `cert_path` - path to certificate used for WebDAV server authentication. +- `cert_path` - path to certificate used for WebDAV server authentication, if + you need to use local client side certificates. ```dvc $ dvc remote modify myremote cert_path /path/to/cert @@ -647,6 +648,10 @@ more information. $ dvc remote modify myremote key_path /path/to/key ``` + > Note that the `key_path` option is only valid in combination with + > `cert_path` option. However, the certificate might already contain the + > private key. + - `timeout` - connection timeout (in seconds) for WebDAV server (default: 30). ```dvc From 098fe82a2230a85a1086b25e55ad210077d9a08a Mon Sep 17 00:00:00 2001 From: Christoph Berganski Date: Thu, 6 Aug 2020 17:58:51 +0200 Subject: [PATCH 17/23] cmd: add 'url' parameter explanations to 'remote' modify for WebDAV Context: https://github.com/iterative/dvc.org/pull/1617#discussion_r466217085 --- .../docs/command-reference/remote/modify.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/content/docs/command-reference/remote/modify.md b/content/docs/command-reference/remote/modify.md index 0dbafa1d75..0a4eb8e967 100644 --- a/content/docs/command-reference/remote/modify.md +++ b/content/docs/command-reference/remote/modify.md @@ -586,6 +586,24 @@ more information. ### Click for WebDAV +- `url` - remote location URL. + + ```dvc + $ dvc remote modify myremote \ + url webdavs://example.com/public.php/webdav + ``` + + > Note that the location of the WebDAV API endpoint `/public.php/webdav` might + > be different for your server. + + If your remote is located in a subfolder of your WebDAV server e.g. + `/path/to/dir`, this may be appended to the general `url`: + + ```dvc + $ dvc remote modify myremote \ + url webdavs://example.com/public.php/webdav/path/to/dir + ``` + - `token` - token for WebDAV server, can be empty in case of using `user/password` authentication. From 5eca2119addba5669941d3a95cf5e0864ebe6fcb Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Thu, 6 Aug 2020 18:33:50 -0500 Subject: [PATCH 18/23] Update content/docs/command-reference/remote/modify.md --- content/docs/command-reference/remote/modify.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/docs/command-reference/remote/modify.md b/content/docs/command-reference/remote/modify.md index 0a4eb8e967..a8f4603e5f 100644 --- a/content/docs/command-reference/remote/modify.md +++ b/content/docs/command-reference/remote/modify.md @@ -620,8 +620,8 @@ more information. 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`) + 1. `user` parameter set with this command (found in `.dvc/config`); + 2. User defined in the URL (e.g. `webdav://user@example.com/path`) - `password` - password for WebDAV server, can be empty in case of using `token` authentication. From 5d3b9ec4b9cf39ec148d861137d474d9e1d023f9 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Thu, 6 Aug 2020 18:35:29 -0500 Subject: [PATCH 19/23] Update content/docs/command-reference/remote/modify.md --- content/docs/command-reference/remote/modify.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/command-reference/remote/modify.md b/content/docs/command-reference/remote/modify.md index a8f4603e5f..d485437dd0 100644 --- a/content/docs/command-reference/remote/modify.md +++ b/content/docs/command-reference/remote/modify.md @@ -639,7 +639,7 @@ more information. > `token`. - `ask_password` - ask each time for the password to use for `user/password` - authentication. + authentication. This has no effect if `password` or `token` are set. ```dvc $ dvc remote modify myremote ask_password true From 99c7b8d33ec731e5b804986cdcb5afe4944e9870 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Thu, 6 Aug 2020 18:36:57 -0500 Subject: [PATCH 20/23] Update content/docs/command-reference/remote/modify.md --- content/docs/command-reference/remote/modify.md | 8 -------- 1 file changed, 8 deletions(-) diff --git a/content/docs/command-reference/remote/modify.md b/content/docs/command-reference/remote/modify.md index d485437dd0..9df7d4816b 100644 --- a/content/docs/command-reference/remote/modify.md +++ b/content/docs/command-reference/remote/modify.md @@ -645,14 +645,6 @@ more information. $ 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. - - > Note that `token` authentication does not require a `password`. If `token` - > is specified, `ask_password` is ignored and DVC will not prompt the user to - > enter a password for this remote. - - `cert_path` - path to certificate used for WebDAV server authentication, if you need to use local client side certificates. From 0dbbb2795d310a3ff0c18e0fc4ee244d89ead573 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Thu, 6 Aug 2020 18:39:42 -0500 Subject: [PATCH 21/23] Update content/docs/command-reference/remote/modify.md --- content/docs/command-reference/remote/modify.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/content/docs/command-reference/remote/modify.md b/content/docs/command-reference/remote/modify.md index 9df7d4816b..928a71f6e8 100644 --- a/content/docs/command-reference/remote/modify.md +++ b/content/docs/command-reference/remote/modify.md @@ -652,15 +652,15 @@ more information. $ dvc remote modify myremote cert_path /path/to/cert ``` -- `key_path` - path to private key to use to access a remote. +- `key_path` - path to private key to use to access a remote. Only has an + effect in combination with `cert_path`. ```dvc $ dvc remote modify myremote key_path /path/to/key ``` - > Note that the `key_path` option is only valid in combination with - > `cert_path` option. However, the certificate might already contain the - > private key. + > Note that the certificate in `cert_path` might already contain the private + > key. - `timeout` - connection timeout (in seconds) for WebDAV server (default: 30). From 08f888fa7bfb93ece61ec28b474d7df1d0fed568 Mon Sep 17 00:00:00 2001 From: Jorge Orpinel Date: Thu, 6 Aug 2020 18:42:15 -0500 Subject: [PATCH 22/23] Update content/docs/command-reference/remote/modify.md --- content/docs/command-reference/remote/modify.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/command-reference/remote/modify.md b/content/docs/command-reference/remote/modify.md index 928a71f6e8..015a2a4437 100644 --- a/content/docs/command-reference/remote/modify.md +++ b/content/docs/command-reference/remote/modify.md @@ -608,7 +608,7 @@ more information. `user/password` authentication. ```dvc - $ dvc remote modify --local myremote token 'mytoken' + $ dvc remote modify --local myremote token '' ``` - `user` - username for WebDAV server, can be empty in case of using `token` From c90081115fc1b9c401ba67b7ebb0d2e5c67bb247 Mon Sep 17 00:00:00 2001 From: "Restyled.io" Date: Thu, 6 Aug 2020 23:42:55 +0000 Subject: [PATCH 23/23] Restyled by prettier --- content/docs/command-reference/remote/modify.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/docs/command-reference/remote/modify.md b/content/docs/command-reference/remote/modify.md index 015a2a4437..8e70e295c2 100644 --- a/content/docs/command-reference/remote/modify.md +++ b/content/docs/command-reference/remote/modify.md @@ -652,8 +652,8 @@ more information. $ dvc remote modify myremote cert_path /path/to/cert ``` -- `key_path` - path to private key to use to access a remote. Only has an - effect in combination with `cert_path`. +- `key_path` - path to private key to use to access a remote. Only has an effect + in combination with `cert_path`. ```dvc $ dvc remote modify myremote key_path /path/to/key