Skip to content

Latest commit

 

History

History
155 lines (121 loc) · 5.37 KB

README.md

File metadata and controls

155 lines (121 loc) · 5.37 KB
Raw

RStudio Pro Products Docker Images

Docker images for RStudio Professional Products

IMPORTANT: There are a few things you need to know before using these images:

  1. This image may introduce BREAKING changes; as such we recommend:
    • Avoid using the {operating-system} tags to avoid unexpected version changes, and
    • Always read through the NEWS.md file in the appropriate sub-folder to understand the changes before updating.
  2. Outdated images will be removed periodically from DockerHub as product version updates are made. Please make plans to update at times or use your own build of the images.
  3. These images are meant as a starting point for your needs. Consider creating a fork of this repo, where you can continue to merge in changes we make while having your own security scanning, base OS in use, or other custom changes. We provide instructions for building for these cases.

Images

Professional Products

Supporting Images

Preview Images

IMPORTANT: Do not use these images. They are in preparation for a future release

Image Hierarchy And Relationship

  • solid line / arrow: image inheritance
  • dashed line: images related to one another by usage
flowchart TB;
  subgraph s1["Connect"];
    id1("Connect Image")
    id2("Connect Content Init")
    id1-.-id2
  end;
  subgraph Package Manager;
    id3("Package Manager Image")
  end;
  subgraph Product Base Images;
    id4("Product Base")
    id5("Product Base Pro")
    id4-->id5
  end
  subgraph Workbench;
    id6("Workbench Image")
    id7("r-session-complete")
    id5-->id6
    id5-->id7
    id6-.-id7
  end
  subgraph s5["Content Images"];
    id8("Content Base")
    id9("Content Pro")
    id8-->id9
  end
  s1-.-s5
Loading

RStudio Team

We provide a docker-compose.yml that could help to spin up default configurations for RStudio Team (all RStudio products together).

If you are using this locally you need to setup some hostnames to point to localhost in order for some integrations to work fine in your browser. In your /etc/hosts add one line:

127.0.0.1 rstudio-workbench rstudio-connect rstudio-pm

# Replace this with valid licenses
export RSW_LICENSE=XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX
export RSC_LICENSE=XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX
export RSPM_LICENSE=XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX

docker-compose up

Privileged Containers

As of July 2022, only the RStudio Connect container uses the --privileged flag for user and code isolation and security and all other images can be run unprivileged. Please see RStudio Professional Product Root & Privileged Requirements for more information.

If you have feedback on any of our professional products, please always feel free to reach out on RStudio Community, to your Customer Success representative, or to [email protected].

Instructions for building

After you have cloned rstudio-docker-products, you can create your own containers fairly simply with the provided Justfiles. If you're unfamiliar with just, please check out their documentation. If you are unable to use just in your organization, most targets in each Justfile can be copy/pasted into your shell and ran there with variables replaced where appropriate.

To build RStudio Workbench:

just workbench/build

To build RStudio Connect:

just connect/build

To build RStudio Package Manager:

just package-manager/build

You can alter what exactly is built by changing workbench/Dockerfile.$OS, connect/Dockerfile.$OS, and package-manager/Dockerfile.$OS.

You can then run what you've built to test out with the run commands. For instance, to run the workbench container you have built:

just workbench/run

Note you must have a license in place, and all other instructions in separate sections are still relevant.

If you have created an image you want to use yourself, you can push to your own image repository system. The images are named rstudio-workbench, rstudio-connect, and rstudio-package-manager.

Licensing

The license associated with the RStudio Docker Products repository is located in LICENSE.md.

As is the case with all container images, the images themselves also contain other software which may be under other licenses (i.e. bash, linux, system libraries, etc., along with any other direct or indirect dependencies of the primary software being contained).

It is an image user's responsibility to ensure that use of this image (and any of its dependent layers) complies with all relevant licenses for the software contained in the image.