Skip to content

Commit

Permalink
docs: reference THEIA_WEBVIEW_EXTERNAL_ENDPOINT
Browse files Browse the repository at this point in the history
The 'THEIA_WEBVIEW_EXTERNAL_ENDPOINT' environment variable configures
the webview host pattern. The '@theia/plugins-ext' README referred to
'THEIA_WEBVIEW_ENDPOINT_PATTERN' in error. This has now been corrected.
  • Loading branch information
sdirix authored Nov 13, 2024
1 parent 7c05b6f commit 8626799
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions packages/plugin-ext/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ The implementation is inspired from: https://blog.mattbierner.com/vscode-webview

## Environment Variables

- `THEIA_WEBVIEW_ENDPOINT_PATTERN`
- `THEIA_WEBVIEW_EXTERNAL_ENDPOINT`

A string pattern possibly containing `{{uuid}}` and `{{hostname}}` which will be replaced. This is the host for which the `webviews` will be served on.
It is a good practice to host the `webview` handlers on a sub-domain as it is more secure.
Expand All @@ -30,7 +30,7 @@ The implementation is inspired from: https://blog.mattbierner.com/vscode-webview

- Potentially Insecure Host Pattern

When you change the host pattern via the `THEIA_WEBVIEW_ENDPOINT_PATTERN` environment variable warning will be emitted both from the frontend and from the backend.
When you change the host pattern via the `THEIA_WEBVIEW_EXTERNAL_ENDPOINT` environment variable warning will be emitted both from the frontend and from the backend.
You can disable those warnings by setting `warnOnPotentiallyInsecureHostPattern: false` in the appropriate application configurations in your application's `package.json`.

## Runtime System Plugin Resolvement
Expand Down

0 comments on commit 8626799

Please sign in to comment.