Access Workspaces

On this page

There are many ways to connect to your workspace, the options are only limited by the template configuration.

Deployment operators can learn more about different types of workspace connections and performance in our networking docs.

You can see the primary methods of connecting to your workspace in the workspace dashboard.

Workspace View

Terminal

The terminal is implicitly enabled in Coder and allows you to access your workspace through the shell environment set by your template.

Terminal Access

SSH

Through with the CLI

Coder will use the optimal path for an SSH connection (determined by your deployment's networking configuration) when using the CLI:

coder ssh my-workspace

Or, you can configure plain SSH on your client below.

Configure SSH

Coder generates SSH key pairs for each user to simplify the setup process.

Before proceeding, run coder login <accessURL> if you haven't already to authenticate the CLI with the web UI and your workspaces.

To access Coder via SSH, run the following in the terminal:

coder config-ssh

Run coder config-ssh --dry-run if you'd like to see the changes that will be made before proceeding.

Confirm that you want to continue by typing yes and pressing enter. If successful, you'll see the following message:

You should now be able to ssh into your workspace.
For example, try running:

$ ssh coder.<workspaceName>

Your workspace is now accessible via ssh coder.<workspace_name> (e.g., ssh coder.myEnv if your workspace is named myEnv).

Visual Studio Code

You can develop in your Coder workspace remotely with VSCode. We support connecting with the desktop client and VSCode in the browser with code-server.

Read more details on using VSCode in your workspace.

JetBrains IDEs

We support JetBrains IDEs using Gateway. The following IDEs are supported for remote development:

IntelliJ IDEA
CLion
GoLand
PyCharm
Rider
RubyMine
WebStorm
JetBrains Fleet

Read our docs on JetBrains Gateway for more information on connecting your JetBrains IDEs.

code-server

code-server is our supported method of running VS Code in the web browser. You can read more in our documentation for code-server.

code-server in a workspace

Other Web IDEs

We support a variety of other browser IDEs and tools to interact with your workspace. Each of these can be configured by your template admin using our Web IDE guides.

Supported IDEs:

VS Code Web
JupyterLab
RStudio
Airflow
File Browser

Our Module Registry also hosts a variety of tools for extending the capability of your workspace. If you have a request for a new IDE or tool, please file an issue in our Modules repo.

Ports and Port forwarding

You can manage listening ports on your workspace page through with the listening ports window in the dashboard. These ports are often used to run internal services or preview environments.

You can also share ports with other users, or port-forward through the CLI with coder port forward. Read more in the docs on workspace ports.

Open Ports window

Remote Desktops

Coder also supports connecting with an RDP solution, see our RDP guide for details.