Skip to content

Commit 91a6cd4

Browse files
committed
Add docs on RStudio and Codespaces known issues
1 parent 530400a commit 91a6cd4

3 files changed

Lines changed: 48 additions & 0 deletions

File tree

‎docs/getting-started/how-to/troubleshoot-common-codespaces-issues/index.md‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,3 +95,51 @@ For older images like `python:v1` or `jupyter:v1`:
9595
* Retain the references to the older action images, and use [`opensafely exec`](../../../opensafely-cli.md#exec-interactive-development) for interactive development using these action images' environments
9696

9797
For the more recently released `r:v2` and `r:v3` images, until we have support for its version of R and libraries natively in codespaces, you can follow the instructions for [manually running an alternative instance of Rstudio in codespaces](../use-github-codespaces-in-your-project/index.md#rstudio-with-the-rv2-or-rv3-images) (recommended)
98+
99+
## Known issues with opening RStudio in a Codespace
100+
101+
We are currently investigating an issue that can prevent RStudio from opening correctly when using it inside a GitHub Codespace.
102+
103+
Until this is resolved, you can use either of the following workarounds.
104+
105+
### Option 1: Launch RStudio from the terminal
106+
107+
1. Open the terminal in your Codespace
108+
1. Run: `opensafely launch rstudio`
109+
1. Wait for the command to start, then stop it with <kbd>Ctrl</kbd>+<kbd>C</kbd>
110+
1. Run the same command again: `opensafely launch rstudio`
111+
1. When the **Open in Browser** notification appears, click it
112+
113+
![](./rstudio-double-launch.png)
114+
115+
RStudio should then open in a new browser tab.
116+
117+
### Option 2: Reopen the RStudio port
118+
119+
1. Open a Codespace for your repository
120+
1. Open the **Ports tab** and wait for the RStudio port to show as available
121+
1. Click **Open in Browser** for the RStudio port
122+
123+
![](./rstudio-browser.png)
124+
125+
The first attempt may open a new tab that remains on a GitHub Codespaces authentication page, for example:
126+
127+
`https://github.com/codespaces/auth/...`
128+
129+
If this happens:
130+
131+
1. Close the tab
132+
1. Click **Open in Browser** for the RStudio port again
133+
1. Repeat this if necessary
134+
135+
You may briefly be redirected to:
136+
137+
`https://localhost:8787/auth-sign-in?appUri=%2F`
138+
139+
Continue closing the tab and reopening the RStudio port until `https://localhost:8787` loads successfully.
140+
141+
After it has loaded once, subsequent attempts to open the RStudio port should open RStudio normally.
142+
143+
### If you are still unable to open RStudio
144+
145+
If neither workaround works, [contact tech-support in Slack](https://docs.opensafely.org/how-to-get-help/#slack) with any relevant error messages or screenshots so that we can investigate further.
22.6 KB
Loading
47.9 KB
Loading

0 commit comments

Comments
 (0)