a
/
code-server
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Document structure better 

Closes #1648
This commit is contained in:
Anmol Sethi 2020-05-17 16:53:08 -04:00
parent aee2599904
commit 6a25b3bfa0
No known key found for this signature in database
GPG Key ID: 8CEF1878FF10ADEB
8 changed files with 164 additions and 191 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -1,8 +1,8 @@
# code-server # code-server
Run [VS Code](https://github.com/Microsoft/vscode) on any machine anywhere and access it through the browser. Run [VS Code](https://github.com/Microsoft/vscode) on any machine anywhere and access it in the browser.
- **Code anywhere:** Code on your Chromebook, tablet, and laptop with a - **Code everywhere:** Code on your Chromebook, tablet, and laptop with a
consistent dev environment. Develop on a Linux machine and pick up from any consistent dev environment. Develop on a Linux machine and pick up from any
device with a web browser. device with a web browser.
- **Server-powered:** Take advantage of large cloud servers to speed up tests, compilations, downloads, and more. - **Server-powered:** Take advantage of large cloud servers to speed up tests, compilations, downloads, and more.
@ -13,7 +13,7 @@ Run [VS Code](https://github.com/Microsoft/vscode) on any machine anywhere and a
## Getting started ## Getting started
For a proper setup and walkthrough, please see [./doc/guide.md](./doc/guide.md). For a full setup and walkthrough, please see [./doc/guide.md](./doc/guide.md).
### Debian, Ubuntu ### Debian, Ubuntu
@ -38,10 +38,10 @@ systemctl --user enable --now code-server
We recommend installing from `npm` if we don't have a precompiled release for your machine's We recommend installing from `npm` if we don't have a precompiled release for your machine's
platform or architecture. platform or architecture.
**note:** Installing via `npm` requires certain dependencies for the native module builds. **note:** Installing via `npm` builds native modules on install and so requires C dependencies.
See [./doc/npm.md](./doc/npm.md) for installing these dependencies. See [./doc/npm.md](./doc/npm.md) for installing these dependencies.
You also need at least node v12 installed. See [#1633](https://github.com/cdr/code-server/issues/1633). You will need at least node v12 installed. See [#1633](https://github.com/cdr/code-server/issues/1633).
```bash ```bash
npm install -g code-server npm install -g code-server
@ -75,13 +75,13 @@ docker run -it -p 127.0.0.1:8080:8080 \
We publish self contained `.tar.gz` archives for every release on [github](https://github.com/cdr/code-server/releases). We publish self contained `.tar.gz` archives for every release on [github](https://github.com/cdr/code-server/releases).
They bundle the node binary and compiled native modules. They bundle the node binary and compiled native modules.
1. Download the latest release archive for your system from [github](https://github.com/cdr/code-server/releases) 1. Download the latest release archive for your system from [github](https://github.com/cdr/code-server/releases).
2. Unpack the release 2. Unpack the release.
3. You can run code-server by executing `bin/code-server` 3. You can run code-server by executing `./bin/code-server`.
Add the code-server `bin` directory to your `$PATH` to easily execute it without the full path every time. Add the code-server `bin` directory to your `$PATH` to easily execute `code-server` without the full path every time.
Here is an example script for installing and using a self-contained code-server release on Linux: Here is an example script for installing and using a self-contained `code-server` release on Linux:
```bash ```bash
curl -sSL https://github.com/cdr/code-server/releases/download/3.3.0/code-server-3.3.0-linux-amd64.tar.gz | sudo tar -C /usr/local -xz curl -sSL https://github.com/cdr/code-server/releases/download/3.3.0/code-server-3.3.0-linux-amd64.tar.gz | sudo tar -C /usr/local -xz

169
ci/README.md
View File

@ -2,105 +2,107 @@
This directory contains scripts used for code-server's continuous integration infrastructure. This directory contains scripts used for code-server's continuous integration infrastructure.
Many of these scripts contain more detailed documentation and options in comments at the top. Some of these scripts contain more detailed documentation and options
in header comments.
Any file and directory added into this tree should be documented here. Any file or directory in this subdirectory should be documented here.
- [./ci/lib.sh](./lib.sh)
- Contains code duplicated across these scripts.
## Publishing a release ## Publishing a release
Make sure you have `$GITHUB_TOKEN` set and [hub](https://github.com/github/hub) installed. Make sure you have `$GITHUB_TOKEN` set and [hub](https://github.com/github/hub) installed.
1. Update the version of code-server in `package.json` and README.md/guide.md install examples and push a commit 1. Update the version of code-server in `package.json` and README.md/guide.md install examples and push a commit.
2. GitHub actions will generate the `npm-package` and `release-packages` artifacts 2. GitHub actions will generate the `npm-package`, `release-packages` and `release-images` artifacts.
3. Run `yarn release:github-draft` to create a GitHub draft release from the template with 3. Run `yarn release:github-draft` to create a GitHub draft release from the template with
the updated version. the updated version.
1. Summarize the major changes in the release notes and link to the relevant issues. 1. Summarize the major changes in the release notes and link to the relevant issues.
4. Wait for the artifacts in step 2 to build 4. Wait for the artifacts in step 2 to build.
5. Run `yarn release:github-assets` to download the artifacts and then upload them to the draft release 5. Run `yarn release:github-assets` to download the `release-packages` artifact and then upload them to the draft release.
6. Run some basic sanity tests on one of the released packages 6. Run some basic sanity tests on one of the released packages.
7. Publish the release 7. Publish the release.
1. CI will automatically grab the artifacts and then 1. CI will automatically grab the artifacts and then:
1. Publish the NPM package 1. Publish the NPM package from `npm-package`.
2. Publish the Docker Hub image 2. Publish the Docker Hub image from `release-images`.
8. Update the homebrew and AUR packages 8. Update the homebrew and AUR packages.
## dev ## dev
This directory contains scripts used for the development of code-server. This directory contains scripts used for the development of code-server.
- [./dev/container](./dev/container) - [./ci/dev/container](./dev/container)
- See [CONTRIBUTING.md](../doc/CONTRIBUTING.md) for docs on the development container - See [./doc/CONTRIBUTING.md](../doc/CONTRIBUTING.md) for docs on the development container.
- [./dev/ci.sh](./dev/ci.sh) (`yarn ci`) - [./ci/dev/fmt.sh](./dev/fmt.sh) (`yarn fmt`)
- Runs `yarn fmt`, `yarn lint` and `yarn test` - Runs formatters.
- [./dev/fmt.sh](./dev/fmt.sh) (`yarn fmt`) - [./ci/dev/lint.sh](./dev/lint.sh) (`yarn lint`)
- Runs formatters - Runs linters.
- [./dev/lint.sh](./dev/lint.sh) (`yarn lint`) - [./ci/dev/test.sh](./dev/test.sh) (`yarn test`)
- Runs linters - Runs tests.
- [./dev/test.sh](./dev/test.sh) (`yarn test`) - [./ci/dev/ci.sh](./dev/ci.sh) (`yarn ci`)
- Runs tests - Runs `yarn fmt`, `yarn lint` and `yarn test`.
- [./dev/vscode.sh](./dev/vscode.sh) (`yarn vscode`) - [./ci/dev/vscode.sh](./dev/vscode.sh) (`yarn vscode`)
- Ensures [../lib/vscode](../lib/vscode) is cloned, patched and dependencies are installed - Ensures [./lib/vscode](../lib/vscode) is cloned, patched and dependencies are installed.
- [./dev/patch-vscode.sh](./dev/patch-vscode.sh) (`yarn vscode:patch`) - [./ci/dev/patch-vscode.sh](./dev/patch-vscode.sh) (`yarn vscode:patch`)
- Applies [./dev/vscode.patch](./dev/vscode.patch) to [../lib/vscode](../lib/vscode) - Applies [./ci/dev/vscode.patch](./dev/vscode.patch) to [./lib/vscode](../lib/vscode).
- [./dev/diff-vscode.sh](./dev/diff-vscode.sh) (`yarn vscode:diff`) - [./ci/dev/diff-vscode.sh](./dev/diff-vscode.sh) (`yarn vscode:diff`)
- Diffs [../lib/vscode](../lib/vscode) into [./dev/vscode.patch](./dev/vscode.patch) - Diffs [./lib/vscode](../lib/vscode) into [./ci/dev/vscode.patch](./dev/vscode.patch).
- [./dev/vscode.patch](./dev/vscode.patch) - [./ci/dev/vscode.patch](./dev/vscode.patch)
- Our patch of VS Code to enable remote browser access - Our patch of VS Code, see [./doc/CONTRIBUTING.md](../doc/CONTRIBUTING.md#vs-code-patch).
- Generate it with `yarn vscode:diff` and apply with `yarn vscode:patch` - Generate it with `yarn vscode:diff` and apply with `yarn vscode:patch`.
- [./dev/watch.ts](./dev/watch.ts) (`yarn watch`) - [./ci/dev/watch.ts](./dev/watch.ts) (`yarn watch`)
- Starts a process to build and launch code-server and restart on any code changes - Starts a process to build and launch code-server and restart on any code changes.
- Example usage in [CONTRIBUTING.md](../doc/CONTRIBUTING.md) - Example usage in [./doc/CONTRIBUTING.md](../doc/CONTRIBUTING.md).
## build ## build
This directory contains the scripts used to build and release code-server. This directory contains the scripts used to build and release code-server.
You can disable minification by setting `MINIFY=`. You can disable minification by setting `MINIFY=`.
- [./lib.sh](./lib.sh) - [./ci/build/build-code-server.sh](./build/build-code-server.sh) (`yarn build`)
- Contains code duplicated across these scripts. - Builds code-server into `./out` and bundles the frontend into `./dist`.
- [./build/build-code-server.sh](./build/build-code-server.sh) (`yarn build`) - [./ci/build/build-vscode.sh](./build/build-vscode.sh) (`yarn build:vscode`)
- Builds code-server into ./out and bundles the frontend into ./dist. - Builds vscode into `./lib/vscode/out-vscode`.
- [./build/build-vscode.sh](./build/build-vscode.sh) (`yarn build:vscode`) - [./ci/build/build-release.sh](./build/build-release.sh) (`yarn release`)
- Builds vscode into ./lib/vscode/out-vscode.
- [./build/build-release.sh](./build/build-release.sh) (`yarn release`)
- Bundles the output of the above two scripts into a single node module at `./release`. - Bundles the output of the above two scripts into a single node module at `./release`.
- [./build/build-static-release.sh](./build/build-static-release.sh) (`yarn release:static`) - [./ci/build/build-static-release.sh](./build/build-static-release.sh) (`yarn release:static`)
- Requires a release already built in `./release`. - Requires a node module already built into `./release` with the above script.
- Will build a static release with node bundled into `./release-static` - Will build a static release with node and native modules bundled into `./release-static`.
- [./build/clean.sh](./build/clean.sh) (`yarn clean`) - [./ci/build/clean.sh](./build/clean.sh) (`yarn clean`)
- Removes all build artifacts - Removes all build artifacts.
- Will also `git reset --hard lib/vscode` - Will also `git reset --hard lib/vscode`.
- Useful to do a clean build - Useful to do a clean build.
- [./build/code-server.sh](./build/code-server.sh) - [./ci/build/code-server.sh](./build/code-server.sh)
- Copied into static releases to run code-server with the bundled node binary. - Copied into static releases to run code-server with the bundled node binary.
- [./build/test-static-release.sh](./build/test-static-release.sh) (`yarn test:static-release`) - [./ci/build/test-static-release.sh](./build/test-static-release.sh) (`yarn test:static-release`)
- Ensures code-server in the `./release-static` directory runs - Ensures code-server in the `./release-static` directory works by installing an extension.
- [./build/build-packages.sh](./build/build-packages.sh) (`yarn package`) - [./ci/build/build-packages.sh](./build/build-packages.sh) (`yarn package`)
- Packages `./release-static` into an archive in `./release-packages` - Packages `./release-static` into a `.tar.gz` archive in `./release-packages`.
- If on linux, [nfpm](https://github.com/goreleaser/nfpm) is used to generate .deb and .rpm - If on linux, [nfpm](https://github.com/goreleaser/nfpm) is used to generate `.deb` and `.rpm`.
- [./build/nfpm.yaml](./build/nfpm.yaml) - [./ci/build/nfpm.yaml](./build/nfpm.yaml)
- Used to configure [nfpm](https://github.com/goreleaser/nfpm) to generate .deb and .rpm - Used to configure [nfpm](https://github.com/goreleaser/nfpm) to generate `.deb` and `.rpm`.
- [./build/code-server-nfpm.sh](./build/code-server-nfpm.sh) - [./ci/build/code-server-nfpm.sh](./build/code-server-nfpm.sh)
- Entrypoint script for code-server for .deb and .rpm - Entrypoint script for code-server for `.deb` and .rpm`.
- [./build/code-server.service](./build/code-server.service) - [./ci/build/code-server.service](./build/code-server.service)
- systemd user service packaged into the debs and rpms - systemd user service packaged into the `.deb` and `.rpm`.
- [./build/release-github-draft.sh](./build/release-github-draft.sh) (`yarn release:github-draft`) - [./ci/build/release-github-draft.sh](./build/release-github-draft.sh) (`yarn release:github-draft`)
- Uses [hub](https://github.com/github/hub) to create a draft release with a template description - Uses [hub](https://github.com/github/hub) to create a draft release with a template description.
- [./build/release-github-assets.sh](./build/release-github-assets.sh) (`yarn release:github-assets`) - [./ci/build/release-github-assets.sh](./build/release-github-assets.sh) (`yarn release:github-assets`)
- Downloads the release-package artifacts for the current commit from CI - Downloads the release-package artifacts for the current commit from CI.
- Uses [hub](https://github.com/github/hub) to upload the artifacts to the release - Uses [hub](https://github.com/github/hub) to upload the artifacts to the release
specified in `package.json` specified in `package.json`.
- [./build/npm-postinstall.sh](./build/npm-postinstall.sh) - [./ci/build/npm-postinstall.sh](./build/npm-postinstall.sh)
- Post install script for the npm package - Post install script for the npm package.
- Bundled by`yarn release` - Bundled by`yarn release`.
## release-container ## release-container
This directory contains the release docker container. This directory contains the release docker container.
- [./release-container/build.sh](./release-container/build.sh) - [./release-container/build.sh](./release-container/build.sh)
- Builds the release container with the tag `codercom/code-server:$VERSION-$ARCH` - Builds the release container with the tag `codercom/code-server-$ARCH:$VERSION`.
- Assumes debian releases are ready in `./release-packages` - Assumes debian releases are ready in `./release-packages`.
## container ## container
@ -108,27 +110,26 @@ This directory contains the container for CI.
## steps ## steps
This directory contains a few scripts used in CI. This directory contains the scripts used in CI.
Just helps avoid clobbering the CI configuration. Helps avoid clobbering the CI configuration.
- [./steps/fmt.sh](./steps/fmt.sh) - [./steps/fmt.sh](./steps/fmt.sh)
- Runs `yarn fmt` after ensuring VS Code is patched - Runs `yarn fmt` after ensuring VS Code is patched.
- [./steps/lint.sh](./steps/lint.sh) - [./steps/lint.sh](./steps/lint.sh)
- Runs `yarn lint` after ensuring VS Code is patched - Runs `yarn lint` after ensuring VS Code is patched.
- [./steps/test.sh](./steps/test.sh) - [./steps/test.sh](./steps/test.sh)
- Runs `yarn test` after ensuring VS Code is patched - Runs `yarn test` after ensuring VS Code is patched.
- [./steps/release.sh](./steps/release.sh) - [./steps/release.sh](./steps/release.sh)
- Runs the full release process - Runs the release process.
- Generates the npm package at `./release` - Generates the npm package at `./release`.
- [./steps/static-release.sh](./steps/static-release.sh) - [./steps/release-static.sh](./steps/release-static.sh)
- Takes the output of the previous script and generates a static release and packages - Takes the output of the previous script and generates a self-contained release and
- [./steps/lib.sh](./steps/lib.sh) release packages into `release-packages`.
- Contains helpers to download artifacts from github actions workflow runs
- [./steps/publish-npm.sh](./steps/publish-npm.sh) - [./steps/publish-npm.sh](./steps/publish-npm.sh)
- Grabs the `npm-package` release artifact for the current commit and publishes it on NPM - Grabs the `npm-package` release artifact for the current commit and publishes it on npm.
- [./steps/build-docker-image.sh](./steps/build-docker-image.sh) - [./steps/build-docker-image.sh](./steps/build-docker-image.sh)
- Builds the docker image and then saves it into `./release-images/$ARCH.tar` - Builds the docker image and then saves it into `./release-images/code-server-$ARCH-$VERSION.tar`.
- [./steps/push-docker-manifest.sh](./steps/push-docker-manifest.sh) - [./steps/push-docker-manifest.sh](./steps/push-docker-manifest.sh)
- Loads all images in `./release-images` and then builds and pushes a multi architecture - Loads all images in `./release-images` and then builds and pushes a multi architecture
docker manifest for the amd64 and arm64 images to `codercom/code-server:$VERSION` and docker manifest for the amd64 and arm64 images to `codercom/code-server:$VERSION` and
`codercom/code-server:latest` `codercom/code-server:latest`.

1
ci/dev/diff-vscode.sh
View File

@ -5,6 +5,7 @@ main() {
cd "$(dirname "$0")/../.." cd "$(dirname "$0")/../.."
cd ./lib/vscode cd ./lib/vscode
git add -A
git diff HEAD > ../../ci/dev/vscode.patch git diff HEAD > ../../ci/dev/vscode.patch
} }

2
ci/steps/build-docker-image.sh
View File

@ -8,7 +8,7 @@ main() {
./ci/release-container/build.sh ./ci/release-container/build.sh
mkdir -p release-images mkdir -p release-images
docker save "codercom/code-server-$ARCH:$VERSION" > "release-images/code-server-$ARCH:$VERSION.tar" docker save "codercom/code-server-$ARCH:$VERSION" > "release-images/code-server-$ARCH-$VERSION.tar"
} }
main "$@" main "$@"

73
doc/CONTRIBUTING.md
View File

@ -1,7 +1,6 @@
# Contributing # Contributing
- [Detailed CI and build process docs](../ci) - [Detailed CI and build process docs](../ci)
- [Our VS Code Web docs](../src/node/app)
## Requirements ## Requirements
@ -9,15 +8,17 @@ Please refer to [VS Code's prerequisites](https://github.com/Microsoft/vscode/wi
Differences: Differences:
- We require at least node v12 but later versions should work - We require a minimum of node v12 but later versions should work.
- We use [fnpm](https://github.com/goreleaser/nfpm) to build .deb and .rpm packages - We use [fnpm](https://github.com/goreleaser/nfpm) to build `.deb` and `.rpm` packages.
- The [CI container](../ci/container/Dockerfile) is a useful reference for all our dependencies.
## Development Workflow ## Development Workflow
```shell ```shell
yarn yarn
yarn vscode yarn vscode
yarn watch # Visit http://localhost:8080 once completed. yarn watch
# Visit http://localhost:8080 once the build completed.
``` ```
To develop inside of an isolated docker container: To develop inside of an isolated docker container:
@ -35,9 +36,6 @@ Any changes made to the source will be live reloaded.
If changes are made to the patch and you've built previously you must manually If changes are made to the patch and you've built previously you must manually
reset VS Code then run `yarn vscode:patch`. reset VS Code then run `yarn vscode:patch`.
Some docs are available at [../src/node/app](../src/node/app) on how code-server
works internally.
## Build ## Build
```shell ```shell
@ -48,7 +46,8 @@ yarn build:vscode
yarn release yarn release
cd release cd release
yarn --production yarn --production
node . # Run the built JavaScript with Node. # Runs the built JavaScript with Node.
node .
``` ```
Now you can make it static and build packages with: Now you can make it static and build packages with:
@ -57,6 +56,62 @@ Now you can make it static and build packages with:
yarn release:static yarn release:static
yarn test:static-release yarn test:static-release
yarn package yarn package
# The static release is in ./release-static
# .deb, .rpm and the self-contained archive are in ./release-packages
``` ```
The static release will be in `./release-static` and .deb, .rpm and self-contained release in `./release-packages`. ## Structure
The `code-server` script serves an HTTP API to login and start a remote VS Code process.
The CLI code is in [./src/node](./src/node) and the HTTP routes are implemented in
[./src/node/app](./src/node/app).
Most of the meaty parts are in our VS Code patch which is described next.
### VS Code Patch
Back in v1 of code-server, we had an extensive patch of VS Code that split the codebase
into a frontend and server. The frontend consisted of all UI code and the server ran
the extensions and exposed an API to the frontend for file access and everything else
that the UI needed.
This worked but eventually Microsoft added support to VS Code to run it in the web.
They have open sourced the frontend but have kept the server closed source.
So in interest of piggy backing off their work, v2 and beyond use the VS Code
web frontend and fill in the server. This is contained in our
[./ci/dev/vscode.patch](../ci/dev/vscode.patch) under the path `src/vs/server`.
Other notable changes in our patch include:
- Add our own build file which includes our code and VS Code's web code.
- Allow multiple extension directories (both user and built-in).
- Modify the loader, websocket, webview, service worker, and asset requests to
use the URL of the page as a base (and TLS if necessary for the websocket).
- Send client-side telemetry through the server.
- Allow modification of the display language.
- Make it possible for us to load code on the client.
- Make extensions work in the browser.
- Make it possible to install extensions of any kind.
- Fix getting permanently disconnected when you sleep or hibernate for a while.
- Add connection type to web socket query parameters.
Some known issues presently:
- Creating custom VS Code extensions and debugging them doesn't work.
- Extension profiling and tips are currently disabled.
As the web portion of VS Code matures, we'll be able to shrink and maybe even entirely
eliminate our patch. In the meantime, however, upgrading the VS Code version requires
ensuring that the patch still applies and has the intended effects.
To generate a new patch run `yarn vscode:diff`.
**note**: We have extension docs on the CI and build system at [./ci/README.md](../ci/README.md)
If functionality doesn't depend on code from VS Code then it should be moved
into code-server otherwise it should be in the patch.
In the future we'd like to run VS Code unit tests against our builds to ensure features
work as expected.

3
doc/FAQ.md
View File

@ -54,6 +54,9 @@ See below for installing an extension from the cli.
Feel free to file an issue to add a missing extension to the marketplace. Feel free to file an issue to add a missing extension to the marketplace.
If you have your own custom marketplace, it is possible to point code-server to it by setting
`$SERVICE_URL` and `$ITEM_URL` to point to it.
## Where are extensions stored? ## Where are extensions stored?
Defaults to `~/.local/share/code-server/extensions`. Defaults to `~/.local/share/code-server/extensions`.

24
doc/assets/droplet.svg
View File

@ -1,24 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<svg width="200px" height="40px" viewBox="0 0 200 40" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
<!-- Generator: Sketch 52.5 (67469) - http://www.bohemiancoding.com/sketch -->
<title>do-btn-blue-ghost</title>
<desc>Created with Sketch.</desc>
<g id="Page-1" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd">
<g id="Partner-welcome-kit-Copy-3" transform="translate(-651.000000, -828.000000)">
<g id="do-btn-blue-ghost" transform="translate(651.000000, 828.000000)">
<rect id="Rectangle-Copy-4" stroke="#0069FF" x="0.5" y="0.5" width="199" height="39" rx="6"></rect>
<path d="M6,0 L47,0 L47,40 L6,40 C2.6862915,40 4.05812251e-16,37.3137085 0,34 L-8.8817842e-16,6 C-1.29399067e-15,2.6862915 2.6862915,6.08718376e-16 6,0 Z" id="Rectangle-Copy-5" fill="#0069FF"></path>
<g id="DO_Logo_horizontal_blue-Copy-3" transform="translate(13.000000, 10.000000)" fill="#FFFFFF">
<path d="M10.0098493,20 L10.0098493,16.1262429 C14.12457,16.1262429 17.2897398,12.0548452 15.7269372,7.74627862 C15.1334679,6.14538921 13.8674,4.86072487 12.2650328,4.28756693 C7.952489,2.72620566 3.87733294,5.88845634 3.87733294,9.99938223 C3.87733294,9.99938223 3.87733294,9.99938223 3.87733294,9.99938223 L0,9.99938223 C0,3.45747613 6.3303395,-1.64165309 13.1948014,0.492866119 C16.2017127,1.42177726 18.57559,3.81322933 19.5053586,6.79760341 C21.6418482,13.6754986 16.5577943,20 10.0098493,20 Z" id="XMLID_49_"></path>
<polygon id="XMLID_47_" points="9.52380952 16.1904762 5.71428571 16.1904762 5.71428571 12.3809524 5.71428571 12.3809524 9.52380952 12.3809524 9.52380952 12.3809524"></polygon>
<polygon id="XMLID_46_" points="6.66666667 19.047619 3.80952381 19.047619 3.80952381 19.047619 3.80952381 16.1904762 6.66666667 16.1904762"></polygon>
<polygon id="XMLID_45_" points="3.80952381 16.1904762 0.952380952 16.1904762 0.952380952 16.1904762 0.952380952 13.3333333 0.952380952 13.3333333 3.80952381 13.3333333 3.80952381 13.3333333"></polygon>
</g>
<!-- Modified to add GitHub font-family after DigitalOcean's font-family, otherwise it looks bad on GitHub -->
<text id="Create-a-Droplet-Copy-3" font-family="Sailec-Medium, Sailec, -apple-system, BlinkMacSystemFont, Segoe UI, Helvetica, Arial, sans-serif, Apple Color Emoji, Segoe UI Emoji, Segoe UI Symbol" font-size="16" font-weight="400" fill="#0069FF">
<tspan x="58" y="26">Create a Droplet</tspan>
</text>
</g>
</g>
</g>
</svg>
Side by Side

Before

Width:  |  Height:  |  Size: 2.7 KiB

63
src/node/app/README.md
View File

@ -1,63 +0,0 @@
# app
Implementation of [VS Code](https://code.visualstudio.com/) remote/web for use
in `code-server`.
## Docker
To debug Golang in VS Code using the
[ms-vscode-go extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode.Go),
you need to add `--security-opt seccomp=unconfined` to your `docker run`
arguments when launching code-server with Docker. See
[#725](https://github.com/cdr/code-server/issues/725) for details.
## Known Issues
- Creating custom VS Code extensions and debugging them doesn't work.
- Extension profiling and tips are currently disabled.
## Extensions
`code-server` does not provide access to the official
[Visual Studio Marketplace](https://marketplace.visualstudio.com/vscode). Instead,
Coder has created a custom extension marketplace that we manage for open-source
extensions. If you want to use an extension with code-server that we do not have
in our marketplace please look for a release in the extension’s repository,
contact us to see if we have one in the works or, if you build an extension
locally from open source, you can copy it to the `extensions` folder. If you
build one locally from open-source please contribute it to the project and let
us know so we can give you props! If you have your own custom marketplace, it is
possible to point code-server to it by setting the `SERVICE_URL` and `ITEM_URL`
environment variables.
## Development: upgrading VS Code
We patch VS Code to provide and fix some functionality. As the web portion of VS
Code matures, we'll be able to shrink and maybe even entirely eliminate our
patch. In the meantime, however, upgrading the VS Code version requires ensuring
that the patch still applies and has the intended effects.
If functionality doesn't depend on code from VS Code then it should be moved
into code-server otherwise it should be in the patch.
To generate a new patch, **stage all the changes** you want to be included in
the patch in the VS Code source, then run `yarn vscode:diff` in this
directory.
Notable changes include:
- Add our own build file which includes our code and VS Code's web code.
- Allow multiple extension directories (both user and built-in).
- Modify the loader, websocket, webview, service worker, and asset requests to
use the URL of the page as a base (and TLS if necessary for the websocket).
- Send client-side telemetry through the server.
- Make changing the display language work.
- Make it possible for us to load code on the client.
- Make extensions work in the browser.
- Make it possible to install extensions of any kind.
- Fix getting permanently disconnected when you sleep or hibernate for a while.
- Add connection type to web socket query parameters.
## Future
- Run VS Code unit tests against our builds to ensure features work as expected.