-
Notifications
You must be signed in to change notification settings - Fork 394
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
cmd: add parameters for configuration of WebDAV remotes #1617
Merged
+103
−0
Merged
Changes from all commits
Commits
Show all changes
22 commits
Select commit
Hold shift + click to select a range
a00dd30
cmd: add parameters for configuration of WebDAV remotes
9864d50
Update content/docs/command-reference/remote/modify.md
jorgeorpinel 6d7eeeb
cmd: add token authentication example to remote modify for WebDAV
127d00e
Update content/docs/command-reference/remote/modify.md
jorgeorpinel feb10a0
Update content/docs/command-reference/remote/modify.md
jorgeorpinel 49e894d
Update content/docs/command-reference/remote/modify.md
jorgeorpinel 4fa3d8b
Update content/docs/command-reference/remote/modify.md
jorgeorpinel 8f0836c
Update content/docs/command-reference/remote/modify.md
iksnagreb b449189
Update modify.md
iksnagreb 84b76dc
Update content/docs/command-reference/remote/modify.md
jorgeorpinel e70cd5b
Update content/docs/command-reference/remote/add.md
iksnagreb b76cec5
cmd: add explanation of WebDAV API location to 'remote add' command
b413b0e
cmd: clarify user/password, token and ask_password relation for WebDAV
iksnagreb 2f72006
cmd: add ' quotes to token as it might contain special characters
iksnagreb d870b34
cmd: move 'user' order explanation after the example as suggested
iksnagreb 31bccb5
cmd: add more explanation to WebDAV certificates parameters
iksnagreb 098fe82
cmd: add 'url' parameter explanations to 'remote' modify for WebDAV
iksnagreb 5eca211
Update content/docs/command-reference/remote/modify.md
jorgeorpinel 5d3b9ec
Update content/docs/command-reference/remote/modify.md
jorgeorpinel 99c7b8d
Update content/docs/command-reference/remote/modify.md
jorgeorpinel 0dbbb27
Update content/docs/command-reference/remote/modify.md
jorgeorpinel 08f888f
Update content/docs/command-reference/remote/modify.md
jorgeorpinel File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
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 |
---|---|---|
|
@@ -582,6 +582,94 @@ more information. | |
|
||
</details> | ||
|
||
<details> | ||
|
||
### 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. | ||
jorgeorpinel marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
```dvc | ||
$ dvc remote modify --local myremote token '<mytoken>' | ||
``` | ||
|
||
- `user` - username for WebDAV server, can be empty in case of using `token` | ||
authentication. | ||
|
||
```dvc | ||
$ dvc remote modify --local myremote user myuser | ||
``` | ||
|
||
The order in which DVC searches for username is: | ||
|
||
1. `user` parameter set with this command (found in `.dvc/config`); | ||
2. User defined in the URL (e.g. `webdav://[email protected]/path`) | ||
|
||
- `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. | ||
|
||
> 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. This has no effect if `password` or `token` are set. | ||
|
||
```dvc | ||
$ dvc remote modify myremote ask_password true | ||
``` | ||
|
||
- `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 | ||
``` | ||
|
||
- `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 certificate in `cert_path` might already contain the private | ||
> key. | ||
|
||
- `timeout` - connection timeout (in seconds) for WebDAV server (default: 30). | ||
|
||
```dvc | ||
$ dvc remote modify myremote timeout 120 | ||
``` | ||
|
||
</details> | ||
|
||
## Example: Customize an S3 remote | ||
|
||
Let's first set up a _default_ S3 remote. | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
We just realized that PHP is kind of a weird example to have (see #1695 (review)).
We'll be reviewing these sample URLs in #1706, in case you're interested @iksnagreb 🙂