add: rstudio module #327

mtojek · 2025-08-13T14:59:15Z

Description

This PR brings RStudio Server module. Since full RStudio distribution is hard to install in a consistent, stable way (lib versions, deps, etc.), this module bases on Docker distribution - Rocker.

Type of Change

Module Information

Path: registry/coder/modules/rstudio
New version: v0.9.0
Breaking change: [ ] Yes [ ] No

Testing & Validation

module "rstudio-server" {
  count    = data.coder_workspace.me.start_count
  source   = "git::https://github.com/coder/registry.git//registry/coder/modules/rstudio-server?ref=rstudio-module"

  agent_id = coder_agent.main.id
  docker_socket = var.docker_socket

  #disable_auth = false
  project_path = "/home/coder"
  enable_renv = true
}

Tests pass (bun test)
Code formatted (bun run fmt)
Changes tested locally

Copilot

Pull Request Overview

This PR introduces a new RStudio Server module for Coder that deploys RStudio Server using the Rocker Project Docker distribution. The module provides a consistent and stable way to run RStudio Server in Coder workspaces, handling authentication, project mounting, and R environment management with renv support.

Adds Docker-based RStudio Server deployment with configurable authentication and project paths
Implements renv cache volume for dependency persistence and automatic environment restoration
Provides comprehensive Terraform configuration with variables for customization and Coder app integration

Reviewed Changes

Copilot reviewed 3 out of 5 changed files in this pull request and generated 5 comments.

File	Description
registry/coder/modules/rstudio-server/main.tf	Terraform configuration defining variables, script execution, and Coder app setup
registry/coder/modules/rstudio-server/run.sh	Shell script that manages Docker operations, container lifecycle, and renv restoration
registry/coder/modules/rstudio-server/README.md	Documentation with module description and basic usage example

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-08-13T15:07:32Z

registry/coder/modules/rstudio-server/run.sh

+delay=2
+attempt=1
+
+while ! docker ps; do


The docker readiness check only verifies that docker ps succeeds but doesn't handle potential authentication or permission issues. Consider redirecting stderr to /dev/null and adding a more specific check like docker ps > /dev/null 2>&1 to avoid cluttering output with error messages during the retry loop.

Suggested change

while ! docker ps; do

while ! docker ps > /dev/null 2>&1; do

Copilot · 2025-08-13T15:07:33Z

registry/coder/modules/rstudio-server/run.sh

+# Make RENV_CACHE_VOLUME writable to USER
+docker exec rstudio-server bash -c 'chmod -R 0777 /renv/cache'


Setting permissions to 0777 (world-writable) creates a security risk by allowing any user to modify the renv cache. Consider using more restrictive permissions like 0755 or 0775, or setting ownership to the specific user instead.

Suggested change

# Make RENV_CACHE_VOLUME writable to USER

docker exec rstudio-server bash -c 'chmod -R 0777 /renv/cache'

# Make RENV_CACHE_VOLUME owned and writable by USER (not world-writable)

docker exec rstudio-server bash -c 'chown -R "${RSTUDIO_USER}":"${RSTUDIO_USER}" /renv/cache && chmod -R 0775 /renv/cache'

Copilot · 2025-08-13T15:07:33Z

registry/coder/modules/rstudio-server/run.sh

+if [ "${ENABLE_RENV}" = "true" ] && [ -f "${PROJECT_PATH}/renv.lock" ]; then
+  echo "Restoring R environment via renv..."
+  docker exec -u "${RSTUDIO_USER}" rstudio-server R -q -e \
+    'if (!requireNamespace("renv", quietly = TRUE)) install.packages("renv", repos="https://cloud.r-project.org"); renv::restore(prompt = FALSE)'


The R command execution lacks error handling. If the renv::restore() command fails, the script continues without indication of failure. Consider adding error checking or using set -e behavior by checking the exit code of the docker exec command.

Suggested change

'if (!requireNamespace("renv", quietly = TRUE)) install.packages("renv", repos="https://cloud.r-project.org"); renv::restore(prompt = FALSE)'

'if (!requireNamespace("renv", quietly = TRUE)) install.packages("renv", repos="https://cloud.r-project.org"); renv::restore(prompt = FALSE)'

if [ $? -ne 0 ]; then

echo "Error: renv::restore() failed inside the container."

exit 1

fi

Copilot · 2025-08-13T15:07:34Z

registry/coder/modules/rstudio-server/main.tf

+variable "rstudio_password" {
+  type        = string
+  description = "RStudio password"
+  default     = "rstudio"


Using a hardcoded default password 'rstudio' creates a security vulnerability as it's easily guessable. Consider generating a random password by default or requiring users to explicitly set this variable without providing a weak default.

Suggested change

default = "rstudio"

Copilot · 2025-08-13T15:07:34Z

registry/coder/modules/rstudio-server/main.tf

+  display_name = "rstudio-server"
+  icon         = "/icon/rstudio.svg"
+  script = templatefile("${path.module}/run.sh", {
+    DOCKER_HOST : var.docker_socket,


The DOCKER_HOST environment variable is set but never used in the run.sh script. The script uses the default docker commands without specifying a custom socket. Either remove this variable or update the script to use DOCKER_HOST when provided.

Suggested change

DOCKER_HOST : var.docker_socket,

mtojek added 25 commits August 12, 2025 10:55

Initial commit

9218d02

main.tf

5947251

Merge branch 'main' into rstudio-module

9f301d2

rename

acf7325

impl

59b1b60

fix

844efb1

fix

cc4cee5

renv cache

28dda90

fix

a43ed67

fix

ba13e8f

fix

a4cabd7

fix

9ace2c4

fix

5d64bc5

workaround: sleep

32c258b

fix

0d8a6c9

Rstudio image

c831eeb

fix chmod

830bf27

WIP

4632e67

just FIXME

74e3c27

retry

423a0d9

fix

20948a7

bash

b70669d

fix

db8ea05

fix

bcd57fc

fix

8158580

mtojek self-assigned this Aug 13, 2025

fmt

069c2dd

mtojek marked this pull request as ready for review August 13, 2025 15:06

mtojek requested review from Copilot and DevelopmentCats August 13, 2025 15:06

mtojek requested review from matifali and removed request for Copilot August 13, 2025 15:06

Copilot AI reviewed Aug 13, 2025

View reviewed changes

Merge branch 'main' into rstudio-module

976d033

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

add: rstudio module #327

add: rstudio module #327

Uh oh!

mtojek commented Aug 13, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Aug 13, 2025

Uh oh!

Copilot AI Aug 13, 2025

Uh oh!

Copilot AI Aug 13, 2025

Uh oh!

Copilot AI Aug 13, 2025

Uh oh!

Copilot AI Aug 13, 2025

Uh oh!

Uh oh!

		# Make RENV_CACHE_VOLUME writable to USER
		docker exec rstudio-server bash -c 'chmod -R 0777 /renv/cache'

add: rstudio module #327

Are you sure you want to change the base?

add: rstudio module #327

Uh oh!

Conversation

mtojek commented Aug 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Type of Change

Module Information

Testing & Validation

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Aug 13, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 13, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 13, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 13, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 13, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mtojek commented Aug 13, 2025 •

edited

Loading