Skip to content

Commit 2f153b5

Browse files
committedAug 14, 2024
basic changes for build
1 parent f1e16e1 commit 2f153b5

File tree

5 files changed

+1113
-77
lines changed

5 files changed

+1113
-77
lines changed
 

‎README.md

Lines changed: 89 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,64 @@
1-
# Visual Studio Code - Open Source ("Code - OSS")
1+
# OpenVSCode Web Server
22

3-
[![Feature Requests](https://img.shields.io/github/issues/microsoft/vscode/feature-request.svg)](https://github.com/microsoft/vscode/issues?q=is%3Aopen+is%3Aissue+label%3Afeature-request+sort%3Areactions-%2B1-desc)
4-
[![Bugs](https://img.shields.io/github/issues/microsoft/vscode/bug.svg)](https://github.com/microsoft/vscode/issues?utf8=✓&q=is%3Aissue+is%3Aopen+label%3Abug)
5-
[![Gitter](https://img.shields.io/badge/chat-on%20gitter-yellow.svg)](https://gitter.im/Microsoft/vscode)
3+
[![GitHub](https://img.shields.io/github/license/runcode-io/openvscode-web-server)](https://github.com/runcode-io/openvscode-web-server/blob/main/LICENSE.txt)
64

7-
## The Repository
5+
## What is this?
86

9-
This repository ("`Code - OSS`") is where we (Microsoft) develop the [Visual Studio Code](https://code.visualstudio.com) product together with the community. Not only do we work on code and issues here, we also publish our [roadmap](https://github.com/microsoft/vscode/wiki/Roadmap), [monthly iteration plans](https://github.com/microsoft/vscode/wiki/Iteration-Plans), and our [endgame plans](https://github.com/microsoft/vscode/wiki/Running-the-Endgame). This source code is available to everyone under the standard [MIT license](https://github.com/microsoft/vscode/blob/main/LICENSE.txt).
7+
This project provides a version of VS Code that runs as a server on a remote machine, accessible through a modern web browser. It utilizes the same architecture used by [RunCode](https://runcode.io) to deliver scalable remote development environments.
108

11-
## Visual Studio Code
9+
## Why?
1210

13-
<p align="center">
14-
<img alt="VS Code in action" src="https://user-images.githubusercontent.com/35271042/118224532-3842c400-b438-11eb-923d-a5f66fa6785a.png">
15-
</p>
11+
VS Code was originally developed as a desktop IDE using web technologies. As remote development gained popularity, the community began adapting it for remote access via web browsers. However, these adaptations were often complex and error-prone due to the extensive changes required across VS Code's large codebase.
1612

17-
[Visual Studio Code](https://code.visualstudio.com) is a distribution of the `Code - OSS` repository with Microsoft-specific customizations released under a traditional [Microsoft product license](https://code.visualstudio.com/License/).
13+
In 2019, the VS Code team began restructuring its architecture to natively support a browser-based environment. While platforms like Gitpod and GitHub adopted this architecture, the key components remained closed-source until recently. Consequently, many developers continued to use the older, more difficult methods.
1814

19-
[Visual Studio Code](https://code.visualstudio.com) combines the simplicity of a code editor with what developers need for their core edit-build-debug cycle. It provides comprehensive code editing, navigation, and understanding support along with lightweight debugging, a rich extensibility model, and lightweight integration with existing tools.
15+
At RunCode, we've frequently been asked about our approach. To support the community, we're sharing the minimal set of changes required to utilize the latest version of VS Code, ensuring easier upgrades and reduced maintenance.
2016

21-
Visual Studio Code is updated monthly with new features and bug fixes. You can download it for Windows, macOS, and Linux on [Visual Studio Code's website](https://code.visualstudio.com/Download). To get the latest releases every day, install the [Insiders build](https://code.visualstudio.com/insiders).
17+
## Getting started
2218

23-
## Contributing
19+
### Docker
2420

25-
There are many ways in which you can participate in this project, for example:
21+
- Start the server:
22+
```bash
23+
docker run -it --init -p 8000:8000 -v "$(pwd):/home/runcode/workspace:cached" runcode/runcode-server
24+
```
25+
- Visit the URL printed in your terminal.
2626

27-
* [Submit bugs and feature requests](https://github.com/microsoft/vscode/issues), and help us verify as they are checked in
28-
* Review [source code changes](https://github.com/microsoft/vscode/pulls)
29-
* Review the [documentation](https://github.com/microsoft/vscode-docs) and make pull requests for anything from typos to additional and new content
3027

31-
If you are interested in fixing issues and contributing directly to the code base,
32-
please see the document [How to Contribute](https://github.com/microsoft/vscode/wiki/How-to-Contribute), which covers the following:
3328

34-
* [How to build and run from source](https://github.com/microsoft/vscode/wiki/How-to-Contribute)
35-
* [The development workflow, including debugging and running tests](https://github.com/microsoft/vscode/wiki/How-to-Contribute#debugging)
36-
* [Coding guidelines](https://github.com/microsoft/vscode/wiki/Coding-Guidelines)
37-
* [Submitting pull requests](https://github.com/microsoft/vscode/wiki/How-to-Contribute#pull-requests)
38-
* [Finding an issue to work on](https://github.com/microsoft/vscode/wiki/How-to-Contribute#where-to-contribute)
39-
* [Contributing to translations](https://aka.ms/vscodeloc)
29+
#### Custom Environment
30+
- For additional possibilities, please consult the `Dockerfile` for OpenVSCode Web Server at https://github.com/runcode-io/runcode-releases/
4031

41-
## Feedback
4232

43-
* Ask a question on [Stack Overflow](https://stackoverflow.com/questions/tagged/vscode)
44-
* [Request a new feature](CONTRIBUTING.md)
45-
* Upvote [popular feature requests](https://github.com/microsoft/vscode/issues?q=is%3Aopen+is%3Aissue+label%3Afeature-request+sort%3Areactions-%2B1-desc)
46-
* [File an issue](https://github.com/microsoft/vscode/issues)
47-
* Connect with the extension author community on [GitHub Discussions](https://github.com/microsoft/vscode-discussions/discussions) or [Slack](https://aka.ms/vscode-dev-community)
48-
* Follow [@code](https://twitter.com/code) and let us know what you think!
33+
### Web Server
4934

50-
See our [wiki](https://github.com/microsoft/vscode/wiki/Feedback-Channels) for a description of each of these channels and information on some other available community-driven channels.
35+
- [Download the latest release](https://github.com/runcode-io/openvscode-web-server/releases/latest)
36+
- Untar and run the server
37+
```bash
38+
unzip openvscode-web-server-v${OPENVSCODE_SERVER_VERSION}.zip
39+
cd vscode-reh-web-linux-x64
40+
./bin/runcode-server # you can add arguments here, use --help to list all of the possible options
41+
```
5142

52-
## Related Projects
43+
From the possible entrypoint arguments, the most notable ones are
44+
- `--port` - the port number to start the server on, this is 8000 by default
45+
- `--without-connection-token` - used by default in the docker image
46+
- `--connection-token` & `--connection-token-file` for securing access to the IDE, you can read more about it in [Securing access to your IDE](#securing-access-to-your-ide).
47+
- `--host` - determines the host the server is listening on. It defaults to `localhost`, so for accessing remotely it's a good idea to add `--host 0.0.0.0` to your launch arguments.
5348

54-
Many of the core components and extensions to VS Code live in their own repositories on GitHub. For example, the [node debug adapter](https://github.com/microsoft/vscode-node-debug) and the [mono debug adapter](https://github.com/microsoft/vscode-mono-debug) repositories are separate from each other. For a complete list, please visit the [Related Projects](https://github.com/microsoft/vscode/wiki/Related-Projects) page on our [wiki](https://github.com/microsoft/vscode/wiki).
49+
- Visit the URL printed in your terminal.
50+
51+
### Securing access to your IDE
52+
53+
You can access the Web UI without authentication (anyone can access the IDE using just the hostname and port), if you need some kind of basic authentication then you can start the server with `--connection-token YOUR_TOKEN`, the provided `YOUR_TOKEN` will be used and the authenticated URL will be displayed in your terminal once you start the server. You can also create a plaintext file with the desired token as its contents and provide it to the server with `--connection-token-file YOUR_SECRET_TOKEN_FILE`.
54+
55+
If you want to use a connection token and are working with OpenVSCode Web Server via [the Docker image](https://hub.docker.com/r/runcode/runcode-server), you will have to edit the `ENTRYPOINT` in [the Dockerfile](https://github.com/runcode-io/runcode-releases/blob/main/Dockerfile) or modify it with the [`entrypoint` option](https://docs.docker.com/compose/compose-file/compose-file-v3/#entrypoint) when working with `docker-compose`.
56+
57+
## The scope of this project
58+
59+
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.
60+
61+
> **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)**
5562
5663
## Bundled Extensions
5764

@@ -61,19 +68,56 @@ VS Code includes a set of built-in extensions located in the [extensions](extens
6168

6269
This repository includes a Visual Studio Code Dev Containers / GitHub Codespaces development container.
6370

64-
* For [Dev Containers](https://aka.ms/vscode-remote/download/containers), use the **Dev Containers: Clone Repository in Container Volume...** command which creates a Docker volume for better disk I/O on macOS and Windows.
65-
* If you already have VS Code and Docker installed, you can also click [here](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/microsoft/vscode) to get started. This will cause VS Code to automatically install the Dev Containers extension if needed, clone the source code into a container volume, and spin up a dev container for use.
66-
67-
* For Codespaces, install the [GitHub Codespaces](https://marketplace.visualstudio.com/items?itemName=GitHub.codespaces) extension in VS Code, and use the **Codespaces: Create New Codespace** command.
71+
- For [Dev Containers](https://aka.ms/vscode-remote/download/containers), use the **Dev Containers: Clone Repository in Container Volume...** command which creates a Docker volume for better disk I/O on macOS and Windows.
72+
- If you already have VS Code and Docker installed, you can also click [here](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/microsoft/vscode) to get started. This will cause VS Code to automatically install the Dev Containers extension if needed, clone the source code into a container volume, and spin up a dev container for use.
73+
- For Codespaces, install the [GitHub Codespaces](https://marketplace.visualstudio.com/items?itemName=GitHub.codespaces) extension in VS Code, and use the **Codespaces: Create New Codespace** command.
6874

6975
Docker / the Codespace should have at least **4 Cores and 6 GB of RAM (8 GB recommended)** to run full build. See the [development container README](.devcontainer/README.md) for more information.
7076

71-
## Code of Conduct
77+
## Legal
78+
This project is not affiliated with Microsoft Corporation.
79+
80+
81+
82+
83+
84+
85+
86+
87+
88+
89+
90+
91+
92+
93+
94+
docker run -it --network=host -v "$(pwd):/home/" ubuntu:22.04
95+
96+
97+
apt update && apt install sudo git wget build-essential
98+
99+
sudo apt update && sudo apt upgrade -y
100+
sudo apt-get install -y libkrb5-dev libx11-dev libxkbfile-dev pkg-config libsecret-1-dev
101+
102+
wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.0/install.sh | bash
103+
104+
source /root/.bashrc
105+
106+
nvm install 20.14.0
107+
108+
corepack enable
109+
110+
git config --global --add safe.directory /home
111+
112+
113+
72114

73-
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
115+
docker run -itd -p 8000:8000 -v "$(pwd):/home" ubuntu:22.04
116+
apt update && apt upgrade -y && apt install unzip sudo -y
74117

75-
## License
118+
./vscode-reh-web-linux-x64/bin/runcode-server --default-folder=/home/ --host=0.0.0.0
76119

77-
Copyright (c) Microsoft Corporation. All rights reserved.
78120

79-
Licensed under the [MIT](LICENSE.txt) license.
121+
apt-get update && apt-get install -y software-properties-common
122+
add-apt-repository ppa:ubuntu-toolchain-r/test
123+
apt-get update && apt-get install -y libstdc++6

‎build/hygiene.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,10 @@ function hygiene(some, linting = true) {
3030
const productJson = es.through(function (file) {
3131
const product = JSON.parse(file.contents.toString('utf8'));
3232

33-
if (product.extensionsGallery) {
34-
console.error(`product.json: Contains 'extensionsGallery'`);
35-
errorCount++;
36-
}
33+
// if (product.extensionsGallery) {
34+
// console.error(`product.json: Contains 'extensionsGallery'`);
35+
// errorCount++;
36+
// }
3737

3838
this.emit('data', file);
3939
});

‎build/lib/compilation.ts

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,9 @@ import { Mangler } from './mangle/index';
2121
import { RawSourceMap } from 'source-map';
2222
import { gulpPostcss } from './postcss';
2323
const watch = require('./watch');
24-
24+
const packageJson = require('../../package.json');
25+
const productJson = require('../../product.json');
26+
const replace = require('gulp-replace');
2527

2628
// --- gulp-tsb: compile and transpile --------------------------------
2729

@@ -70,8 +72,20 @@ function createCompile(src: string, build: boolean, emitError: boolean, transpil
7072

7173
const postcssNesting = require('postcss-nesting');
7274

75+
const productJsFilter = util.filter(data => !build && data.path.endsWith('vs/platform/product/common/product.ts'));
76+
const productConfiguration = JSON.stringify({
77+
...productJson,
78+
version: `${packageJson.version}-dev`,
79+
nameShort: `${productJson.nameShort} Dev`,
80+
nameLong: `${productJson.nameLong} Dev`,
81+
dataFolderName: `${productJson.dataFolderName}-dev`
82+
});
83+
7384
const input = es.through();
7485
const output = input
86+
.pipe(productJsFilter)
87+
.pipe(replace(/{\s*\/\*BUILD->INSERT_PRODUCT_CONFIGURATION\*\/\s*}/, productConfiguration, { skipBinary: true }))
88+
.pipe(productJsFilter.restore)
7589
.pipe(util.$if(isUtf8Test, bom())) // this is required to preserve BOM in test files that loose it otherwise
7690
.pipe(util.$if(!build && isRuntimeJs, util.appendOwnPathSourceURL()))
7791
.pipe(util.$if(isCSS, gulpPostcss([postcssNesting()], err => reporter(String(err)))))

‎product.json

Lines changed: 1003 additions & 26 deletions
Large diffs are not rendered by default.

‎src/vs/workbench/services/extensions/common/extensionsProposedApi.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,8 @@ export class ExtensionsProposedApi {
3131

3232
this._envEnabledExtensions = new Set((_environmentService.extensionEnabledProposedApi ?? []).map(id => ExtensionIdentifier.toKey(id)));
3333

34-
this._envEnablesProposedApiForAll =
34+
// this._envEnablesProposedApiForAll =
35+
this._envEnablesProposedApiForAll = true || // always enable proposed API
3536
!_environmentService.isBuilt || // always allow proposed API when running out of sources
3637
(_environmentService.isExtensionDevelopment && productService.quality !== 'stable') || // do not allow proposed API against stable builds when developing an extension
3738
(this._envEnabledExtensions.size === 0 && Array.isArray(_environmentService.extensionEnabledProposedApi)); // always allow proposed API if --enable-proposed-api is provided without extension ID

0 commit comments

Comments
 (0)
Please sign in to comment.