Skip to content

Commit af7fdba

Browse files
committed
Update README.md
Add configuration information
1 parent eaef6e3 commit af7fdba

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ Note that [RStudio Server Pro](https://rstudio.com/products/rstudio-server-pro)
1111

1212
This extension used to proxy Shiny server as well, however that functionality has been [separated](https://github.com/ryanlovett/jupyter-shiny-proxy).
1313

14+
15+
1416
## Installation
1517

1618
### Pre-reqs
@@ -40,3 +42,12 @@ conda install -c conda-forge jupyter-rsession-proxy
4042
### Multiuser Considerations
4143

4244
This extension launches an rstudio server process from the jupyter notebook server. This is fine in JupyterHub deployments where user servers are containerized since other users cannot connect to the rstudio server port. In non-containerized JupyterHub deployments, for example on multiuser systems running LocalSpawner or BatchSpawner, this not secure. Any user may connect to rstudio server and run arbitrary code.
45+
46+
## Configuration with Environment Variables
47+
The following behavior can be configured with environment variables
48+
49+
| Environment Variable | Effect | Default Value | Notes
50+
| RSERVER_FRAME_ORIGIN | The value of the `www-frame-origin` flag to rserver | `same` | |
51+
| RSERVER_TIMEOUT | Idle timeout flag to rserver in minutes | 15 | must be numeric and positive |
52+
| RSESSION_TIMEOUT | Idle timeout flag to rsession in minutes | 15 | must be numeric and positive |
53+
| NB_USER | Name of the Notebook user | `getuser.getpass()` ||

0 commit comments

Comments
 (0)