repo_auth: Authenticated repositories

In r-lib/pkgcache: Cache 'CRAN'-Like Metadata and R Packages

Authenticated repositories

Description

pkgcache supports HTTP basic authentication when interacting with CRAN-like repositories. To use authentication, include a username in the repo URL:

https://<username>@<repo-host>/<repo-path>

Usage

repo_auth(
  r_version = getRversion(),
  bioc = TRUE,
  cran_mirror = default_cran_mirror(),
  check_credentials = TRUE
)

Arguments

r_version	R version(s) to use for the Bioconductor repositories, if bioc is TRUE.
bioc	Whether to add Bioconductor repositories, even if they are not configured in the repos option.
cran_mirror	The CRAN mirror to use, see default_cran_mirror().
check_credentials	Whether to check that credentials are available for authenticated repositories.

Details

pkgcache will look up password for this url and username from the the user's .netrc file and from the system credential store using the keyring package. For the URL above it tries the following keyring keys, in this order:

https://<username>@repo-host/<repo-path>
https://repo-host/<repo-path>
https://<username>@repo-host
https://repo-host

To add an authenticated repository use repo_add() with the username argument. Alternatively, you can set the repos option directly using base::options() and including the username in the repository URL.

repo_auth() lists authentication information for all configured repositories.

Value

Data frame with columns:

• all columns from the output of repo_get(),

• auth_domains: authentication domains. pkgcache tries to find the credentials for these domains, until the search is successful or all domains fail.

• auth_domain: if the credential lookup is successful, then this is the authentication domain that was used to get the credentials.

• auth_source: where the credentials were found. E.g. ⁠keyring:<backend>⁠ means it was in the default macos keyring.

• auth_error: for failed credential searches this is the description of why the search failed. E.g. maybe the keyring package is not installed, or pkgcache found no credentials for any of the authentication domains.

r-lib/pkgcache documentation built on March 1, 2025, 5:52 a.m.