Path prefix does not work as expected with RStudio server and Traefik #388

rlaiola · 2022-03-14T22:41:05Z

What is this issue about?

Some users have reported difficulties to setup RStudio server with Traefik reverse proxy using a path prefix (e.g., www.example.com/rstudio). The reference discussions are linked below:

The problem occurs because not only Traefik, but also Rstudio server must be configured accordingly.

How to test it?

1. Basic example: does NOT work

docker-compose.yml

version: "3.3"

services:

  traefik:
    image: "traefik:v2.6"
    container_name: "traefik"
    command:
      #- "--log.level=DEBUG"
      - "--api.insecure=true"
      - "--providers.docker=true"
      - "--providers.docker.exposedbydefault=false"
      - "--entrypoints.web.address=:80"
    ports:
      - "80:80"
      - "8080:8080"
    volumes:
      - "/var/run/docker.sock:/var/run/docker.sock:ro"

  # RStudio server
  rstudio:
    image: "rocker/rstudio:latest"
    # IMPORTANT: this name MUST be used in traefik's routers service
    container_name: "rstudio-server"
    restart: "unless-stopped"
    environment:
      - PASSWORD=rstudio
    labels:
      - "traefik.enable=true"
      - "traefik.http.routers.rstudio-server.rule=Host(`localhost`) && PathPrefix(`/rstudio`)"
      - "traefik.http.routers.rstudio-server.entrypoints=web"
      - "traefik.http.services.rstudio-server.loadbalancer.server.port=8787"

Open a Terminal window (e.g., Bash) and run the following command:
docker-compose up -d
Open a Web browser window and visit the URL http://localhost/rstudio. The login screen will not be rendered as expected.
To stop it:
docker-compose down

2. Stripping prefix (Traefik): still does NOT work

docker-compose.yml

version: "3.3"

services:

  traefik:
    image: "traefik:v2.6"
    container_name: "traefik"
    command:
      #- "--log.level=DEBUG"
      - "--api.insecure=true"
      - "--providers.docker=true"
      - "--providers.docker.exposedbydefault=false"
      - "--entrypoints.web.address=:80"
    ports:
      - "80:80"
      - "8080:8080"
    volumes:
      - "/var/run/docker.sock:/var/run/docker.sock:ro"

  # RStudio server
  rstudio:
    image: "rocker/rstudio:latest"
    # IMPORTANT: this name MUST be used in traefik's routers service
    container_name: "rstudio-server"
    restart: "unless-stopped"
    environment:
      - PASSWORD=rstudio
    labels:
      - "traefik.enable=true"
      - "traefik.http.routers.rstudio-server.rule=Host(`localhost`) && PathPrefix(`/rstudio`)"
      - "traefik.http.routers.rstudio-server.entrypoints=web"
      - "traefik.http.middlewares.rstudio-server-path-strip.stripprefix.prefixes=/rstudio"
      - "traefik.http.middlewares.rstudio-server-path-strip.stripprefix.forceSlash=false"
      - "traefik.http.routers.rstudio-server.middlewares=rstudio-server-path-strip"
      - "traefik.http.services.rstudio-server.loadbalancer.server.port=8787"

Open a Terminal window and run the following command:
docker-compose up -d
Open a Web browser window and visit the URL http://localhost/rstudio. Although Rstudio server manages to find the entry path, the login screen is not rendered as expected (it cannot find resources).
To stop it:
docker-compose down

How to fix it?

The problem occurs because RStudio server does not know what path it is being served from. One can find all RStudio Server Configuration here. In order to fix this issue it is necessary to set the www Setting www-root-path in /etc/rstudio/rserver.conf to match the proxy prefix (e.g., /rstudio).

wwwsettings.sh

#!/usr/bin/with-contenv bash

## RStudio Server Configuration
## https://docs.rstudio.com/ide/server-pro/latest/rstudio-server-configuration.html

## www Settings

# www-root-path: The path prefix added by a proxy to the incoming RStudio URL. 
# This setting is used so RStudio Server knows what path it is being served
# from. If running RStudio Server behind a path-modifying proxy, this should
# be changed to match the base RStudio Server URL.
if [ -n "$WWW_ROOT_PATH" ]; then
  # echo "www-root-path=$WWW_ROOT_PATH"
  echo "www-root-path=$WWW_ROOT_PATH" >> /etc/rstudio/rserver.conf
fi

docker-compose.yml (NOTE: /home/dev/wwwsettings.sh is an absolute path on the host machine and must be modified accordingly)

version: "3.3"

services:

  traefik:
    image: "traefik:v2.6"
    container_name: "traefik"
    command:
      #- "--log.level=DEBUG"
      - "--api.insecure=true"
      - "--providers.docker=true"
      - "--providers.docker.exposedbydefault=false"
      - "--entrypoints.web.address=:80"
    ports:
      - "80:80"
      - "8080:8080"
    volumes:
      - "/var/run/docker.sock:/var/run/docker.sock:ro"

  # RStudio server
  rstudio:
    image: "rocker/rstudio:latest"
    # IMPORTANT: this name MUST be used in traefik's routers service
    container_name: "rstudio-server"
    restart: "unless-stopped"
    environment:
      - PASSWORD=rstudio
      # Set the path prefix added by Traefik to the incoming RStudio URL.
      # https://docs.rstudio.com/ide/server-pro/latest/rstudio-server-configuration.html
      - WWW_ROOT_PATH=/rstudio
    volumes:
      - "/home/dev/wwwsettings.sh:/etc/cont-init.d/wwwsettings"
    labels:
      - "traefik.enable=true"
      - "traefik.http.routers.rstudio-server.rule=Host(`localhost`) && PathPrefix(`/rstudio`)"
      - "traefik.http.routers.rstudio-server.entrypoints=web"
      - "traefik.http.middlewares.rstudio-server-path-strip.stripprefix.prefixes=/rstudio"
      - "traefik.http.middlewares.rstudio-server-path-strip.stripprefix.forceSlash=false"
      - "traefik.http.routers.rstudio-server.middlewares=rstudio-server-path-strip"
      - "traefik.http.services.rstudio-server.loadbalancer.server.port=8787"

Open a Terminal window and run the following command:
docker-compose up -d
Open a Web browser window, visit the URL http://localhost/rstudio and voilà!
To stop it:
docker-compose down

To allow the deployment of RStudio Server on a self-service container service delivery platform (e.g., Portainer) with no need to mount a volume I'd suggest to place the content of wwwsettings.sh in rocker-versioned2/scripts/init_set_env.sh (or in rocker-versioned2/scripts/init_userconf.sh).

rocker-versioned2/scripts/init_set_env.sh

Lines 1 to 14 in 83651a7

    
           #!/usr/bin/with-contenv bash 
        
           # shellcheck shell=bash 
        
           ## Set our dynamic variables in Renviron.site to be reflected by RStudio Server or Shiny Server 
        
           exclude_vars="HOME PASSWORD RSTUDIO_VERSION" 
        
           for file in /var/run/s6/container_environment/* 
        
           do 
        
             sed -i "/^${file##*/}=/d" ${R_HOME}/etc/Renviron.site 
        
             regex="(^| )${file##*/}($| )" 
        
             [[ ! $exclude_vars =~ $regex ]] && echo "${file##*/}=$(cat $file)" >> ${R_HOME}/etc/Renviron.site || echo "skipping $file" 
        
           done 
        
           ## only file-owner (root) should read container_environment files: 
        
           chmod 600 /var/run/s6/container_environment/*

In the future, it may be relevant to expose other RStudio server configuration settings/properties. Just let me know in case I should send the proposed solution as a pull request.

Cheers!

The text was updated successfully, but these errors were encountered:

eitsupi · 2022-04-02T08:42:32Z

The ability to change the base URL with an environment variable is common in Docker images and makes sense.
It would be better to add a new init script specifically for this purpose rather than adding it to an existing init script (init_env or init_userconf).

saepire · 2022-11-06T04:31:04Z

I believe this can be solved entirely without rstudio configuration but externally by a reverse proxy. I stumbled onto this while doing something similar and you can use the X-RStudio-Root-Path header to inform rstudio where it is being served from. No need to bother with the environment root prefix variable. I'm using caddy and adding that header to a reverse proxy looks like this:

header_up X-RStudio-Root-Path /rstudio

You can make the path deeper if you like in the same manner. One important note, if you route to rstudio under a prefix, e.g. /rstudio inside a cluster or a nested reverse proxy, DO strip such prefix /rstudio with traefik so that rstudio receives requests at root /.

rlaiola · 2022-12-21T17:46:09Z

I believe this can be solved entirely without rstudio configuration but externally by a reverse proxy. I stumbled onto this while doing something similar and you can use the X-RStudio-Root-Path header to inform rstudio where it is being served from. No need to bother with the environment root prefix variable. I'm using caddy and adding that header to a reverse proxy looks like this:
header_up X-RStudio-Root-Path /rstudio
You can make the path deeper if you like in the same manner. One important note, if you route to rstudio under a prefix, e.g. /rstudio inside a cluster or a nested reverse proxy, DO strip such prefix /rstudio with traefik so that rstudio receives requests at root /.

@saepire I did what you recommended and managed to get it working with the latest image. No further changes needed! The docker-composer.yml script follows:

version: "3.3"

services:

  traefik:
    image: "traefik:v2.6"
    container_name: "traefik"
    command:
      #- "--log.level=DEBUG"
      - "--api.insecure=true"
      - "--providers.docker=true"
      - "--providers.docker.exposedbydefault=false"
      - "--entrypoints.web.address=:80"
    ports:
      - "80:80"
      - "8080:8080"
    volumes:
      - "/var/run/docker.sock:/var/run/docker.sock:ro"

  # RStudio server
  rstudio:
    image: "rocker/rstudio:latest"
    # IMPORTANT: this name MUST be used in traefik's routers service
    container_name: "rstudio-server"
    restart: "unless-stopped"
    environment:
      - PASSWORD=rstudio
    labels:
      - "traefik.enable=true"
      - "traefik.http.routers.rstudio-server.rule=Host(`localhost`) && PathPrefix(`/rstudio`)"
      - "traefik.http.routers.rstudio-server.entrypoints=web"
      - "traefik.http.middlewares.rstudio-server-path-strip.stripprefix.prefixes=/rstudio"
      - "traefik.http.middlewares.rstudio-server-path-strip.stripprefix.forceSlash=false"
      - "traefik.http.middlewares.rstudio-server-root-path-header.headers.customrequestheaders.X-RStudio-Root-Path=/rstudio"
      - "traefik.http.routers.rstudio-server.middlewares=rstudio-server-root-path-header,rstudio-server-path-strip"
      - "traefik.http.services.rstudio-server.loadbalancer.server.port=8787"

Open a Terminal window and run the following command (considering the docker-compose.yml is in the same folder):
docker-compose up -d
Open a Web browser window and visit the URL http://localhost/rstudio. The login screen is presented as expected.
To stop it, run:
docker-compose down

Cheers!

echuber2 · 2024-01-23T08:12:20Z

The ability to change the base URL with an environment variable is common in Docker images and makes sense. It would be better to add a new init script specifically for this purpose rather than adding it to an existing init script (init_env or init_userconf).

@eitsupi Was this feature added later (to change the base URL through configuration)? I see the documentation still describes setting up a reverse proxy with Caddy for this purpose.

eitsupi · 2024-01-23T12:01:00Z

Was this feature added later (to change the base URL through configuration)?

I don't think so.
Contributions are welcome!

cboettig · 2024-04-21T18:57:08Z

https://z2jh.jupyter.org/en/stable/ is another common and well-documented way to run Rocker-based images with rstudio on any kubernetes system

eitsupi added the enhancement New feature or request label Apr 2, 2022

eitsupi mentioned this issue Jun 27, 2022

Multiple rstudio images running under Caddy #496

Closed

eitsupi added the help wanted Extra attention is needed label Nov 6, 2022

rlaiola closed this as completed Dec 21, 2022

hexylena mentioned this issue Oct 6, 2023

Updated path-based interactive tools with entry point path injection, support for ITs with relative links, shortened URLs, doc and config updates including Podman job_conf galaxyproject/galaxy#16795

Merged

2 tasks

perllaghu mentioned this issue Jan 29, 2024

Running RStudio behind an nginx proxy in a kubrenetes cluster #757

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Path prefix does not work as expected with RStudio server and Traefik #388

Path prefix does not work as expected with RStudio server and Traefik #388

rlaiola commented Mar 14, 2022 •

edited by eitsupi

eitsupi commented Apr 2, 2022

saepire commented Nov 6, 2022

rlaiola commented Dec 21, 2022

echuber2 commented Jan 23, 2024

eitsupi commented Jan 23, 2024

cboettig commented Apr 21, 2024

Path prefix does not work as expected with RStudio server and Traefik #388

Path prefix does not work as expected with RStudio server and Traefik #388

Comments

rlaiola commented Mar 14, 2022 • edited by eitsupi

What is this issue about?

How to test it?

1. Basic example: does NOT work

2. Stripping prefix (Traefik): still does NOT work

How to fix it?

eitsupi commented Apr 2, 2022

saepire commented Nov 6, 2022

rlaiola commented Dec 21, 2022

echuber2 commented Jan 23, 2024

eitsupi commented Jan 23, 2024

cboettig commented Apr 21, 2024

rlaiola commented Mar 14, 2022 •

edited by eitsupi