Skip to content
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

Restyle cmd: add parameters for configuration of WebDAV remotes #1659

Closed
wants to merge 10 commits into from
12 changes: 12 additions & 0 deletions content/docs/command-reference/remote/add.md
Original file line number Diff line number Diff line change
Expand Up @@ -344,6 +344,18 @@ $ dvc remote add -d myremote https://example.com/path/to/dir

<details>

### 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.

</details>

<details>

### Click for local remote

A "local remote" is a directory in the machine's file system.
Expand Down
64 changes: 64 additions & 0 deletions content/docs/command-reference/remote/modify.md
Original file line number Diff line number Diff line change
Expand Up @@ -582,6 +582,70 @@ more information.

</details>

<details>

### 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://[email protected]/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
```

</details>

## Example: Customize an S3 remote

Let's first set up a _default_ S3 remote.
Expand Down