Skip to content

Commit

Permalink
Document the domains rig uses in the README
Browse files Browse the repository at this point in the history
[ci skip]
  • Loading branch information
gaborcsardi committed Feb 22, 2025
1 parent c4e1661 commit 3401517
Show file tree
Hide file tree
Showing 2 changed files with 62 additions and 0 deletions.
32 changes: 32 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -508,6 +508,38 @@ How is rig different from RSwitch?
> and the RSwitch app together, or you can also use both menu bar apps
> at the same time.
</details>
<details>
<summary>
Which domains does rig download files from?
</summary>

> Here is the list of domains that you need to enable in your proxy.
> Note that some of these, in particular the GitHub ones, might trigger
> redirects.
>
> - <https://api.r-hub.io/rversions> for resolving R versions, i.e. this
> is needed for `rig install`, `rig available`, etc.
> - `rig install` downloads pak from <https://r-lib.github.io/p/pak>
> unless requested otherwise.
> - `rig install` sets <https://cloud.r-project.org> as the default CRAN
> mirror, unless requested otherwise.
> - `rig install` sets <https://packagemanager.posit.co> as the Posit
> Package Manager CRAN mirror on supported Linux systems, unless
> requested otherwise.
> - `rig install` downloads the EPEL package from
> <https://dl.fedoraproject.org/pub/epel> on RHEL systems.
> - `rig system rtools` downloads Rtools from the following URLs on
> Windows:
> - <https://github.com/r-hub/rtools44/releases>,
> - <https://github.com/r-hub/rtools43/releases>,
> - <https://github.com/r-hub/rtools42/releases>,
> - <https://cloud.r-project.org/bin/windows/Rtools>
> - <https://github.com/R-macos/gcc-darwin-arm64/releases>,
> <https://github.com/fxcoudert/gfortran-for-macOS/releases> and
> whatever domains Homebrew is using, to download system packages for
> `rig sysreqs` on macOS.
</details>

## 📘   License <a id="id-license">
Expand Down
30 changes: 30 additions & 0 deletions tools/faq.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -92,3 +92,33 @@
> app together, or you can also use both menu bar apps at the same time.
>
</details>
<details>
<summary>Which domains does rig download files from?</summary>
>
> Here is the list of domains that you need to enable in your proxy.
> Note that some of these, in particular the GitHub ones, might
> trigger redirects.
>
> - https://api.r-hub.io/rversions for resolving R versions, i.e. this is
> needed for `rig install`, `rig available`, etc.
> - `rig install` downloads pak from https://r-lib.github.io/p/pak
> unless requested otherwise.
> - `rig install` sets https://cloud.r-project.org as the default CRAN
> mirror, unless requested otherwise.
> - `rig install` sets https://packagemanager.posit.co as the Posit
> Package Manager CRAN mirror on supported Linux systems, unless
> requested otherwise.
> - `rig install` downloads the EPEL package from
> https://dl.fedoraproject.org/pub/epel on RHEL systems.
> - `rig system rtools` downloads Rtools from the following URLs on
> Windows:
> * https://github.com/r-hub/rtools44/releases,
> * https://github.com/r-hub/rtools43/releases,
> * https://github.com/r-hub/rtools42/releases,
> * https://cloud.r-project.org/bin/windows/Rtools
> - https://github.com/R-macos/gcc-darwin-arm64/releases,
> https://github.com/fxcoudert/gfortran-for-macOS/releases and whatever
> domains Homebrew is using, to download system packages for
> `rig sysreqs` on macOS.
</details>

0 comments on commit 3401517

Please sign in to comment.