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
@@ -10,48 +10,67 @@ This project provides a version of VS Code that runs a server on a remote machin
10
10
11
11
## Why?
12
12
13
-
VS Code has traditionally been a desktop IDE built with web technology. A few years back people started patching it, in order to run it in a remote context and to make it accessible through web browsers. These efforts have been complex and error prone, because many changes had to be made across the large code base of VS Code.
13
+
VS Code has traditionally been a desktop IDE built with web technologies. A few years back, people started patching it in order to run it in a remote context and to make it accessible through web browsers. These efforts have been complex and error prone, because many changes had to be made across the large code base of VS Code.
14
14
15
-
Luckily in 2019 the VS Code team started to refactor its architecture to support a browser-based working mode. While this architecture has been adopted by Gitpod and GitHub, the important bits have not been open-sourced, yet. As a result many people in the community are still using the old hard to maintain and error-prone approach.
15
+
Luckily, in 2019 the VS Code team started to refactor its architecture to support a browser-based working mode. While this architecture has been adopted by Gitpod and GitHub, the important bits have not been open-sourced, until now. As a result, many people in the community still use the old, hard to maintain and error-prone approach.
16
16
17
-
At Gitpod we've been asked a lot about how we do it. So we thought we might just share the minimal set of changes needed, so people can rely on the latest version of VS Code, have a straightforward upgrade path and low maintenance effort.
17
+
At Gitpod, we've been asked a lot about how we do it. So we thought we might as well share the minimal set of changes needed so people can rely on the latest version of VS Code, have a straightforward upgrade path and low maintenance effort.
18
18
19
19
## Getting started
20
20
21
21
### Docker
22
22
23
23
- Start the server:
24
-
```bash
25
-
docker run -it --init -p 3000:3000 -v "$(pwd):/home/workspace:cached" gitpod/openvscode-server
tar -xzf openvscode-server-v${OPENVSCODE_SERVER_VERSION}.tar.gz
37
+
cd openvscode-server-v${OPENVSCODE_SERVER_VERSION}
38
+
./server.sh
39
+
```
40
+
-Visit[localhost:3000](http://localhost:3000).
41
41
42
-
You can use [prerelease](https://github.com/gitpod-io/openvscode-server/releases) to test nightly changes.
42
+
_Note_: You can use [pre-releases](https://github.com/gitpod-io/openvscode-server/releases) to test nightly changes.
43
+
44
+
### Deployment guides
45
+
46
+
Please refer to [Guides](./docs/guides/README.md) to learn how to deploy OpenVSCode Server to your cloud provider of choice.
43
47
44
48
## The scope of this project
45
49
46
-
This project really only adds the minimal bits required to run VS Code in a server scenario. We have no intention of changing VS Code in any way or adding additional features through this. Feature requests, bug fixes, etc. should go to the upstream repository.
50
+
This project only adds minimal bits required to run VS Code in a server scenario. We have no intention of changing VS Code in any way or to add additional features to VS Code itself. Please report feature requests, bug fixes, etc. in the upstream repository.
47
51
48
-
> **For any feature requests, bug reports, or contributions that are not specific to running VS Code in a server context,**
49
-
>
50
-
> **please go to [Visual Studio Code - Open Source "OSS"](https://github.com/microsoft/vscode)**
52
+
> **For any feature requests, bug reports, or contributions that are not specific to running VS Code in a server context, please go to [Visual Studio Code - Open Source "OSS"](https://github.com/microsoft/vscode)**
51
53
52
54
## Supporters
55
+
53
56
The project is supported by companies such as [GitLab](https://gitlab.com/), [VMware](https://www.vmware.com/), [Uber](https://www.uber.com/), [SAP](https://www.sap.com/), [Sourcegraph](https://sourcegraph.com/), [RStudio](https://www.rstudio.com/), [SUSE Rancher](https://rancher.com/), [Tabnine](https://www.tabnine.com/), [Render](https://render.com/) and [TypeFox](https://www.typefox.io/).
54
57
55
58
## Contributing
56
59
57
-
[See development docs.](./docs/development.md)
60
+
Thanks for your interest in contributing to the project 🙏. You can start a development environment with the following button:
61
+
62
+
[](https://gitpod.io/#https://github.com/gitpod-io/website)
63
+
64
+
To learn about the code structure and other topics related to contributing, please refer to the [development docs](./docs/development.md).
To learn what others are up to and to provide feedback, please head over to the [Discussions](https://github.com/gitpod-io/openvscode-server/discussions).
75
+
76
+
You can also follow us on Twitter [@gitpod](https://twitter.com/gitpod) or come [chat with us](https://www.gitpod.io/chat).
1. Launch a Ubuntu 20.04 instance with the default settings
14
+
***Caution**: Please follow security best practices when setting up your VM
15
+
16
+
### Download & extract OpenVSCode Server
17
+
18
+
**Caution**: Make sure you successfully connected to the VM before you execute the following commands.
19
+
20
+
First, let's define the release version we want to download. You can find the latest version on the [Releases](https://github.com/gitpod-io/openvscode-server/releases) page.
21
+
22
+
```bash
23
+
export SERVER_VERSION=1.60.0 # Replace with the latest version
24
+
```
25
+
26
+
With that in place, let's download & extract OpenVSCode server:
0 commit comments