Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Answered and Added some FAQ in Readme section #130

Open
wants to merge 69 commits into
base: main
Choose a base branch
from
Open
Changes from 1 commit
Commits
Show all changes
69 commits
Select commit Hold shift + click to select a range
d49e080
code web server initial commit
akosyakov Aug 6, 2021
488bc1c
Added remote terminal channel handler
spoenemann Aug 10, 2021
709dd63
Add startup scripts
filiptronicek Aug 30, 2021
a6faea7
Use absolute paths in the startup script
filiptronicek Sep 2, 2021
1b8bfd0
initial draft of readme for web-server branch
svenefftinge Sep 2, 2021
ef75917
Update README.md
svenefftinge Sep 3, 2021
6559bac
Update README.md
svenefftinge Sep 3, 2021
0df0ff5
Update README.md
svenefftinge Sep 3, 2021
a3fbfe6
Update README.md
svenefftinge Sep 3, 2021
07b580b
Update README.md
svenefftinge Sep 3, 2021
8ddc2db
package startup scripts and latest node 14
akosyakov Sep 3, 2021
94e36e7
Smoke test running
jeanp413 Aug 27, 2021
17fbbfc
Add explorer and terminal smoke tests
jeanp413 Sep 1, 2021
f663eac
Address Feedback
jeanp413 Sep 2, 2021
bc44905
Add web worker extension test
jeanp413 Sep 4, 2021
2728bae
Add server-cli smoke test
jeanp413 Sep 4, 2021
9c026d7
Terminal cli commads working
jeanp413 Sep 3, 2021
7903a2d
Fix errors after 1.60.0 update
jeanp413 Sep 4, 2021
dda25be
getting started
akosyakov Sep 6, 2021
12e0f12
Add extensionKind to product.json
jeanp413 Sep 7, 2021
3efac59
Update name to OpenVSCode Server
Sep 13, 2021
14338f1
update README with openvscode-server
akosyakov Sep 14, 2021
1012e53
Streamlined Readme
Sep 14, 2021
0ceddb7
Add sync script
jeanp413 Sep 15, 2021
3f7a641
Update sync script
jeanp413 Sep 15, 2021
7366838
Try to fix explorer smoke test in ci
jeanp413 Sep 17, 2021
2483d1f
Fix compilation after sync with upstream/main
jeanp413 Sep 17, 2021
5eb7897
Update sync script
jeanp413 Sep 17, 2021
7257688
Enable integration test
jeanp413 Sep 20, 2021
e4d18b0
Enable more tests
jeanp413 Sep 21, 2021
30d8de6
Skip failing test
jeanp413 Sep 21, 2021
a3657da
fix remote-terminal.ts
akosyakov Sep 21, 2021
f276398
Reenable integration test
jeanp413 Sep 21, 2021
70b0103
Disable flaky smoke test
jeanp413 Sep 21, 2021
79559a0
Delete SECURITY.md
ghuntley Sep 16, 2021
391f11d
Fix a spelling mistake in the README.md
timonbimon Sep 20, 2021
6829a66
rename web-server to opencode
akosyakov Sep 21, 2021
f66a33a
[server] user env service to locate built-in extensions
akosyakov Sep 21, 2021
7298786
add dev docs
akosyakov Sep 21, 2021
5e0854d
Update sync script
jeanp413 Sep 22, 2021
732318b
Update sync script
jeanp413 Sep 22, 2021
32b67f0
[build] only pack code and server binaries
akosyakov Sep 23, 2021
8b41448
Add more guides.
Sep 23, 2021
32d5d91
Align all guides with the guide template.
Sep 23, 2021
e53fd7e
Fix the path to the development.md.
Sep 23, 2021
d0244b4
Add list of supporter to readme
Sep 22, 2021
6df8b04
[sync] next to main
akosyakov Sep 24, 2021
780c1a6
add doc/sourcedive.snb.md
beyang Sep 27, 2021
327fb5d
Update link and image
dnilasor Sep 27, 2021
16ca400
Updates README & guides.
Sep 28, 2021
51551d5
remove authors, fix gitpod urls
akosyakov Sep 28, 2021
39eb08d
Updated path for guides
Sep 28, 2021
1dce39d
Fixed SUSE
Sep 28, 2021
afc70e2
add oauth setup instructions
dnilasor Sep 28, 2021
758a0c9
fix missing text in angle brackets
dnilasor Sep 28, 2021
b3162e7
Add links to the License & Chat badges.
mikenikles Sep 28, 2021
99d9227
fix service URLS
dnilasor Sep 28, 2021
a7148c0
Fix repo link in Deploy to Render
dnilasor Sep 28, 2021
6838364
Remove .git from link
dnilasor Sep 28, 2021
9320ca5
skip failing test for now
jeanp413 Sep 28, 2021
326e05e
Enable run tests on server build
jeanp413 Sep 29, 2021
b012f93
Numbering
hrittikhere Sep 28, 2021
cd13cd2
Create Azure VM Docs
hrittikhere Sep 28, 2021
982359c
Updates on boilerplate
hrittikhere Sep 28, 2021
b1ccfe7
Update Inbound Rules 🚀
hrittikhere Sep 28, 2021
aa211ec
Compile integration test when running from build
jeanp413 Sep 29, 2021
1311199
Update README.md
vikkastiwari Oct 2, 2021
16e20ba
Update README.md
vikkastiwari Oct 2, 2021
faf4b84
FAQ
vikkastiwari Oct 2, 2021
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
getting started
  • Loading branch information
akosyakov authored and jeanp413 committed Sep 28, 2021
commit dda25beb5803e554e9f994af50883554aa9e920b
36 changes: 0 additions & 36 deletions .gitpod.Dockerfile
Original file line number Diff line number Diff line change
@@ -1,11 +1,5 @@
FROM gitpod/workspace-full:latest

USER root

# leeway
ENV LEEWAY_NESTED_WORKSPACE=true
RUN cd /usr/bin && curl -fsSL https://github.com/gitpod-io/leeway/releases/download/v0.2.5/leeway_0.2.5_Linux_x86_64.tar.gz | tar xz

USER gitpod

# We use latest major version of Node.js distributed VS Code. (see about dialog in your local VS Code)
@@ -25,33 +19,3 @@ RUN sudo apt-get update \
libasound2 libgbm1 xfonts-base xfonts-terminus fonts-noto fonts-wqy-microhei \
fonts-droid-fallback vim-tiny nano libgconf2-dev libgtk-3-dev twm \
&& sudo apt-get clean && sudo rm -rf /var/cache/apt/* && sudo rm -rf /var/lib/apt/lists/* && sudo rm -rf /tmp/*

## Register leeway autocompletion in bashrc
RUN bash -c "echo . \<\(leeway bash-completion\) >> ~/.bashrc"

### Google Cloud ###
# not installed via repository as then 'docker-credential-gcr' is not available
ARG GCS_DIR=/opt/google-cloud-sdk
ENV PATH=$GCS_DIR/bin:$PATH
RUN sudo chown gitpod: /opt \
&& mkdir $GCS_DIR \
&& curl -fsSL https://dl.google.com/dl/cloudsdk/channels/rapid/downloads/google-cloud-sdk-344.0.0-linux-x86_64.tar.gz \
| tar -xzvC /opt \
&& /opt/google-cloud-sdk/install.sh --quiet --usage-reporting=false --bash-completion=true \
--additional-components docker-credential-gcr alpha beta \
# needed for access to our private registries
&& docker-credential-gcr configure-docker

# Install tools for gsutil
RUN sudo install-packages \
gcc \
python-dev \
python-setuptools

RUN bash -c "pip uninstall crcmod; pip install --no-cache-dir -U crcmod"

# Set Application Default Credentials (ADC) based on user-provided env var
RUN echo ". /workspace/vscode/scripts/setup-google-adc.sh" >> ~/.bashrc

ENV LEEWAY_WORKSPACE_ROOT=/workspace/vscode
ENV LEEWAY_REMOTE_CACHE_BUCKET=gitpod-core-leeway-cache-branch
5 changes: 2 additions & 3 deletions .gitpod.yml
Original file line number Diff line number Diff line change
@@ -5,9 +5,8 @@ ports:
onOpen: open-browser
tasks:
- init: |
export VSCODE_INIT_BUILD_DIR=$(leeway describe "//:init" -t "/tmp/build/{{ .Metadata.Name }}.{{ .Metadata.Version }}")
leeway build
sudo cp -rup "$VSCODE_INIT_BUILD_DIR/install/." . | true
yarn
yarn gitpod:init
command: |
gp sync-done init
export NODE_ENV=development
17 changes: 0 additions & 17 deletions BUILD.yaml

This file was deleted.

45 changes: 44 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -18,7 +18,24 @@ At Gitpod we've been asked a lot about how we do it. So we thought we might just

## Getting started

The easiest way to get started is ...
### Docker

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

### Linux

- [Download the latest release](https://github.com/gitpod-io/vscode-releases/releases/latest)
- untar and run the server:
```bash
tar -xzf code-web-server-v*.tar.gz
cd code-web-server-v*
./server.sh
```
- after this, visit [localhost:3000](http://localhost:3000).

## The scope of this project

@@ -27,3 +44,29 @@ This project really only adds the minimal bits required to run VS Code in a web
> **For any feature requests, bug reports, or contributions that are not specific to running VS Code in a web server context,**
>
> **please go to [Visual Studio Code - Open Source "OSS"](https://github.com/microsoft/vscode)**

## Contributing

### Starting from sources

- [Start a Gitpod workspace](https://gitpod.io/#https://github.com/gitpod-io/vscode/tree/web-server)
- 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).

### Updating VS Code

- Update your local VS Code, open the About dialog and remember the release commit and Node.js version.
- 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`.
- 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.
- Recompile everything: `git clean -dfx && yarn && yarn gitpod:init`
- Run smoke tests: `yarn gitpod:smoketest`.
- Start the dev server and play:
- filesystem (open some project)
- extension host process: check language smartness
- extension management (installing/uninstalling)
- install VIM extension to test web extensions
- terminals
- code cli should open files and manage extensions: `alias code='export VSCODE_DEV=1 && node out/server-cli.js'`
- Check server/browser logs for any warnings/errors about missing capabilities and fix them.
- Build the production server with all changes: `yarn gulp server-min`.
- Run it and play as with the dev server: `/workspace/server-pkg/server.sh`
- Open a PR with your changes and ask for help if needed. It should be agaist `gitpod-io/vscode` repo and `web-server` branch!
1 change: 0 additions & 1 deletion WORKSPACE.yaml

This file was deleted.

4 changes: 3 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -55,7 +55,9 @@
"minify-vscode-reh-web": "node --max_old_space_size=4095 ./node_modules/gulp/bin/gulp.js minify-vscode-reh-web",
"hygiene": "node --max_old_space_size=4095 ./node_modules/gulp/bin/gulp.js hygiene",
"core-ci": "node --max_old_space_size=4095 ./node_modules/gulp/bin/gulp.js core-ci",
"extensions-ci": "node --max_old_space_size=4095 ./node_modules/gulp/bin/gulp.js extensions-ci"
"extensions-ci": "node --max_old_space_size=4095 ./node_modules/gulp/bin/gulp.js extensions-ci",
"gitpod:init": "yarn --cwd ./build compile && yarn compile && yarn download-builtin-extensions",
"gitpod:smoketest": "yarn --cwd ./test/smoke compile && yarn smoketest-no-compile --web --verbose --headless --electronArgs=\"--disable-dev-shm-usage --use-gl=swiftshader\""
},
"dependencies": {
"@microsoft/applicationinsights-web": "^2.6.4",
1 change: 1 addition & 0 deletions product.json
Original file line number Diff line number Diff line change
@@ -27,6 +27,7 @@
"GitHub.vscode-pull-request-github",
"GitHub.vscode-pull-request-github-insiders",
"ms-python.python",
"ms-toolsai.jupyter",
"ms-vscode.js-debug-nightly",
"ms-vscode.js-debug",
"ms-vscode.lsif-browser",
2 changes: 1 addition & 1 deletion test/smoke/src/areas/extensions/extensions.test.ts
Original file line number Diff line number Diff line change
@@ -4,7 +4,7 @@
*--------------------------------------------------------------------------------------------*/

import minimist = require('minimist');
import { Application, Quality } from '../../../../automation';
import { Application } from '../../../../automation';
import { afterSuite, beforeSuite } from '../../utils';

export function setup(opts: minimist.ParsedArgs) {