Skip to content

Latest commit

 

History

History
129 lines (94 loc) · 3.95 KB

README.md

File metadata and controls

129 lines (94 loc) · 3.95 KB
Raw

RStudio Server (rstudio-server)

Installs the RStudio Server, enables to run the RStudio IDE on the browser.

Example Usage

"features": {
    "ghcr.io/rocker-org/devcontainer-features/rstudio-server:0": {}
}

Options

Options Id Description Type Default Value
version Select version of the RStudio Server, if not stable. string stable
allowReinstall Reinstall in case RStudio Server is already installed. boolean false
singleUser If true, configures as the single user mode. boolean true

Supported platforms

linux/amd64 and linux/arm64 platform ubuntu:focal, ubuntu:jammy and ubuntu:noble.

linux/arm64 platform supports are currently experimental and only available on daily builds for testing purposes. (rstudio/rstudio#13340)

Start RStudio Server

To run RStudio Server, the rserver command should be executed.

If we want to run RStudio Server automatically, for example, we can set the rserver command to postAttachCommand as follows.

Since rserver uses the 8787 port by default, "forwardPorts": [8787] is also configured here. And, set the portsAttributes property to clarify what the port is used for.

{
    "image": "mcr.microsoft.com/devcontainers/base:ubuntu",
    "features": {
        "ghcr.io/rocker-org/devcontainer-features/rstudio-server": {}
    },
    "postAttachCommand": {
        "rstudio-start": "rserver"
    },
    "forwardPorts": [
        8787
    ],
    "portsAttributes": {
        "8787": {
            "label": "RStudio IDE"
        }
    }
}

RStudio's initial working directory

This Feature sets onCreateCommand to the Docker image, and the onCreateCommand sets initial_working_directory to the rstudio-prefs.json file (A file containing RStudio preferences) immediately after container creation.

If rstudio-prefs.json already exists when the container is created, the jq command must be installed to update rstudio-prefs.json.

For example, we can install jq with the ghcr.io/rocker-org/devcontainer-features/apt-packages Feature as follows:

"features": {
    "ghcr.io/rocker-org/devcontainer-features/apt-packages:1": {
        "packages": "jq"
    },
    "ghcr.io/rocker-org/devcontainer-features/rstudio-server": {}
}

Available versions

"stable" and "daily" refer to the latest stable and daily builds via the redirect links.

You can also specify a version number, like "2023.03", "2023.03.2+454". This pattern matches the highest numbered tag of https://github.com/rstudio/rstudio.

R installation

If the R command is not available while this Feature's installation process, r-base will be installed via apt.

ghcr.io/rocker-org/devcontainer-features/r-apt and ghcr.io/rocker-org/devcontainer-features/r-rig are configured to be installed earlier than this Feature, so R can be installed first with these Features.

For example:

{
    "image": "mcr.microsoft.com/devcontainers/base:ubuntu",
    "features": {
        "ghcr.io/rocker-org/devcontainer-features/rstudio-server": {},
        "ghcr.io/rocker-org/devcontainer-features/r-apt": {}
    }
}

Of course, there is no additional R installation when selecting an image that already has R installed.

{
    "image": "ghcr.io/rocker-org/devcontainer/r-ver:4",
    "features": {
        "ghcr.io/rocker-org/devcontainer-features/rstudio-server": {}
    }
}

References

Note: This file was auto-generated from the devcontainer-feature.json. Add additional notes to a NOTES.md.