diff --git a/docs/ides/remote-desktops.md b/docs/ides/remote-desktops.md new file mode 100644 index 0000000000..f9379f1f6f --- /dev/null +++ b/docs/ides/remote-desktops.md @@ -0,0 +1,24 @@ +# Remote Desktops + +> Built-in remote desktop is on the roadmap ([#2106](https://github.com/coder/coder/issues/2106)). + +## VNC Desktop + +The common way to use remote desktops with Coder is through VNC. + +![VNC Desktop in Coder](../images/vnc-desktop.png) + +Workspace requirements: + +- VNC server (e.g. [tigervnc](https://tigervnc.org/)) +- VNC client (e.g. [novnc](https://novnc.com/info.html)) + +Installation instructions vary depending on your workspace's operating +system, platform, and build system. + +As a starting point, see the [desktop-container](https://github.com/bpmct/coder-templates/tree/main/desktop-container) community template. It builds and provisions a Dockerized workspace with the following software: + +- Ubuntu 20.04 +- TigerVNC server +- noVNC client +- XFCE Desktop diff --git a/docs/ides/web-ides.md b/docs/ides/web-ides.md index 058e6130d4..35d6552755 100644 --- a/docs/ides/web-ides.md +++ b/docs/ides/web-ides.md @@ -80,28 +80,6 @@ resource "coder_app" "code-server" { If the code-server integrated terminal fails to load, (i.e., xterm fails to load), go to DevTools to ensure xterm is loaded, clear your browser cache and refresh. -## VNC Desktop - -![VNC Desktop in Coder](../images/vnc-desktop.png) - -You may want a full desktop environment to develop with/preview specialized software. - -Workspace requirements: - -- VNC server (e.g. [tigervnc](https://tigervnc.org/)) -- VNC client (e.g. [novnc](https://novnc.com/info.html)) - -Installation instructions will vary depending on your workspace's operating system, platform, and build system. - -> Coder-provided VNC clients are on the roadmap ([#2106](https://github.com/coder/coder/issues/2106)). - -As a starting point, see the [desktop-container](https://github.com/bpmct/coder-templates/tree/main/desktop-container) community template. It builds & provisions a Dockerized workspace with the following software: - -- Ubuntu 20.04 -- TigerVNC server -- noVNC client -- XFCE Desktop - ## JetBrains Projector [JetBrains Projector](https://jetbrains.github.io/projector-client/mkdocs/latest/) is a JetBrains Incubator project which renders JetBrains IDEs in the web browser. diff --git a/docs/manifest.json b/docs/manifest.json index dd8bb93bd2..0a79c66852 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -102,6 +102,11 @@ "title": "Emacs", "description": "Learn how to configure Emacs with TRAMP in Coder", "path": "./ides/emacs-tramp.md" + }, + { + "title": "Remote Desktops", + "description": "Learn how to use Remote Desktops with Coder", + "path": "./ides/remote-desktops.md" } ] },