Skip to content

fix: improve formatting in Gateway docs #8949

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

fix: improve formatting in Gateway docs #8949

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
31b9f45
fix: image formatting for gateway docs
bpmct Aug 7, 2023
77ed4aa
chore: fix some more spots
bpmct Aug 7, 2023
cea47f2
more
bpmct Aug 7, 2023
9213765
Merge branch 'main' into fix-ide-format
bpmct Aug 7, 2023
2f23e63
fmt
bpmct Aug 7, 2023
2ea6fde
space things out more
bpmct Aug 7, 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
54 changes: 45 additions & 9 deletions docs/ides/gateway.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,26 @@ manually setting up an SSH connection.
Gateway home screen
1. Click "Connect to Coder" at the top of the Gateway home screen to launch the
plugin

![Gateway Connect to Coder](../images/gateway/plugin-connect-to-coder.png)

1. Enter your Coder deployment's Access Url and click "Connect" then paste the Session Token and click "OK"

![Gateway Session Token](../images/gateway/plugin-session-token.png)

1. Click the "+" icon to open a browser and go to the templates page in your
Coder deployment to create a workspace

1. If a workspace already exists but is stopped, click the green arrow to start
the workspace

1. Once the workspace status says Running, click "Select IDE and Project"

![Gateway IDE List](../images/gateway/plugin-select-ide.png)

1. Select the JetBrains IDE for your project and the project directory then
click "Start IDE and connect" ![Gateway Select IDE](../images/gateway/plugin-ide-list.png)

![Gateway IDE Opened](../images/gateway/gateway-intellij-opened.png)

> Note the JetBrains IDE is remotely installed into
Expand All @@ -39,8 +48,11 @@ manually setting up an SSH connection.

1. Click the gear icon at the bottom left of the Gateway home screen and then
"Settings"

1. In the Marketplace tab within Plugins, type Coder and if a newer plugin
release is available, click "Update" and "OK" ![Gateway Settings and Marketplace](../images/gateway/plugin-settings-marketplace.png)
release is available, click "Update" and "OK"

![Gateway Settings and Marketplace](../images/gateway/plugin-settings-marketplace.png)

### Configuring the Gateway plugin to use internal certificates

Expand Down Expand Up @@ -97,32 +109,56 @@ keytool -import -alias coder -file cacert.pem -keystore /Applications/JetBrains\
> these steps.

1. [Install Gateway](https://www.jetbrains.com/help/idea/jetbrains-gateway.html)

1. [Configure the `coder` CLI](../ides.md#ssh-configuration)

1. Open Gateway, make sure "SSH" is selected under "Remote Development"
1. Click "New Connection" ![Gateway Home](../images/gateway/gateway-home.png)

1. Click "New Connection"

![Gateway Home](../images/gateway/gateway-home.png)

1. In the resulting dialog, click the gear icon to the right of "Connection:"

![Gateway New Connection](../images/gateway/gateway-new-connection.png)
1. Hit the "+" button to add a new SSH connection ![Gateway Add
Connection](../images/gateway/gateway-add-ssh-configuration.png)

1. Hit the "+" button to add a new SSH connection

![Gateway Add Connection](../images/gateway/gateway-add-ssh-configuration.png)

1. For the Host, enter `coder.<workspace name>`

1. For the Port, enter `22` (this is ignored by Coder)

1. For the Username, enter your workspace username

1. For the Authentication Type, select "OpenSSH config and authentication agent"

1. Make sure the checkbox for "Parse config file ~/.ssh/config" is checked.

1. Click "Test Connection" to validate these settings.
1. Click "OK" ![Gateway SSH
Configuration](../images/gateway/gateway-create-ssh-configuration.png)

1. Click "OK"

![Gateway SSH Configuration](../images/gateway/gateway-create-ssh-configuration.png)

1. Select the connection you just added
![Gateway Welcome](../images/gateway/gateway-welcome.png)

![Gateway Welcome](../images/gaGteway/gateway-welcome.png)

1. Click "Check Connection and Continue"

![Gateway Continue](../images/gateway/gateway-continue.png)
1. Select the JetBrains IDE for your project and the project directory. SSH into
your server to create a directory or check out code if you haven't already.

1. Select the JetBrains IDE for your project and the project directory. SSH into your server to create a directory or check out code if you haven't already.

![Gateway Choose IDE](../images/gateway/gateway-choose-ide.png)

> Note the JetBrains IDE is remotely installed into `~/.
cache/JetBrains/RemoteDev/dist`

1. Click "Download and Start IDE" to connect.

![Gateway IDE Opened](../images/gateway/gateway-intellij-opened.png)

## Using an existing JetBrains installation in the workspace
Expand Down