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:

SSH access

Workshop sets up SSH access to workshops on its own. It configures the OpenSSH client on your local machine and maintains a certificate authority that signs an SSH host certificate for every workshop’s SSH server and a user certificate authenticating you as the workshop user. Connecting to a workshop by its hostname needs no key management, passwords, or host-key prompts.

Launch the workshop

Launch the workshop if it isn’t already running:

$ workshop launch

Then find the workshop hostname:

$ workshop info

name:      dev
base:      ubuntu@24.04
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:

Reference: