Skip to content

Commit 94d0ce8

Browse files
Mike Niklesjeanp413
authored andcommitted
Updates README & guides.
1 parent d7749da commit 94d0ce8

File tree

4 files changed

+107
-23
lines changed

4 files changed

+107
-23
lines changed

README.md

Lines changed: 41 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# OpenVSCode Server
22

3-
[![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-908a85?logo=gitpod)](https://gitpod.io/from-referrer/)
3+
[![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-908a85?logo=gitpod)](https://github.com/gitpod-io/openvscode-server/) ![GitHub](https://img.shields.io/github/license/gitpod-io/openvscode-server) ![Discord](https://img.shields.io/discord/816244985187008514)
44

55
## What is this?
66

@@ -10,48 +10,67 @@ This project provides a version of VS Code that runs a server on a remote machin
1010

1111
## Why?
1212

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.
1414

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.
1616

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.
1818

1919
## Getting started
2020

2121
### Docker
2222

2323
- Start the server:
24-
```bash
25-
docker run -it --init -p 3000:3000 -v "$(pwd):/home/workspace:cached" gitpod/openvscode-server
26-
```
27-
- after this, visit [localhost:3000](http://localhost:3000).
24+
```bash
25+
docker run -it --init -p 3000:3000 -v "$(pwd):/home/workspace:cached" gitpod/openvscode-server
26+
```
27+
- Visit [localhost:3000](http://localhost:3000).
2828

29-
You can use `nightly` tag to test nightly changes.
29+
_Note_: Feel free to use the `nightly` tag to test the latest version, i.e. `gitpod/openvscode-server:nightly`.
3030

3131
### Linux
3232

3333
- [Download the latest release](https://github.com/gitpod-io/openvscode-server/releases/latest)
34-
- untar and run the server:
35-
```bash
36-
tar -xzf openvscode-server-v${OPENVSCODE_SERVER_VERSION}.tar.gz
37-
cd openvscode-server-v${OPENVSCODE_SERVER_VERSION}
38-
./server.sh
39-
```
40-
- after this, visit [localhost:3000](http://localhost:3000).
34+
- Untar and run the server:
35+
```bash
36+
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).
4141

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.
4347

4448
## The scope of this project
4549

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.
4751

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)**
5153
5254
## Supporters
55+
5356
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/).
5457

5558
## Contributing
5659

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+
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](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).
65+
66+
## Authors
67+
68+
- [Anton Kosyakov](https://www.github.com/akosyakov)
69+
- [Jean Pierre Huaroto](https://www.github.com/jeanp413)
70+
- [Filip Troníček](https://www.github.com/filiptronicek)
71+
72+
## Community & Feedback
73+
74+
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).

docs/guides/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Each directory contains a `README.md` file as the main guide. Additional, suppor
66

77
## Add a new guide
88

9-
We welcome community contributions 🙏. Please open an issue and/or pull request if you would like to add new deployment guides.
9+
We welcome community contributions 🙏. Please open an issue and/or pull request if you would like to add a new deployment guide.
1010

1111
To add a new guide:
1212
1. Copy the `_template` directory and name it based on the deployment platform you write a guide for

docs/guides/aws-ec2/README.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# Deploy OpenVSCode Server to AWS EC2
2+
3+
## Prerequisites
4+
5+
To complete this guide, you need:
6+
* an [AWS](https://aws.amazon.com/) account
7+
8+
## Setup
9+
10+
### Create a VM
11+
12+
1. Navigate to https://console.aws.amazon.com/ec2
13+
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:
27+
28+
```bash
29+
wget https://github.com/gitpod-io/openvscode-server/releases/download/openvscode-server-v$SERVER_VERSION/openvscode-server-v$SERVER_VERSION-linux-x64.tar.gz -O code-server.tar.gz
30+
tar -xzf code-server.tar.gz
31+
rm code-server.tar.gz
32+
```
33+
34+
### Create an inbound rule for port 3000
35+
36+
To access OpenVSCode Server on port 3000 later, we have to create an inbound rule:
37+
1. Open the instance summary page
38+
1. Select the "Security" tab
39+
1. In the "Security groups" section, click on the link to open the security group page
40+
1. In the "Inbound rules" table, click the "Edit inbound rules" button on the right side
41+
1. Click "Add rule" and populate the following fields (use default values for everything else):
42+
* Type: Custom TCP
43+
* Port range: 3000
44+
* Source: Anywhere-IPv4
45+
1. Click "Save rules"
46+
47+
## Start the server
48+
49+
While you are still connected to the VM, execute the following commands to start OpenVSCode Server:
50+
51+
```bash
52+
cd openvscode-server-v$SERVER_VERSION-linux-x64
53+
./server.sh
54+
```
55+
56+
## Access OpenVSCode Server
57+
58+
1. Navigate to your VM's instance summary page
59+
1. Copy the "Public IPv4 address"
60+
1. Paste the IP address in a new browser tab and add `:3000`, i.e. `http://18.118.194.234:3000`
61+
62+
## Teardown
63+
64+
1. Navigate to your VM's instance summary page
65+
1. Click "Instance state" and select "Terminate instance"
File renamed without changes.

0 commit comments

Comments
 (0)