Skip to content

chore: add add'l details re: air-gapped deployments and Open VSX #873

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 1 commit into from
Mar 8, 2022
Merged

chore: add add'l details re: air-gapped deployments and Open VSX #873

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 20 additions & 6 deletions setup/air-gapped/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ platform images are hosted in Coder's Docker Hub repo.
The following images are optional, though you're welcome to take advantage of
Coder's versions instead of building your own:

[OpenVSX](https://github.com/orgs/eclipse/packages/container/package/openvsx-server)
[Open VSX](https://github.com/orgs/eclipse/packages/container/package/openvsx-server)

[enterprise-node](https://hub.docker.com/r/codercom/enterprise-node)

Expand Down Expand Up @@ -166,11 +166,25 @@ platform images are hosted in Coder's Docker Hub repo.

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
[OpenVSX](https://github.com/eclipse/openvsx) to serve assets to users. For
instructions on implementing this, see
[Open VSX](https://github.com/eclipse/openvsx) to serve assets to users. For
instructions on how to do this, see
[Extensions](../../admin/workspace-management/extensions.md).

You can also review the [OpenVSX deployment wiki] for more information.

[openvsx deployment wiki]:
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