Skip to content

chore: update SSH doc #993

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 2 commits into from
May 19, 2022
Merged

chore: update SSH doc #993

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8f8a3bc
update SSH doc
May 18, 2022
b600589
chore: fix instructions based on review
May 19, 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
47 changes: 25 additions & 22 deletions workspaces/ssh.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,15 @@ Before accessing your workspace via SSH:

## Configuration

You can access your workspaces via SSH by configuring your local machine as
follows:
To access your servers via SSH, run the following using the Coder CLI:

```console
$ coder config-ssh
coder config-ssh
```

You should see the following returned:

```console
An auto-generated ssh config was written to "/Users/yourName/.ssh/config"
Your private ssh key was written to "/Users/yourName/.ssh/coder_enterprise"
You should now be able to ssh into your workspace
Expand All @@ -30,6 +33,25 @@ For example, try running
Your workspace is now accessible via `ssh coder.<workspace_name>` (e.g.,
`ssh coder.myEnv` if your workspace is named `myEnv`).

### SSH port forwarding

To start an SSH port forwarding session:

```console
ssh -L [localport]:localhost:[remoteport] coder.[workspace]
```

| Parameter | Description |
| ------------ | -------------------------------------------------------------- |
| `localport` | The port to use on your local machine (e.g., `localhost:3000`) |
| `remoteport` | The port of the server you want to access in the workspace |

> You can use either HTTP or HTTPS, though the latter may result in
> certificate-related errors.

At this point, you can access the server in the browser using the `localport`
value.

## Reconfiguration

You will need to rerun the `coder config-ssh` command if:
Expand All @@ -54,22 +76,3 @@ workspace:
```console
rsync -e "coder ssh" -a --progress ~/. my-env:~
```

## Forwarding dev URLs

To access your server via SSH port forwarding:

1. [Create a dev URL](devurls.md)
1. Run `coder config-ssh` using the Coder CLI

Once done, you can configure the dev URL port using:

```console
ssh -L [localport]:localhost:[remoteport] coder.[workspace]
```

`localport` is the port you want to use on your local machine (e.g.,
`localhost:3000`), and `remoteport` matches the `port` of your dev URL.

After SSH port forwarding is configured, you can access the dev URL (e.g.,
`http://localhost:3000`) in a browser.