Skip to content

Commit e3c76f6

Browse files
committed
doc: update README with attention note
`folder` URI param needs to be a path to an IDEA project that was already opened in the IDE. Or it should not be provided at all otherwise the remote IDE won't start.
1 parent 5bac965 commit e3c76f6

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,11 @@ If `ide_product_code` and `ide_build_number` is missing, Toolbox will only open
101101
page. Coder Toolbox will attempt to start the workspace if it’s not already running; however, for the most reliable
102102
experience, it’s recommended to ensure the workspace is running prior to initiating the connection.
103103

104+
> ⚠️ Note: `folder` should point to a remote IDEA project that has already been opened and appears in the `Projects` tab.
105+
> If the path refers to a project that doesn't exist, the remote IDE won’t start or load it.
106+
107+
> Until [TBX-14952](https://youtrack.jetbrains.com/issue/TBX-14952/) is fixed, it's best to either use a path to a previously opened project or leave it empty.
108+
104109
## Configuring and Testing workspace polling with HTTP & SOCKS5 Proxy
105110

106111
This section explains how to set up a local proxy (without authentication which is not yet supported) and verify that

0 commit comments

Comments
 (0)