Skip to content

docs: add jetbrains offline mode config steps #9388

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 12 commits into from
Aug 29, 2023
Merged

docs: add jetbrains offline mode config steps #9388

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
0f2f539
docs: add offline gateway configuration steps
ericpaulsen Aug 28, 2023
5c1392b
Merge branch 'main' into jetbrains-offline-mode
ericpaulsen Aug 28, 2023
5911805
grammar
ericpaulsen Aug 28, 2023
0737be0
make: fmt & grammar
ericpaulsen Aug 28, 2023
b18f6d2
Revert "make: fmt & grammar"
ericpaulsen Aug 28, 2023
d1d7dab
fix: grammar
ericpaulsen Aug 28, 2023
aa602e4
add: multi platforms syntax
ericpaulsen Aug 29, 2023
181c7f5
Merge branch 'main' into jetbrains-offline-mode
ericpaulsen Aug 29, 2023
4cb306d
add: client-side files
ericpaulsen Aug 29, 2023
cdf578c
Merge branch 'main' into jetbrains-offline-mode
ericpaulsen Aug 29, 2023
48021a1
make: fmt
ericpaulsen Aug 29, 2023
e1d153f
add: client file contexts
ericpaulsen Aug 29, 2023
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
Prev Previous commit
Next Next commit
Revert "make: fmt & grammar" 
This reverts commit 0737be0.
  • Loading branch information
@ericpaulsen
ericpaulsen committed Aug 28, 2023
commit b18f6d2742c26f36102fade6003845e53ffbf5f3
43 changes: 19 additions & 24 deletions docs/ides/gateway.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,13 +191,13 @@ see the

### Configuration Steps

The Coder team built a POC of the JetBrains Gateway Offline Mode solution. Here
are the steps we took (and "gotchas"):
The Coder team built a POC of the JetBrains Gateway Offline Mode solution. Here are
the steps we took (and "gotchas"):

### 1. Deploy the server and install the Client Downloader

We deployed a simple Ubuntu VM and installed the JetBrains Client Downloader
binary. Note that the server must be a Linux-based distribution.
We deployed a simple Ubuntu VM and installed the JetBrains Client Downloader binary. Note
that the server must be a Linux-based distribution.

```shell
wget https://download.jetbrains.com/idea/code-with-me/backend/jetbrains-clients-downloader-linux-x86_64-1867.tar.gz && \
Expand All @@ -206,12 +206,11 @@ tar -xzvf jetbrains-clients-downloader-linux-x86_64-1867.tar.gz

### 2. Install backends and clients

JetBrains Gateway requires both a backend to be installed on the remote host
(your Coder workspace) and a client to be installed on your local machine. You
can host both on the server in this example.
JetBrains Gateway requires both a backend to be installed on the remote host (your Coder workspace)
and a client to be installed on your local machine. You can host both on the server
in this example.

See here for the full
[JetBrains product list and builds](https://data.services.jetbrains.com/products).
See here for the full [JetBrains product list and builds](https://data.services.jetbrains.com/products).
Below is the full list of supported `--platforms-filter` values:

```console
Expand All @@ -234,13 +233,12 @@ This is the same command as above, with the `--download-backends` flag removed.
./jetbrains-clients-downloader-linux-x86_64-1867/bin4/jetbrains-clients-downloader --products-filter <product-code> --build-filter <build-number> --platforms-filter linux-x64 ~/clients
```

We now have both clients and backends installed.
We now have both clients and backends installed in

### 3. Install a web server

You will need to run a web server in order to serve requests to the backend and
client files. We installed `nginx` and setup an FQDN and routed all requests to
`/`. See below:
You will need to run a web server in order to serve requests to the backend and client
files. We installed `nginx` and setup an FQDN and routed all requests to `/`. See below:

```console
server {
Expand All @@ -260,22 +258,19 @@ server {
```

Then, configure your DNS entry to point to the IP address of the server. For the
purposes of the POC, we did not configure TLS, although that is a supported
option.
purposes of the POC, we did not configure TLS, although that is a supported option.

### 4. Setup SSH connection with JetBrains Gateway

With the server now configured, you can now configure your local machine to use
Gateway. Here is the documentation to
[setup SSH config via the Coder CLI](../ides.md#ssh-configuration). On the
Gateway side, follow our guide here until step 16.
Gateway. Here is the documentation to [setup SSH config via the Coder CLI](../ides.md#ssh-configuration).
On the Gateway side, follow our guide here until step 16.

Instead of downloading from jetbrains.com, we will point Gateway to our server
endpoint. Select `Installation options...` and select `Use download link`. Note
that the URL must explicitly reference the archive file:
Instead of downloading from jetbrains.com, we will point Gateway to our server endpoint.
Select `Installation options...` and select `Use download link`. Note that the URL
must explicitly reference the archive file:

![Offline Gateway](../images/gateway/offline-gateway.png)

Click `Download IDE and Connect`. Gateway should now download the backend and
clients from the server into your remote workspace and local machine,
respectively.
Click `Download IDE and Connect`. Gateway should now download the backend and clients
from the server into your remote workspace and local machine, respectively.
Loading