HTTP
Start with dvc remote add
to define the remote:
$ dvc remote add -d myremote https://example.com/path
Configuration parameters
If any values given to the parameters below contain sensitive user info, add
them with the --local
option, so they're written to a Git-ignored config file.
-
url
- remote location:$ dvc remote modify myremote url https://example.com/path
The URL can include a query string, which will be preserved (e.g.
example.com?loc=path%2Fto%2Fdir
) -
auth
- authentication method to use when accessing the remote. The accepted values are:basic
- basic authentication scheme.user
andpassword
(orask_password
) parameters should also be configured.digest
(removed in 2.7.1) - digest Access Authentication Scheme.user
andpassword
(orask_password
) parameters should also be configured.custom
- an additional HTTP header field will be set for all HTTP requests to the remote in the form:custom_auth_header: password
.custom_auth_header
andpassword
(orask_password
) parameters should also be configured.
$ dvc remote modify myremote auth basic
-
method
- override the HTTP method to use for file uploads (e.g.PUT
should be used for Artifactory). By default,POST
is used.$ dvc remote modify myremote method PUT
-
custom_auth_header
- HTTP header field name to use when theauth
parameter is set tocustom
.$ dvc remote modify --local myremote \ custom_auth_header 'My-Header'
-
user
- user name to use when theauth
parameter is set tobasic
.$ dvc remote modify --local myremote user myuser
The order in which DVC picks the user name:
user
parameter set with this command (found in.dvc/config
);- User defined in the URL (e.g.
http://user@example.com/path
);
-
password
- password to use for anyauth
method.$ dvc remote modify --local myremote password mypassword
-
ask_password
- ask each time for the password to use for anyauth
method.$ dvc remote modify myremote ask_password true
Note that the
password
parameter takes precedence overask_password
. Ifpassword
is specified, DVC will not prompt the user to enter a password for this remote. -
ssl_verify
- whether or not to verify SSL certificates, or a path to a custom CA bundle to do so (true
by default).$ dvc remote modify myremote ssl_verify false # or $ dvc remote modify myremote ssl_verify path/to/ca_bundle.pem
-
read_timeout
- set the time in seconds till a timeout exception is thrown when attempting to read a portion of data from a connection (60 by default). Let's set it to 5 minutes for example:$ dvc remote modify myremote read_timeout 300
-
connect_timeout
- set the time in seconds till a timeout exception is thrown when attempting to make a connection (60 by default). Let's set it to 5 minutes for example:$ dvc remote modify myremote connect_timeout 300