Skip to content

Commit 0b6ba7e

Browse files
author
Katie Horne
authored
chore: add add'l details re: air-gapped deployments and Open VSX (coder#873)
1 parent 360d556 commit 0b6ba7e

File tree

1 file changed

+20
-6
lines changed

1 file changed

+20
-6
lines changed

setup/air-gapped/index.md

+20-6
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ platform images are hosted in Coder's Docker Hub repo.
9090
The following images are optional, though you're welcome to take advantage of
9191
Coder's versions instead of building your own:
9292

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

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

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

167167
Coder users in an air-gapped environment cannot access the public VS Code
168168
marketplace. However, you can point Coder to an air-gapped instance of
169-
[OpenVSX](https://github.com/eclipse/openvsx) to serve assets to users. For
170-
instructions on implementing this, see
169+
[Open VSX](https://github.com/eclipse/openvsx) to serve assets to users. For
170+
instructions on how to do this, see
171171
[Extensions](../../admin/workspace-management/extensions.md).
172172

173-
You can also review the [OpenVSX deployment wiki] for more information.
174-
175-
[openvsx deployment wiki]:
173+
Please review the [Open VSX deployment wiki] for more information on setting up
174+
your Open VSX deployment. Note that there are several components involved,
175+
including:
176+
177+
- The server application, available as the
178+
[openvsx-server Docker image](https://github.com/eclipse/openvsx/pkgs/container/openvsx-server)
179+
- A PostgreSQL instance to hold the metadata of the published extensions
180+
- If you use just a database for storage, Open VSX stores everything as binary
181+
data, which can increase the storage and network throughput of the database
182+
considerable. As such, Open VSX recommends leveraging external storage
183+
(e.g., Azure Blob Storage or Google Cloud Storage)
184+
- Elasticsearch, which Open VSX uses as the default search engine for search
185+
queries that originate from the web UI; this is optional, since you can either
186+
turn off searches or use database queries
187+
- GitHub OAuth for user authentication
188+
189+
[open vsx deployment wiki]:
176190
https://github.com/eclipse/openvsx/wiki/Deploying-Open-VSX

0 commit comments

Comments
 (0)