Skip to content

Commit b1315f8

Browse files
filiptronicekjeanp413
authored andcommitted
A note about security tokens
1 parent b639875 commit b1315f8

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,9 @@ docker run -it --init -p 3000:3000 -v "$(pwd):/home/workspace:cached" gitpod/ope
2828
```
2929
- Visit the URL printed in your terminal. Just going to port 3000 won't work, because VS Code requires that you provide a uniquely generated security token to prevent unauthorized access.
3030

31+
#### A note about security tokens
32+
Since OpenVSCode Server v1.62, you must access the Web UI using a connection token generated by the server. If that's not what you're looking for, and instead want to generate these tokens by yourself, start the server with `--connectionToken YOUR_TOKEN` to force your secret to be used. If you want your development environment to be even more secure, create a plaintext file with the desired token as its contents and provide it to the server with `--connection-secret YOUR_SECRET_FILE`.
33+
3134
_Note_: Feel free to use the `nightly` tag to test the latest version, i.e. `gitpod/openvscode-server:nightly`.
3235

3336
#### Custom Environment
@@ -52,7 +55,7 @@ tar -xzf openvscode-server-v${OPENVSCODE_SERVER_VERSION}.tar.gz
5255
cd openvscode-server-v${OPENVSCODE_SERVER_VERSION}
5356
./server.sh
5457
```
55-
- Visit the URL printed in your terminal. Just going to port 3000 won't work, because VS Code requires that you provide a uniquely generated security token to prevent unauthorized access.
58+
- Visit the URL printed in your terminal. Just going to port 3000 won't work, because VS Code requires that you provide a uniquely generated security token to prevent unauthorized access.
5659

5760
_Note_: You can use [pre-releases](https://github.com/gitpod-io/openvscode-server/releases) to test nightly changes.
5861

0 commit comments

Comments
 (0)