Skip to content

chore: minor edits to recently merged docs updates #915

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 21, 2022
Merged

chore: minor edits to recently merged docs updates #915

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2ed5b80
chore: edit docs re: configuring multiple JetBrains IDEs
Mar 21, 2022
db0b7cc
chore: edit configure doc update
Mar 21, 2022
8018af6
Update workspaces/editors.md
Mar 21, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
221 changes: 221 additions & 0 deletions guides/customization/multiple-jetbrains-ides.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,221 @@
---
title: "Multiple JetBrains instances configuration"
description: Learn how to run multiple instances of JetBrains IDEs in Coder.
---

This article walks you through the process of configuring Coder to support the
use of multiple instances of the same JetBrains IDE.

![Multiple IntelliJ icons in a
workspace](../../assets/workspaces/multi-intellij-icons-smaller.png)

You will:

1. Create and build the custom image
1. Write the configure script
1. Write the `config.yaml` file needed to utilize Coder's [workspace
applications] feature to surface additional JetBrains IDE instances in your
browser

This article shows you how to configure multiple instances of IntelliJ IDEA
Ultimate, but you can use this process for any JetBrains IDEs.

> Using additional JetBrains IDEs consume extra workspace compute resources, so
> ensure that you've allocated enough resources to your workspace to support all
> of your IDE instances.

1. Build a custom image that installs the primary JetBrains IDE and copies the
configure script, `.profile` script, and `config.yaml` file to the image:

```Dockerfile
FROM codercom/enterprise-java:ubuntu

USER root

# Install IntelliJ IDEA Ultimate
RUN mkdir -p /opt/idea
RUN curl -L \
"https://download.jetbrains.com/product?code=IU&latest&distribution=linux" \
| tar -C /opt/idea --strip-components 1 -xzvf -

# Create a symbolic link in PATH that points to the Intellij startup script.
RUN ln -s /opt/idea/bin/idea.sh /usr/bin/intellij-idea-ultimate

# bash .profile so projector can be added to the path
COPY [".profile", "/coder/.profile"]

# configure script
COPY ["configure", "/coder/configure"]
RUN chmod +x /coder/configure

# copy custom apps info (config.yaml)
COPY ["./coder", "/coder"]

# Set back to coder user
USER coder
```

1. Add the JetBrains Projector CLI to the workspace's PATH (in this example,
`.profile` is located in the Coder directory within the directory that
contains the image's Dockerfile:

```console
export PATH=$PATH:$HOME/.local/bin
```

1. Create the configure script that installs the Projector CLI into
`/home/coder` and uses the CLI to install additional JetBrains IDEs. Each IDE
configuration has a different directory in `/home/coder/.projector/configs`.
In this example, the configure script is in the directory that contains the
image's Dockerfile:

> Each additional IDE requires a unique port number.

```console
# install projector into /home/coder/ pvc
pip3 install projector-installer --user

# put projector CLI into path
cp /coder/.profile $HOME
source $HOME/.profile

# autoinstall intellij version specifying config name and port
$HOME/.local/bin/projector --accept-license

PROJECTOR_CONFIG_PATH=$HOME/.projector/configs/IntelliJ_2

if [ -d $PROJECTOR_CONFIG_PATH ]; then
echo 'projector has already been configured - skip step'
else
$HOME/.local/bin/projector ide autoinstall --config-name IntelliJ_2 \
--ide-name "IntelliJ IDEA Ultimate 2021.3.2" --port 8997 \
--use-separate-config
$HOME/.local/bin/projector ide autoinstall --config-name IntelliJ_3 \
--ide-name "IntelliJ IDEA Ultimate 2021.3.2" --port 8998 \
--use-separate-config
$HOME/.local/bin/projector ide autoinstall --config-name IntelliJ_4 \
--ide-name "IntelliJ IDEA Ultimate 2021.3.2" --port 8999 \
--use-separate-config
fi
```

1. Create the `config.yaml` file used by
[workspace applications](../../workspaces/applications.md) to surface icons
for each additional JetBrains IDE in the workspace. The configuration uses
the JetBrains icon included with the initial JetBrains IDE installed.

In this example, `config.yaml` is located in a `coder/apps` directory within
the directory that contains the image Dockerfile.

> Each workspace application name must be unique so that Projector can point
> to the correct config directory.

```yaml
# /coder/apps/config.yaml
apps:
# Name of application in launcher. Name may consist of alphanumeric
# characters, dashes, underscores. Names must begin with an alphanumeric
# character. Names must be unique per application. Required.
- name: IntelliJ IDEA Ultimate 2
# Application scheme - must be http or https. Required.
scheme: http
# Application port. Required.
port: 8997
# Host of the application to use when dialing. Defaults to localhost.
# Optional.
host: "localhost"
# Working directory for the start command. Required.
working-directory: /home/coder
# File path to icon used in application launcher. Icons should be either
# PNG, SVG, or JPG. Required.
icon-path: /opt/idea/bin/idea.svg
# Command to start the application. Required.
command: /home/coder/.projector/configs/IntelliJ_2/run.sh
# Array of arguments for command. Optional.
args: [""]
# Health checks to get running application status. Can use exec or http
# health checks to localhost. Optional, but we recommend specifying a
# health check. If you don't supply one, then an http request is sent to
# the application root path "/".
health-check:
http:
# Scheme must be "http" or "https". If not specified it inherits
# the application scheme. Optional.
scheme: "http"
# The host to use when dialing the address. If not specified it
# inherits the application host. Optional.
host: "localhost"
# Port to use when dialing the application. If not specified it
# inherits the application port. Optional.
port: 8997
- name: IntelliJ IDEA Ultimate 3
# Application scheme - must be http or https. Required.
scheme: http
# Application port. Required.
port: 8998
# Host of the application to use when dialing. Defaults to localhost.
# Optional.
host: "localhost"
# Working directory for the start command. Required.
working-directory: /home/coder
# File path to icon used in application launcher. Icons should be either
# PNG, SVG, or JPG. Required.
icon-path: /opt/idea/bin/idea.svg
# Command to start the application. Required.
command: /home/coder/.projector/configs/IntelliJ_3/run.sh
# Array of arguments for command. Optional.
args: [""]
# Health checks to get running application status. Can use exec or http
# health checks to localhost. Optional, but we recommend specifying a
# health check. If you don't supply one, then an http request is sent to
# the application root path "/".
health-check:
http:
# Scheme must be "http" or "https". If not specified it inherits
# the application scheme. Optional.
scheme: "http"
# The host to use when dialing the address. If not specified it
# inherits the application host. Optional.
host: "localhost"
# Port to use when dialing the application. If not specified it
# inherits the application port. Optional.
port: 8998
- name: IntelliJ IDEA Ultimate 4
# Application scheme - must be http or https. Required.
scheme: http
# Application port. Required.
port: 8999
# Host of the application to use when dialing. Defaults to localhost.
# Optional.
host: "localhost"
# Working directory for the start command. Required.
working-directory: /home/coder
# File path to icon used in application launcher. Icons should be either
# PNG, SVG, or JPG. Required.
icon-path: /opt/idea/bin/idea.svg
# Command to start the application. Required.
command: /home/coder/.projector/configs/IntelliJ_4/run.sh
# Array of arguments for command. Optional.
args: [""]
# Health checks to get running application status. Can use exec or http
# health checks to localhost. Optional, but we recommend specifying a
# health check. If you don't supply one, then an http request is sent to
# the application root path "/".
health-check:
http:
# Scheme must be "http" or "https". If not specified it inherits
# the application scheme. Optional.
scheme: "http"
# The host to use when dialing the address. If not specified it
# inherits the application host. Optional.
host: "localhost"
# Port to use when dialing the application. If not specified it
# inherits the application port. Optional.
port: 8999
```

> See Projector's CLI documentation for additional information on
> [installation](https://github.com/JetBrains/projector-installer#Installation)
> and the
> [CLI commands](https://github.com/JetBrains/projector-installer/blob/master/COMMANDS.md)
> it accepts.
6 changes: 3 additions & 3 deletions images/configure.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,15 +46,15 @@ file shows how you can clone a repo at build time:
#!/bin/bash
if [ ! -d "/home/coder/workspace/project" ]
then
ssh-keyscan -t rsa <your git provider endpoint> >> ~/.ssh/known_hosts
ssh-keyscan -t rsa <yourGitProviderEndpoint> >> ~/.ssh/known_hosts
git clone git://company.com/project.git /home/coder/workspace/project
else
echo "Project has already been cloned."
fi
```

> Change the git provider endpoint in the ```ssh-keyscan``` command. e.g.,
> ```github.com``` ```bitbucket.org``` ```gitlab.com```
> Ensure that you change the `<yourGitProviderEndpoint>` placeholder in the
> `ssh-keyscan` command (e.g., `github.com`, `bitbucket.org`, `gitlab.com`).

Note that the instructions provided include `if-else` logic on whether the
instructions should be re-run (and when) or if Coder should run the instructions
Expand Down
3 changes: 3 additions & 0 deletions manifest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -434,6 +434,9 @@
{
"path": "./guides/customization/macos-keybinding.md"
},
{
"path": "./guides/customization/multiple-jetbrains-ides.md"
},
{
"path": "./guides/customization/node.md"
},
Expand Down
31 changes: 15 additions & 16 deletions workspaces/editors.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -291,27 +291,26 @@ participants. If they do, click **Accept** to proceed.
At this point, you'll be able to share your project and work with your partner
in real-time.

## Muliple Instances of the same JetBrains IDE
## Multiple instances of a JetBrains IDE

Some JetBrains users like to have multiple projects open when coding which
requires multiple JetBrains IDEs open at the same time. When using JetBrains in
a browser, this requires additional configuration steps.

### Multiple JetBrains in a browser

To the user, they will use the default JetBrains IDE that Coder detects in the
custom image, and one or more additional JetBrains IDEs will also appear in the
workspace dashboard.
If you'd like to have multiple projects open, you'll need to have multiple
JetBrains IDEs open in Coder simultaneously. The following steps show you how to
configure Coder to enable this behavior.

![Multiple IntelliJ icons in a workspace](../assets/workspaces/multi-intellij-icons-smaller.png)

The configuration requires installing the JetBrains Projector CLI with a
configure script and a custom image. The configure script installs the Projector
CLI then uses it to install as many additional IDE instances you require.
Coder's [Workspace Applications](./applications.md) feature then surfaces the
additional IDE icons in the workspace.
Running multiple instances of the same JetBrains IDE requires you to create a
custom image and configure script to install the JetBrains Projector CLI using a
custom image and [configure](../images/configure.md) script.

The configure script will install JetBrains Projector, then use the Projector
CLI to install as many additional IDE instances as you need. Coder's
[workspace applications](./applications.md) feature surfaces the additional IDE
icons in the workspace.

[Steps to configure additional JetBrains IDEs in a browser](./multi-jetbrains-in-browser.md)
We have provided
[detailed configuration steps](../guides/customization/multiple-jetbrains-ides.md)
for setting up your custom image and configure script.

## RStudio

Expand Down
Loading