Skip to content

Commit 0f6ae25

Browse files
committed
update README with openvscode-server
1 parent f2718f0 commit 0f6ae25

File tree

3 files changed

+12
-12
lines changed

3 files changed

+12
-12
lines changed

.gitpod.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ ports:
66
tasks:
77
- init: |
88
yarn
9-
yarn gitpod:init
9+
yarn server:init
1010
command: |
1111
gp sync-done init
1212
export NODE_ENV=development

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
## What is this?
66

7-
This project provides a version of VS Code that runs a server on a remote machine and allows through a modern web browser. It's based on the very same architecture used by [Gitpod](https://www.gitpod.io) or [GitHub Codespaces](https://github.com).
7+
This project provides a version of VS Code that runs a server on a remote machine and allows access through a modern web browser. It's based on the very same architecture used by [Gitpod](https://www.gitpod.io) or [GitHub Codespaces](https://github.com).
88

99
<img width="1624" alt="Screenshot 2021-09-02 at 08 39 26" src="https://user-images.githubusercontent.com/372735/131794918-d6602646-4d67-435b-88fe-620a3cc0a3aa.png">
1010

@@ -22,17 +22,17 @@ At Gitpod we've been asked a lot about how we do it. So we thought we might just
2222

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

2929
### Linux
3030

31-
- [Download the latest release](https://github.com/gitpod-io/vscode-releases/releases/latest)
31+
- [Download the latest release](https://github.com/gitpod-io/openvscode-server/releases/latest)
3232
- untar and run the server:
3333
```bash
34-
tar -xzf code-web-server-v*.tar.gz
35-
cd code-web-server-v*
34+
tar -xzf code-web-server-v${OPENVSCODE_SERVER_VERSION}.tar.gz
35+
cd code-web-server-v${OPENVSCODE_SERVER_VERSION}
3636
./server.sh
3737
```
3838
- after this, visit [localhost:3000](http://localhost:3000).
@@ -49,16 +49,16 @@ This project really only adds the minimal bits required to run VS Code in a web
4949

5050
### Starting from sources
5151

52-
- [Start a Gitpod workspace](https://gitpod.io/#https://github.com/gitpod-io/vscode/tree/web-server)
52+
- [Start a Gitpod workspace](https://gitpod.io/#https://github.com/gitpod-io/openvscode-server)
5353
- Dev version of the server should be already up and running. Notice that the dev version is slower to load since it is not bundled (around 2000 files).
5454

5555
### Updating VS Code
5656

5757
- Update your local VS Code, open the About dialog and remember the release commit and Node.js version.
5858
- Fetch latest upstream changes and rebase the branch based on the local VS Code's commit. Drop all commits before `code web server initial commit`.
5959
- Check that [.gitpod.Dockerfile](./.gitpod.Dockerfile) and [remote/.yarnrc](./remote/.yarnrc) has latest major Node.js version of local VS Code's Node.js version.
60-
- Recompile everything: `git clean -dfx && yarn && yarn gitpod:init`
61-
- Run smoke tests: `yarn gitpod:smoketest`.
60+
- Recompile everything: `git clean -dfx && yarn && yarn server:init`
61+
- Run smoke tests: `yarn server:smoketest`.
6262
- Start the dev server and play:
6363
- filesystem (open some project)
6464
- extension host process: check language smartness
@@ -69,4 +69,4 @@ This project really only adds the minimal bits required to run VS Code in a web
6969
- Check server/browser logs for any warnings/errors about missing capabilities and fix them.
7070
- Build the production server with all changes: `yarn gulp server-min`.
7171
- Run it and play as with the dev server: `/workspace/server-pkg/server.sh`
72-
- Open a PR with your changes and ask for help if needed. It should be agaist `gitpod-io/vscode` repo and `web-server` branch!
72+
- Open a PR with your changes and ask for help if needed. It should be agaist `gitpod-io/openvscode-server` repo and `web-server` branch!

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,8 @@
5656
"hygiene": "node --max_old_space_size=4095 ./node_modules/gulp/bin/gulp.js hygiene",
5757
"core-ci": "node --max_old_space_size=4095 ./node_modules/gulp/bin/gulp.js core-ci",
5858
"extensions-ci": "node --max_old_space_size=4095 ./node_modules/gulp/bin/gulp.js extensions-ci",
59-
"gitpod:init": "yarn --cwd ./build compile && yarn compile && yarn download-builtin-extensions",
60-
"gitpod:smoketest": "yarn --cwd ./test/smoke compile && yarn smoketest-no-compile --web --verbose --headless --electronArgs=\"--disable-dev-shm-usage --use-gl=swiftshader\""
59+
"server:init": "yarn --cwd ./build compile && yarn compile && yarn download-builtin-extensions",
60+
"server:smoketest": "yarn --cwd ./test/smoke compile && yarn smoketest-no-compile --web --verbose --headless --electronArgs=\"--disable-dev-shm-usage --use-gl=swiftshader\""
6161
},
6262
"dependencies": {
6363
"@microsoft/applicationinsights-web": "^2.6.4",

0 commit comments

Comments
 (0)