You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Add docs about the new `--without-connection-token`, including other changes.
Correct the entrypoint
Update 'em docs again
Mention `--without-connection-token`
Co-authored-by: Jean Pierre <[email protected]>
Rephrase the `Securing access to your IDE` section
Co-authored-by: Jean Pierre <[email protected]>
Copy file name to clipboardExpand all lines: README.md
+21-17Lines changed: 21 additions & 17 deletions
Original file line number
Diff line number
Diff line change
@@ -26,17 +26,8 @@ At Gitpod, we've been asked a lot about how we do it. So we thought we might as
26
26
```bash
27
27
docker run -it --init -p 3000:3000 -v "$(pwd):/home/workspace:cached" gitpod/openvscode-server
28
28
```
29
-
- 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.
29
+
- Visit the URL printed in your terminal.
30
30
31
-
#### A note about security tokens
32
-
33
-
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 `--connection-token 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`.
34
-
35
-
For those using docker-compose you can set a connection token by using `command`. For example:
36
-
37
-
```yaml
38
-
command: --connection-token yourTokenHere
39
-
```
40
31
41
32
_Note_: Feel free to use the `nightly` tag to test the latest version, i.e. `gitpod/openvscode-server:nightly`.
42
33
@@ -56,16 +47,29 @@ _Note_: Feel free to use the `nightly` tag to test the latest version, i.e. `git
56
47
### Linux
57
48
58
49
-[Download the latest release](https://github.com/gitpod-io/openvscode-server/releases/latest)
59
-
- Untar and run the server:
60
-
```bash
61
-
tar -xzf openvscode-server-v${OPENVSCODE_SERVER_VERSION}.tar.gz
62
-
cd openvscode-server-v${OPENVSCODE_SERVER_VERSION}
63
-
./server.sh
64
-
```
65
-
- 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.
50
+
- Untar and run the server
51
+
```bash
52
+
tar -xzf openvscode-server-v${OPENVSCODE_SERVER_VERSION}.tar.gz
53
+
cd openvscode-server-v${OPENVSCODE_SERVER_VERSION}
54
+
./bin/openvscode-server # you can add arguments here, use --help to list all of the possible options
55
+
```
56
+
57
+
From the possible entrypoint arguments, the most notable ones are
58
+
- `--port` - the port number to start the server on, this is 3000 by default
59
+
- `--without-connection-token` - used by default in the docker image
60
+
- `--connection-token` & `--connection-secret` for securing access to the IDE, you can read more about it in [Securing access to your IDE](#securing-access-to-your-ide).
61
+
- `--host` - determines the host the server is listening on. It defaults to `localhost`, so for accessing remotely it's a good idea to add `--host 0.0.0.0` to your launch arguments.
62
+
63
+
- Visit the URL printed in your terminal.
66
64
67
65
_Note_: You can use [pre-releases](https://github.com/gitpod-io/openvscode-server/releases) to test nightly changes.
68
66
67
+
### Securing access to your IDE
68
+
69
+
Since OpenVSCode Server v1.64, you can access the Web UI without authentication (anyone can access the IDE using just the hostname and port), if you need some kind of basic authentication then you can start the server with `--connection-token YOUR_TOKEN`, the provided `YOUR_TOKEN` will be used and the authenticated URL will be displayed in your terminal once you start the server. You can also create a plaintext file with the desired token as its contents and provide it to the server with `--connection-secret YOUR_SECRET_FILE`.
70
+
71
+
If you want to use a connection token and are working with OpenVSCode Server via [the Docker image](https://hub.docker.com/r/gitpod/openvscode-server), you will have to edit the `ENTRYPOINT` in [the Dockerfile](https://github.com/gitpod-io/openvscode-releases/blob/eb59ab37e23f8d17532b4af4de37eafaf48037a5/Dockerfile#L64) or modify it with the [`entrypoint` option](https://docs.docker.com/compose/compose-file/compose-file-v3/#entrypoint) when working with `docker-compose`.
72
+
69
73
### Deployment guides
70
74
71
75
Please refer to [Guides](https://github.com/gitpod-io/openvscode-server/tree/docs/guides) to learn how to deploy OpenVSCode Server to your cloud provider of choice.
0 commit comments