From fb3c0b465a0c892dd22afbe1d8ed6c505ab95da2 Mon Sep 17 00:00:00 2001
From: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com>
Date: Tue, 11 Feb 2025 21:21:15 +0000
Subject: [PATCH 1/2] s/vscode/vs code to match theirs
---
docs/user-guides/workspace-access/vscode.md | 14 +++++++-------
1 file changed, 7 insertions(+), 7 deletions(-)
diff --git a/docs/user-guides/workspace-access/vscode.md b/docs/user-guides/workspace-access/vscode.md
index 5f7de223ef81e..5e1abf7243e31 100644
--- a/docs/user-guides/workspace-access/vscode.md
+++ b/docs/user-guides/workspace-access/vscode.md
@@ -1,13 +1,13 @@
# Visual Studio Code
You can develop in your Coder workspace remotely with
-[VSCode](https://code.visualstudio.com/download). We support connecting with the
-desktop client and VSCode in the browser with
+[VS Code](https://code.visualstudio.com/download). We support connecting with the
+desktop client and VS Code in the browser with
[code-server](https://github.com/coder/code-server).
-## VSCode Desktop
+## VS Code Desktop
-VSCode desktop is a default app for workspaces.
+VS Code desktop is a default app for workspaces.
Click `VS Code Desktop` in the dashboard to one-click enter a workspace. This
automatically installs the [Coder Remote](https://github.com/coder/vscode-coder)
@@ -20,9 +20,9 @@ extension, authenticates with Coder, and connects to the workspace.
### Manual Installation
-You can install our extension manually in VSCode using the command palette.
-Launch VS Code Quick Open (Ctrl+P), paste the following command, and press
-enter.
+You can install our extension manually in VS Code using the command palette.
+Launch VS Code Quick Open (Ctrl+P), paste the following command, and press
+enter:
```text
ext install coder.coder-remote
From 9bec4c7a4557926738a9a7d189692039c54de811 Mon Sep 17 00:00:00 2001
From: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com>
Date: Tue, 11 Feb 2025 22:08:55 +0000
Subject: [PATCH 2/2] add air-gapped section and vs code to it
---
docs/admin/air-gapped/index.md | 9 +++++++++
docs/admin/air-gapped/vs-code.md | 13 +++++++++++++
docs/manifest.json | 18 ++++++++++++++++++
3 files changed, 40 insertions(+)
create mode 100644 docs/admin/air-gapped/index.md
create mode 100644 docs/admin/air-gapped/vs-code.md
diff --git a/docs/admin/air-gapped/index.md b/docs/admin/air-gapped/index.md
new file mode 100644
index 0000000000000..40e9ae4500dcc
--- /dev/null
+++ b/docs/admin/air-gapped/index.md
@@ -0,0 +1,9 @@
+# Air-gapped
+
+Coder can be deployed in air-gapped or offline environment.
+
+Use the [air-gapped deployments documentation](../../install/offline.md) for
+deployment considerations and configuration, and use the docs in this section
+for more specific reference and tutorials.
+
+
diff --git a/docs/admin/air-gapped/vs-code.md b/docs/admin/air-gapped/vs-code.md
new file mode 100644
index 0000000000000..64b3cc5e4f320
--- /dev/null
+++ b/docs/admin/air-gapped/vs-code.md
@@ -0,0 +1,13 @@
+# Visual Studio Code in air-gapped environments
+
+Many Coder administrators deploy Coder in [air-gapped environments](../../install/offline.md) where the server or workspaces do not have network access to external websites such as `registry.terraform.com` or `code.visualstudio.com`.
+
+## Allow network access to the VS Code Extension Marketplace
+
+If some network access is allowed, you can allow users access to `code.visualstudio.com`.
+
+When they connect to a workspace with VS Code Remote SSH, their desktop will download the server and scp it into the workspace.
+
+## Portable mode
+
+VS Code [Portable mode](https://code.visualstudio.com/docs/editor/portable) is a self-contained, or "portable," installation of VS Code that uses local files for both installation and application data such as extensions.
diff --git a/docs/manifest.json b/docs/manifest.json
index 3b49c2321ccef..5684dd6d11f53 100644
--- a/docs/manifest.json
+++ b/docs/manifest.json
@@ -619,6 +619,24 @@
}
]
},
+ {
+ "title": "Air-gapped",
+ "description": "Configure your air-gapped or offline Coder deployment",
+ "path": "./admin/air-gapped/index.md",
+ "icon_path": "./images/icons/plug.svg",
+ "children": [
+ {
+ "title": "Air-gapped configuration",
+ "description": "Run Coder in offline / air-gapped environments",
+ "path": "./install/offline.md"
+ },
+ {
+ "title": "VS Code",
+ "description": "How to use VS Code in your air-gapped deployment",
+ "path": "./admin/air-gapped/vs-code.md"
+ }
+ ]
+ },
{
"title": "Licensing",
"description": "Configure licensing for your deployment",