Skip to content

Commit dc3c209

Browse files
authored
Merge pull request #3 from linuxserver/readme
update readme with insiders tag and port proxy
2 parents c766915 + 2b2ea27 commit dc3c209

File tree

2 files changed

+15
-1
lines changed

2 files changed

+15
-1
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,15 @@ The architectures supported by this image are:
5757
| arm64 | arm64v8-latest |
5858
| armhf | arm32v7-latest |
5959

60+
## Version Tags
61+
62+
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.
63+
64+
| Tag | Description |
65+
| :----: | --- |
66+
| latest | Stable releases |
67+
| insiders | Insiders releases |
68+
6069
## Application Setup
6170

6271
Access the webui at `http://<your-ip>: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"
6978
git config --global user.email "email address"
7079
```
7180

81+
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.
82+
7283
## Usage
7384

7485
Here are some example snippets to help you get started creating a container.

readme-vars.yml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,10 @@ available_architectures:
1414
- { arch: "{{ arch_armhf }}", tag: "arm32v7-latest"}
1515

1616
# development version
17-
development_versions: false
17+
development_versions: true
1818
development_versions_items:
1919
- { tag: "latest", desc: "Stable releases" }
20+
- { tag: "insiders", desc: "Insiders releases" }
2021

2122
# container parameters
2223
common_param_env_vars_enabled: true
@@ -53,6 +54,8 @@ app_setup_block: |
5354
git config --global user.email "email address"
5455
```
5556
57+
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.
58+
5659
5760
# changelog
5861
changelogs:

0 commit comments

Comments
 (0)