opensource/coder
3
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2026-09-24 15:04:27 +08:00
Code Issues Packages Projects Releases Wiki Activity

fix: improve formatting in Gateway docs (#8949)

Browse Source 
* fix: image formatting for gateway docs

* chore: fix some more spots

* more

* fmt

* space things out more
This commit is contained in:
Ben Potter
2023-08-07 17:34:41 +00:00
committed by GitHub
parent b67ece1cbc
commit 3b16e7112d
1 changed files with 45 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/ides/gateway.md
+45 -9
View File
@@ -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
@@ -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
@@ -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