Skip to content

chore(docs): add WebRDP to restructure docs #14385

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 4 commits into from
Aug 21, 2024
Merged

chore(docs): add WebRDP to restructure docs #14385

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5b2a31f
started module tutorial
stirby Aug 15, 2024
75301f9
finished webrdp addition
stirby Aug 21, 2024
5c94f87
remove unused workspace access file
stirby Aug 21, 2024
ffffdb2
Merge branch 'restructure' into web-rdp-docs
stirby Aug 21, 2024
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
remove unused workspace access file
  • Loading branch information
@stirby
stirby committed Aug 21, 2024
commit 5c94f8765a157c6c58ce746ec01c25a1ea856261
13 changes: 7 additions & 6 deletions docs/admin/networking/workspace-proxies.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@ Workspace proxies provide low-latency experiences for geo-distributed teams.

Coder's networking does a best effort to make direct connections to a workspace.
In situations where this is not possible, such as connections via the web
terminal and [web IDEs](../../user-guides/workspace-access/README.md#web-ides), workspace proxies are able to
reduce the amount of distance the network traffic needs to travel.
terminal and [web IDEs](../../user-guides/workspace-access/README.md#web-ides),
workspace proxies are able to reduce the amount of distance the network traffic
needs to travel.

A workspace proxy is a relay connection a developer can choose to use when
connecting with their workspace over SSH, a workspace app, port forwarding, etc.
Expand All @@ -26,8 +27,8 @@ Workspace proxies can be used in the browser by navigating to the user

## Requirements

- The [Coder CLI](../../reference/cli/README.md) must be installed and authenticated as a user with
the Owner role.
- The [Coder CLI](../../reference/cli/README.md) must be installed and
authenticated as a user with the Owner role.

## Step 1: Create the proxy

Expand Down Expand Up @@ -149,8 +150,8 @@ coder wsproxy server

### Running as a system service

If you've installed Coder via a [system package](../../install/README.md), you can
configure the workspace proxy by settings in
If you've installed Coder via a [system package](../../install/README.md), you
can configure the workspace proxy by settings in
`/etc/coder.d/coder-workspace-proxy.env`

To run workspace proxy as a system service on the host:
Expand Down
12 changes: 0 additions & 12 deletions docs/user-guides/workspace-access.md
View file
Open in desktop

This file was deleted.

5 changes: 3 additions & 2 deletions docs/user-guides/workspace-access/remote-desktops.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,10 @@ or use your favorite RDP client to connect to `localhost:3399`.

> Note: Default username is `Administrator` and password is `coderRDP!`.


## RDP Web

Our WebRDP module in the Coder Registry adds a one-click button to open an RDP session in the browser. This requires just a few lines of Terraform in your template, see the documentation on our registry for setup.
Our WebRDP module in the Coder Registry adds a one-click button to open an RDP
session in the browser. This requires just a few lines of Terraform in your
template, see the documentation on our registry for setup.
Comment on lines +59 to +61
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@stirby On a 2nd thought, I think this should be in admin/templates/extending-templates as a user may not know what terraform is and how the template works.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or maybe it's fine. We can link to a page in admin/templates/ on how to do this.


![Web RDP Module in a Workspace](../../images/user-guides/web-rdp-demo.png)
Loading