How to use JetBrains Gateway with Workshop

Use workshops← Connect VS Code|JupyterLab in browser →

JetBrains Gateway allows you to connect to remote development environments while using your favorite JetBrains IDEs (IntelliJ IDEA, PyCharm, and so on). A workshop can serve as the remote development target for JetBrains Gateway, letting you use your favorite JetBrains IDEs against Workshop.

Prerequisites

Before starting, ensure you have these requirements satisfied:

• JetBrains Gateway installed on your host system.

Configure SSH access

Workshop generates an OpenSSH configuration for connecting to launched workshops. When using the Workshop snap, include that generated configuration in your host user’s ~/.ssh/config file. Replace <UID> with your host user ID, which you can find with id -u:

~/.ssh/config

Include /var/snap/workshop/current/ssh/<UID>/config

Launch the workshop

Launch the workshop if it isn’t already running:

$ workshop launch

Then find the workshop hostname:

$ workshop info

name:      dev
base:      [email protected]
project:   ~/my-project
hostname:  dev.my-project.wp
...

Use the hostname from the workshop info output when configuring JetBrains Gateway.

Connect with Gateway

1. Open JetBrains Gateway.

2. Create a new SSH connection using these values:

   • Username: workshop

   • Host: The hostname from workshop info, for example dev.my-project.wp

   • Port: 22

3. Click Check connection and Continue.

4. At Choose IDE and Project, select your preferred JetBrains IDE version, e.g. PyCharm.

   For Project directory, enter /project/.

5. Click Download IDE and Connect, then wait for the IDE to install and launch; this may take a few minutes. After the IDE starts, log in and proceed as usual.

Your JetBrains IDE will now run remotely in the workshop while providing a native desktop experience.

See also

Explanation:

• Workshop definition

Reference:

• workshop info

• workshop launch