From 2b2ea274313e880991cf526f2faf82d47c5ef9bb Mon Sep 17 00:00:00 2001 From: aptalca Date: Mon, 29 Nov 2021 15:49:30 -0500 Subject: [PATCH] update readme with insiders tag and port proxy --- README.md | 11 +++++++++++ readme-vars.yml | 5 ++++- 2 files changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2119f51..2aa8d63 100644 --- a/README.md +++ b/README.md @@ -57,6 +57,15 @@ The architectures supported by this image are: | arm64 | arm64v8-latest | | armhf | arm32v7-latest | +## Version Tags + +This image provides various versions that are available via tags. `latest` tag usually provides the latest stable version. Others are considered under development and caution must be exercised when using them. + +| Tag | Description | +| :----: | --- | +| latest | Stable releases | +| insiders | Insiders releases | + ## Application Setup Access the webui at `http://:3000?tkn=supersecrettoken`. If `CONNECTION_TOKEN` or `CONNECTION_SECRET` env vars are set, replace `supersecrettoken` with the value set. If not, view the container logs (`docker logs openvscode-server`) to see the randomly generated token and replace `supersecrettoken` with that. @@ -69,6 +78,8 @@ git config --global user.name "username" git config --global user.email "email address" ``` +When reverse proxied through SWAG, custom services running on specific ports inside openvscode-server can be accessed at `https://PORT.openvscode-server.domain.com` very much like how code-server's port proxy function is handled. For that, a wildcard CNAME `*.openvscode-server.domain.com` needs to be created and the SWAG cert needs to cover those subdomains. + ## Usage Here are some example snippets to help you get started creating a container. diff --git a/readme-vars.yml b/readme-vars.yml index 9f11d5c..8b8ff3a 100644 --- a/readme-vars.yml +++ b/readme-vars.yml @@ -14,9 +14,10 @@ available_architectures: - { arch: "{{ arch_armhf }}", tag: "arm32v7-latest"} # development version -development_versions: false +development_versions: true development_versions_items: - { tag: "latest", desc: "Stable releases" } + - { tag: "insiders", desc: "Insiders releases" } # container parameters common_param_env_vars_enabled: true @@ -53,6 +54,8 @@ app_setup_block: | git config --global user.email "email address" ``` + When reverse proxied through SWAG, custom services running on specific ports inside openvscode-server can be accessed at `https://PORT.openvscode-server.domain.com` very much like how code-server's port proxy function is handled. For that, a wildcard CNAME `*.openvscode-server.domain.com` needs to be created and the SWAG cert needs to cover those subdomains. + # changelog changelogs: