Skip to content

chore: update air-gap setup to include code-marketplace, and remote SSH IDE with air-gap #1153

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
Oct 21, 2022
Merged

chore: update air-gap setup to include code-marketplace, and remote SSH IDE with air-gap #1153

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6e3c7c4
chore: update air-gap setup to include code-marketplace, and remote S…
sharkymark Oct 20, 2022
561910d
Update workspaces/editors.md
sharkymark Oct 21, 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
26 changes: 4 additions & 22 deletions setup/air-gapped/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,26 +166,8 @@ platform images are hosted in Coder's Docker Hub repo.
## Extensions marketplace

Coder users in an air-gapped environment cannot access the public VS Code
marketplace. However, you can point Coder to an air-gapped instance of
[Open VSX](https://github.com/eclipse/openvsx) to serve assets to users. For
instructions on how to do this, see
marketplace. However, you can point Coder to an air-gapped instance of either
[Coder's code-marketplace OSS](https://github.com/coder/code-marketplace) or
[Open VSX](https://github.com/eclipse/openvsx) to serve VS Code extensions to
users. For instructions on how to do either approach, see
[Extensions](../../admin/workspace-management/extensions.md).

Please review the [Open VSX deployment wiki] for more information on setting up
your Open VSX deployment. Note that there are several components involved,
including:

- The server application, available as the
[openvsx-server Docker image](https://github.com/eclipse/openvsx/pkgs/container/openvsx-server)
- A PostgreSQL instance to hold the metadata of the published extensions
- If you use just a database for storage, Open VSX stores everything as binary
data, which can increase the storage and network throughput of the database
considerable. As such, Open VSX recommends leveraging external storage
(e.g., Azure Blob Storage or Google Cloud Storage)
- Elasticsearch, which Open VSX uses as the default search engine for search
queries that originate from the web UI; this is optional, since you can either
turn off searches or use database queries
- GitHub OAuth for user authentication

[open vsx deployment wiki]:
https://github.com/eclipse/openvsx/wiki/Deploying-Open-VSX
9 changes: 9 additions & 0 deletions workspaces/editors.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,15 @@ from your local VS Code, connected to your Coder workspace for compute, etc.
1. In VS Code's left-hand nav bar, click **Remote Explorer** and right-click on
a workspace to connect

> If Coder is deployed air-gapped (no Internet), you need to configure your VS
> Code's [setting](https://code.visualstudio.com/docs/getstarted/settings) with
> `remote.SSH.allowLocalServerDownload` enabled so the extension will install
> the VS Code Server on the client first and then copy it over to the Coder
> workspace via SCP.
>
> For further troubleshooting steps, see [Troubleshooting hanging or failing
> connections](https://code.visualstudio.com/docs/remote/troubleshooting#_troubleshooting-hanging-or-failing-connections)

![VS Code Remote Explorer](../assets/workspaces/vscode-remote-ssh-panel.png)

## VS Code in the browser
Expand Down